ClutterActor

ClutterActor — Base abstract class for all visual stage actors.

Synopsis




#define             CLUTTER_ACTOR_SET_FLAGS             (e,f)
#define             CLUTTER_ACTOR_UNSET_FLAGS           (e,f)
#define             CLUTTER_ACTOR_IS_MAPPED             (e)
#define             CLUTTER_ACTOR_IS_REALIZED           (e)
#define             CLUTTER_ACTOR_IS_VISIBLE            (e)
                    ClutterActorBox;
enum                ClutterActorFlags;
                    ClutterGeometry;
#define             CLUTTER_CALLBACK                    (f)
void                (*ClutterCallback)                  (ClutterActor *actor,
                                                         gpointer data);
                    ClutterActor;
                    ClutterActorClass;
void                clutter_actor_show                  (ClutterActor *self);
void                clutter_actor_show_all              (ClutterActor *self);
void                clutter_actor_hide                  (ClutterActor *self);
void                clutter_actor_hide_all              (ClutterActor *self);
void                clutter_actor_realize               (ClutterActor *self);
void                clutter_actor_unrealize             (ClutterActor *self);
void                clutter_actor_paint                 (ClutterActor *self);
void                clutter_actor_queue_redraw          (ClutterActor *self);
void                clutter_actor_destroy               (ClutterActor *self);
void                clutter_actor_request_coords        (ClutterActor *self,
                                                         ClutterActorBox *box);
void                clutter_actor_query_coords          (ClutterActor *self,
                                                         ClutterActorBox *box);
void                clutter_actor_set_geometry          (ClutterActor *self,
                                                         const ClutterGeometry *geometry);
void                clutter_actor_get_geometry          (ClutterActor *self,
                                                         ClutterGeometry *geometry);
void                clutter_actor_get_coords            (ClutterActor *self,
                                                         gint *x_1,
                                                         gint *y_1,
                                                         gint *x_2,
                                                         gint *y_2);
void                clutter_actor_set_size              (ClutterActor *self,
                                                         gint width,
                                                         gint height);
void                clutter_actor_get_size              (ClutterActor *self,
                                                         guint *width,
                                                         guint *height);
void                clutter_actor_set_position          (ClutterActor *self,
                                                         gint x,
                                                         gint y);
void                clutter_actor_get_abs_position      (ClutterActor *self,
                                                         gint *x,
                                                         gint *y);
void                clutter_actor_set_width             (ClutterActor *self,
                                                         guint width);
guint               clutter_actor_get_width             (ClutterActor *self);
void                clutter_actor_set_height            (ClutterActor *self,
                                                         guint height);
guint               clutter_actor_get_height            (ClutterActor *self);
gint                clutter_actor_get_x                 (ClutterActor *self);
gint                clutter_actor_get_y                 (ClutterActor *self);
void                clutter_actor_move_by               (ClutterActor *self,
                                                         gint dx,
                                                         gint dy);
void                clutter_actor_rotate_x              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint y,
                                                         gint z);
void                clutter_actor_rotate_y              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint x,
                                                         gint z);
void                clutter_actor_rotate_z              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint x,
                                                         gint y);
void                clutter_actor_set_opacity           (ClutterActor *self,
                                                         guint8 opacity);
guint8              clutter_actor_get_opacity           (ClutterActor *self);
void                clutter_actor_set_name              (ClutterActor *self,
                                                         const gchar *name);
const gchar*        clutter_actor_get_name              (ClutterActor *self);
guint32             clutter_actor_get_id                (ClutterActor *self);
void                clutter_actor_set_clip              (ClutterActor *self,
                                                         gint xoff,
                                                         gint yoff,
                                                         gint width,
                                                         gint height);
void                clutter_actor_remove_clip           (ClutterActor *self);
gboolean            clutter_actor_has_clip              (ClutterActor *self);
void                clutter_actor_set_parent            (ClutterActor *self,
                                                         ClutterActor *parent);
ClutterActor*       clutter_actor_get_parent            (ClutterActor *self);
void                clutter_actor_reparent              (ClutterActor *self,
                                                         ClutterActor *new_parent);
void                clutter_actor_unparent              (ClutterActor *self);
void                clutter_actor_raise                 (ClutterActor *self,
                                                         ClutterActor *below);
void                clutter_actor_lower                 (ClutterActor *self,
                                                         ClutterActor *above);
void                clutter_actor_raise_top             (ClutterActor *self);
void                clutter_actor_lower_bottom          (ClutterActor *self);
void                clutter_actor_set_depth             (ClutterActor *self,
                                                         gint depth);
gint                clutter_actor_get_depth             (ClutterActor *self);
void                clutter_actor_set_scalex            (ClutterActor *self,
                                                         ClutterFixed scale_x,
                                                         ClutterFixed scale_y);
void                clutter_actor_set_scale             (ClutterActor *self,
                                                         gdouble scale_x,
                                                         gdouble scale_y);
void                clutter_actor_get_scalex            (ClutterActor *self,
                                                         ClutterFixed *scale_x,
                                                         ClutterFixed *scale_y);
void                clutter_actor_get_scale             (ClutterActor *self,
                                                         gdouble *scale_x,
                                                         gdouble *scale_y);
void                clutter_actor_get_abs_size          (ClutterActor *self,
                                                         guint *width,
                                                         guint *height);
void                clutter_actor_apply_transform_to_point
                                                        (ClutterActor *self,
                                                         ClutterVertex *point,
                                                         ClutterVertex *vertex);
gdouble             clutter_actor_get_rxang             (ClutterActor *self);
gdouble             clutter_actor_get_ryang             (ClutterActor *self);
gdouble             clutter_actor_get_rzang             (ClutterActor *self);
ClutterFixed        clutter_actor_get_rxangx            (ClutterActor *self);
ClutterFixed        clutter_actor_get_ryangx            (ClutterActor *self);
ClutterFixed        clutter_actor_get_rzangx            (ClutterActor *self);
                    ClutterVertex;
void                clutter_actor_get_vertices          (ClutterActor *self,
                                                         ClutterVertex verts[4]);
void                clutter_actor_pick                  (ClutterActor *self,
                                                         const ClutterColor *color);
void                clutter_actor_rotate_xx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint y,
                                                         gint z);
void                clutter_actor_rotate_yx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint x,
                                                         gint z);
void                clutter_actor_rotate_zx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint x,
                                                         gint y);
void                clutter_actor_set_scale_with_gravity
                                                        (ClutterActor *self,
                                                         gfloat scale_x,
                                                         gfloat scale_y,
                                                         ClutterGravity gravity);
void                clutter_actor_set_scale_with_gravityx
                                                        (ClutterActor *self,
                                                         ClutterFixed scale_x,
                                                         ClutterFixed scale_y,
                                                         ClutterGravity gravity);


Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----ClutterActor

Properties


  "clip"                     ClutterGeometry       : Read / Write
  "has-clip"                 gboolean              : Read
  "height"                   gint                  : Read / Write
  "name"                     gchararray            : Read / Write
  "opacity"                  guchar                : Read / Write / Construct
  "visible"                  gboolean              : Read / Write
  "width"                    gint                  : Read / Write
  "x"                        gint                  : Read / Write
  "y"                        gint                  : Read / Write

Signals


  "destroy"                                        : Cleanup / No Recursion / No Hooks
  "hide"                                           : Run First
  "parent-set"                                     : Run Last
  "show"                                           : Run First

Description

ClutterActor is a base abstract class for all visual elements on the stage. Every object that must appear on the main ClutterStage must also be a ClutterActor, either by using one of the classes provided by Clutter, or by implementing a new ClutterActor subclass.

Details

CLUTTER_ACTOR_SET_FLAGS()

#define CLUTTER_ACTOR_SET_FLAGS(e,f)    ((e)->flags |= (f))  

e :
f :

CLUTTER_ACTOR_UNSET_FLAGS()

#define CLUTTER_ACTOR_UNSET_FLAGS(e,f)  ((e)->flags &= ~(f))  

e :
f :

CLUTTER_ACTOR_IS_MAPPED()

#define CLUTTER_ACTOR_IS_MAPPED(e)      ((e)->flags & CLUTTER_ACTOR_MAPPED)  

e :

CLUTTER_ACTOR_IS_REALIZED()

#define CLUTTER_ACTOR_IS_REALIZED(e)    ((e)->flags & CLUTTER_ACTOR_REALIZED)

e :

CLUTTER_ACTOR_IS_VISIBLE()

#define             CLUTTER_ACTOR_IS_VISIBLE(e)

e :

ClutterActorBox

typedef struct {
  ClutterUnit x1;
  ClutterUnit y1;
  ClutterUnit x2;
  ClutterUnit y2;
} ClutterActorBox;

Bounding box of an actor. The coordinates of the top left and right bottom corners of an actor. The coordinates of the two points are expressed in ClutterUnits, that is are device-independent. If you want to obtain the box dimensions in pixels, use clutter_actor_get_geometry().

ClutterUnit x1; X coordinate of the top left corner
ClutterUnit y1; Y coordinate of the top left corner
ClutterUnit x2; X coordinate of the bottom right corner
ClutterUnit y2; Y coordinate of the bottom right corner

enum ClutterActorFlags

typedef enum
{
  CLUTTER_ACTOR_MAPPED   = 1 << 1,
  CLUTTER_ACTOR_REALIZED = 1 << 2
} ClutterActorFlags;

Flags used to signal the state of an actor.

CLUTTER_ACTOR_MAPPED the actor has been painted
CLUTTER_ACTOR_REALIZED the resources associated to the actor have been allocated

ClutterGeometry

typedef struct {
  gint   x;
  gint   y;
  guint  width;
  guint  height;
} ClutterGeometry;

Rectangle containing an actor.

gint x; X coordinate of the top left corner of an actor
gint y; Y coordinate of the top left corner of an actor
guint width; width of an actor
guint height; height of an actor

CLUTTER_CALLBACK()

#define CLUTTER_CALLBACK(f)	((ClutterCallback) (f))

f :

ClutterCallback ()

void                (*ClutterCallback)                  (ClutterActor *actor,
                                                         gpointer data);

Generic callback

actor : a ClutterActor
data : user data

ClutterActor

typedef struct {
  guint32 flags;
} ClutterActor;

Base class for actors.

guint32 flags; ClutterActorFlags

ClutterActorClass

typedef struct {
  void (* show)            (ClutterActor        *actor);
  void (* show_all)        (ClutterActor        *actor);
  void (* hide)            (ClutterActor        *actor);
  void (* hide_all)        (ClutterActor        *actor);
  void (* realize)         (ClutterActor        *actor);
  void (* unrealize)       (ClutterActor        *actor);
  void (* paint)           (ClutterActor        *actor);
  void (* request_coords)  (ClutterActor        *actor,
			    ClutterActorBox     *box);
  void (* query_coords)    (ClutterActor        *actor,
			    ClutterActorBox     *box);
  void (* set_depth)       (ClutterActor        *actor,
		            gint                 depth);
  gint (* get_depth)       (ClutterActor        *actor);
  void (* parent_set)      (ClutterActor        *actor,
                            ClutterActor        *old_parent);

  void (* destroy)         (ClutterActor        *actor);
  void (* pick)            (ClutterActor        *actor,
                            const ClutterColor  *color);
} ClutterActorClass;

Base class for actors.

show () signal class handler for the ClutterActor::show signal
show_all () virtual function for containers and composite actors, to determine which children should be shown when calling clutter_actor_show_all() on the actor. Defaults to calling clutter_actor_show().
hide () signal class handler for the ClutterActor::hide signal
hide_all () virtual function for containers and composite actors, to determine which children should be shown when calling clutter_actor_hide_all() on the actor. Defaults to calling clutter_actor_show().
realize () virtual function, used to allocate resources for the actor; it should chain up to the parent's implementation
unrealize () virtual function, used to deallocate resources allocated in ::realized; it should chain up to the parent's implementation
paint () virtual function, used to paint the actor
request_coords () virtual function, used when setting the coordinates of an actor
query_coords () virtual function, used when querying the actor for its coordinates
set_depth () virtual function, used when setting the depth
get_depth () virtual function, used when getting the depth
parent_set () signal class closure for the ClutterActor::parent-set signal
destroy () signal class closure for the ClutterActor::destroy signal
pick () virtual functions, used to draw an outline of the actor

clutter_actor_show ()

void                clutter_actor_show                  (ClutterActor *self);

Flags a clutter actor to be displayed. An actor not shown will not appear on the display.

self : A ClutterActor

clutter_actor_show_all ()

void                clutter_actor_show_all              (ClutterActor *self);

Call show() on all children of a actor (if any).

self : a ClutterActor

Since 0.2


clutter_actor_hide ()

void                clutter_actor_hide                  (ClutterActor *self);

Flags a clutter actor to be hidden. An actor not shown will not appear on the display.

self : A ClutterActor

clutter_actor_hide_all ()

void                clutter_actor_hide_all              (ClutterActor *self);

Call hide() on all child actors (if any).

self : a ClutterActor

Since 0.2


clutter_actor_realize ()

void                clutter_actor_realize               (ClutterActor *self);

Creates any underlying graphics resources needed by the actor to be displayed.

self : A ClutterActor

clutter_actor_unrealize ()

void                clutter_actor_unrealize             (ClutterActor *self);

Frees up any underlying graphics resources needed by the actor to be displayed.

self : A ClutterActor

clutter_actor_paint ()

void                clutter_actor_paint                 (ClutterActor *self);

Renders the actor to display.

This function should not be called directly by applications instead clutter_actor_queue_redraw should be used to queue paints.

self : A ClutterActor

clutter_actor_queue_redraw ()

void                clutter_actor_queue_redraw          (ClutterActor *self);

Queues up a redraw of an actor and any children. The redraw occurs once the main loop becomes idle (after the current batch of events has been processed, roughly).

Applications rarely need to call this as redraws are handled automatically by modification functions.

self : A ClutterActor

clutter_actor_destroy ()

void                clutter_actor_destroy               (ClutterActor *self);

Destroys an actor. When an actor is destroyed, it will break any references it holds to other objects. If the actor is inside a group, the actor will be removed from the group.

When you destroy a group its children will be destroyed as well.

self : a ClutterActor

clutter_actor_request_coords ()

void                clutter_actor_request_coords        (ClutterActor *self,
                                                         ClutterActorBox *box);

Requests new untransformed co-ordinates for the ClutterActor ralative to any parent.

This function should not be called directly by applications instead the various position/geometry methods should be used.

self : A ClutterActor
box : A ClutterActorBox with requested new co-ordinates in ClutterUnits

clutter_actor_query_coords ()

void                clutter_actor_query_coords          (ClutterActor *self,
                                                         ClutterActorBox *box);

Requests the untransformed co-ordinates (in ClutterUnits) for the ClutterActor relative to any parent.

This function should not be called directly by applications instead the various position/geometry methods should be used.

self : A ClutterActor
box : A location to store the actors ClutterActorBox co-ordinates

clutter_actor_set_geometry ()

void                clutter_actor_set_geometry          (ClutterActor *self,
                                                         const ClutterGeometry *geometry);

Sets the actors untransformed geometry in pixels relative to any parent actor.

self : A ClutterActor
geometry : A ClutterGeometry

clutter_actor_get_geometry ()

void                clutter_actor_get_geometry          (ClutterActor *self,
                                                         ClutterGeometry *geometry);

Gets the actors untransformed geometry in pixels relative to any parent actor.

self : A ClutterActor
geometry : A location to store actors ClutterGeometry

clutter_actor_get_coords ()

void                clutter_actor_get_coords            (ClutterActor *self,
                                                         gint *x_1,
                                                         gint *y_1,
                                                         gint *x_2,
                                                         gint *y_2);

Gets the actors untransformed bounding rectangle co-ordinates in pixels relative to any parent actor.

self : A ClutterActor
x_1 : A location to store actors left position, or NULL.
y_1 : A location to store actors top position, or NULL.
x_2 : A location to store actors right position, or NULL.
y_2 : A location to store actors bottom position, or NULL.

clutter_actor_set_size ()

void                clutter_actor_set_size              (ClutterActor *self,
                                                         gint width,
                                                         gint height);

Sets the actors size in pixels.

self : A ClutterActor
width : New width of actor in pixels
height : New height of actor in pixels

clutter_actor_get_size ()

void                clutter_actor_get_size              (ClutterActor *self,
                                                         guint *width,
                                                         guint *height);

Gets the size of an actor in pixels ignoring any scaling factors.

self : A ClutterActor
width : Location to store width if non NULL.
height : Location to store height if non NULL.

Since 0.2


clutter_actor_set_position ()

void                clutter_actor_set_position          (ClutterActor *self,
                                                         gint x,
                                                         gint y);

Sets the actors position in pixels relative to any parent actor.

self : A ClutterActor
x : New left position of actor in pixels.
y : New top position of actor in pixels.

clutter_actor_get_abs_position ()

void                clutter_actor_get_abs_position      (ClutterActor *self,
                                                         gint *x,
                                                         gint *y);

Gets the absolute position of an actor in pixels relative to the stage.

self : A ClutterActor
x : Location to store x position if non NULL.
y : Location to store y position if non NULL.

clutter_actor_set_width ()

void                clutter_actor_set_width             (ClutterActor *self,
                                                         guint width);

Requests a new width for actor

self : A ClutterActor
width : Requested new width for actor

Since 2.0


clutter_actor_get_width ()

guint               clutter_actor_get_width             (ClutterActor *self);

Retrieves the actors width ignoring any scaling factors.

self : A ClutterActor
Returns : The actor width in pixels

clutter_actor_set_height ()

void                clutter_actor_set_height            (ClutterActor *self,
                                                         guint height);

Requests a new height for actor

self : A ClutterActor
height : Requested new height for actor

Since 2.0


clutter_actor_get_height ()

guint               clutter_actor_get_height            (ClutterActor *self);

Retrieves the actors height ignoring any scaling factors.

self : A ClutterActor
Returns : The actor height in pixels

clutter_actor_get_x ()

gint                clutter_actor_get_x                 (ClutterActor *self);

Retrieves the actors x position relative to any parent.

self : A ClutterActor
Returns : The actor x position in pixels ignoring any tranforms (i.e scaling, rotation).

clutter_actor_get_y ()

gint                clutter_actor_get_y                 (ClutterActor *self);

Retrieves the actors y position relative to any parent.

self : A ClutterActor
Returns : The actor y position in pixels ignoring any tranforms (i.e scaling, rotation).

clutter_actor_move_by ()

void                clutter_actor_move_by               (ClutterActor *self,
                                                         gint dx,
                                                         gint dy);

Moves an actor by specified distance relative to current position in pixels.

self : A ClutterActor
dx : Distance to move Actor on X axis.
dy : Distance to move Actor on Y axis.

Since 0.2


clutter_actor_rotate_x ()

void                clutter_actor_rotate_x              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint y,
                                                         gint z);

Rotates actor around the X axis.

self : A ClutterActor
angle : Angle of rotation
y : Y co-ord to rotate actor around ( relative to actor position )
z : Z co-ord to rotate actor around ( relative to actor position )

clutter_actor_rotate_y ()

void                clutter_actor_rotate_y              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint x,
                                                         gint z);

Rotates actor around the X axis.

self : A ClutterActor
angle : Angle of rotation
x : X co-ord to rotate actor around ( relative to actor position )
z : Z co-ord to rotate actor around ( relative to actor position )

clutter_actor_rotate_z ()

void                clutter_actor_rotate_z              (ClutterActor *self,
                                                         gfloat angle,
                                                         gint x,
                                                         gint y);

Rotates actor around the Z axis.

self : A ClutterActor
angle : Angle of rotation
x : X co-ord to rotate actor around ( relative to actor position )
y : Y co-ord to rotate actor around ( relative to actor position )

clutter_actor_set_opacity ()

void                clutter_actor_set_opacity           (ClutterActor *self,
                                                         guint8 opacity);

Sets the actors opacity, with zero being completely transparent.

self : A ClutterActor
opacity : New opacity value for actor.

clutter_actor_get_opacity ()

guint8              clutter_actor_get_opacity           (ClutterActor *self);

Retrieves the actors opacity.

self : A ClutterActor
Returns : The actor opacity value.

clutter_actor_set_name ()

void                clutter_actor_set_name              (ClutterActor *self,
                                                         const gchar *name);

Sets a textual tag to the actor.

self : A ClutterActor
name : Textual tag to apply to actor

clutter_actor_get_name ()

const gchar*        clutter_actor_get_name              (ClutterActor *self);

Retrieves the name of self.

self : A ClutterActor
Returns : pointer to textual tag for the actor. The returned string is owned by the actor and should not be modified or freed.

clutter_actor_get_id ()

guint32             clutter_actor_get_id                (ClutterActor *self);

Retrieves the unique id for self.

self : A ClutterActor
Returns : Globally unique value for object instance.

clutter_actor_set_clip ()

void                clutter_actor_set_clip              (ClutterActor *self,
                                                         gint xoff,
                                                         gint yoff,
                                                         gint width,
                                                         gint height);

Sets clip area in pixels for self.

self : A ClutterActor
xoff : X offset of the clip rectangle
yoff : Y offset of the clip rectangle
width : Width of the clip rectangle
height : Height of the clip rectangle

clutter_actor_remove_clip ()

void                clutter_actor_remove_clip           (ClutterActor *self);

Removes clip area in pixels from self.

self : A ClutterActor

clutter_actor_has_clip ()

gboolean            clutter_actor_has_clip              (ClutterActor *self);

Gets whether the actor has a clip set or not.

self : a ClutterActor
Returns : TRUE if the actor has a clip set.

Since 0.1.1


clutter_actor_set_parent ()

void                clutter_actor_set_parent            (ClutterActor *self,
                                                         ClutterActor *parent);

Sets the parent of self to parent. The opposite function is clutter_actor_unparent().

This function should not be used by applications but by custom 'composite' actor sub classes.

self : A ClutterActor
parent : A new ClutterActor parent

clutter_actor_get_parent ()

ClutterActor*       clutter_actor_get_parent            (ClutterActor *self);

Retrieves the parent of self.

self : A ClutterActor
Returns : The ClutterActor parent or NULL

clutter_actor_reparent ()

void                clutter_actor_reparent              (ClutterActor *self,
                                                         ClutterActor *new_parent);

This function resets the parent actor of self. It is logically equivalent to calling clutter_actory_unparent() and clutter_actor_set_parent().

self : a ClutterActor
new_parent : the new ClutterActor parent

Since 0.2


clutter_actor_unparent ()

void                clutter_actor_unparent              (ClutterActor *self);

This function should not be used in applications. It should be called by implementations of group actors, to dissociate a child from the container.

self : a ClutterActor

Since 0.1.1


clutter_actor_raise ()

void                clutter_actor_raise                 (ClutterActor *self,
                                                         ClutterActor *below);

Puts self above below. Both actors must have the same parent.

self : A ClutterActor
below : A ClutterActor to raise above.

clutter_actor_lower ()

void                clutter_actor_lower                 (ClutterActor *self,
                                                         ClutterActor *above);

Puts self below above. Both actors must have the same parent.

self : A ClutterActor
above : A ClutterActor to lower below

clutter_actor_raise_top ()

void                clutter_actor_raise_top             (ClutterActor *self);

Raises self to the top.

self : A ClutterActor

clutter_actor_lower_bottom ()

void                clutter_actor_lower_bottom          (ClutterActor *self);

Lowers self to the bottom.

self : A ClutterActor

clutter_actor_set_depth ()

void                clutter_actor_set_depth             (ClutterActor *self,
                                                         gint depth);

Sets the Z co-ordinate of self to depth. The Units of which are dependant on the perspective setup.

self : a ClutterActor
depth : Z co-ord

clutter_actor_get_depth ()

gint                clutter_actor_get_depth             (ClutterActor *self);

Retrieves the depth of self.

self : a ClutterActor
Returns : the depth of a ClutterActor

clutter_actor_set_scalex ()

void                clutter_actor_set_scalex            (ClutterActor *self,
                                                         ClutterFixed scale_x,
                                                         ClutterFixed scale_y);

Scales an actor with fixed point parameters.

self : A ClutterActor
scale_x : ClutterFixed factor to scale actor by horizontally.
scale_y : ClutterFixed factor to scale actor by vertically.

clutter_actor_set_scale ()

void                clutter_actor_set_scale             (ClutterActor *self,
                                                         gdouble scale_x,
                                                         gdouble scale_y);

Scales an actor with floating point parameters.

self : A ClutterActor
scale_x : double factor to scale actor by horizontally.
scale_y : double factor to scale actor by vertically.

Since 0.2


clutter_actor_get_scalex ()

void                clutter_actor_get_scalex            (ClutterActor *self,
                                                         ClutterFixed *scale_x,
                                                         ClutterFixed *scale_y);

Retrieves an actors scale in fixed point.

self : A ClutterActor
scale_x : Location to store horizonal fixed scale factor if non NULL.
scale_y : Location to store vertical fixed scale factor if non NULL.

Since 0.2


clutter_actor_get_scale ()

void                clutter_actor_get_scale             (ClutterActor *self,
                                                         gdouble *scale_x,
                                                         gdouble *scale_y);

Retrieves an actors scale in floating point.

self : A ClutterActor
scale_x : Location to store horizonal float scale factor if non NULL.
scale_y : Location to store vertical float scale factor if non NULL.

Since 0.2


clutter_actor_get_abs_size ()

void                clutter_actor_get_abs_size          (ClutterActor *self,
                                                         guint *width,
                                                         guint *height);

Gets the absolute size of an actor taking into account an scaling factors

self : A ClutterActor
width : Location to store width if non NULL.
height : Location to store height if non NULL.

clutter_actor_apply_transform_to_point ()

void                clutter_actor_apply_transform_to_point
                                                        (ClutterActor *self,
                                                         ClutterVertex *point,
                                                         ClutterVertex *vertex);

Transforms point in coordinates relative to the actor into screen coordiances

self : A ClutterActor
point : A point as ClutterVertex
vertex : The translated ClutterVertex

Since 0.4


clutter_actor_get_rxang ()

gdouble             clutter_actor_get_rxang             (ClutterActor *self);

Gets the angle of rotation around the X axis.

self : a ClutterActor
Returns : the angle of rotation

Since 0.4


clutter_actor_get_ryang ()

gdouble             clutter_actor_get_ryang             (ClutterActor *self);

Gets the angle of rotation around the Y axis.

self : a ClutterActor
Returns : the angle of rotation

Since 0.4


clutter_actor_get_rzang ()

gdouble             clutter_actor_get_rzang             (ClutterActor *self);

Gets the angle of rotation around the Z axis.

self : a ClutterActor
Returns : the angle of rotation

Since 0.4


clutter_actor_get_rxangx ()

ClutterFixed        clutter_actor_get_rxangx            (ClutterActor *self);

Gets the angle of rotation around the X axis.

self : A ClutterActor
Returns : the angle or rotation, as a fixed point value

Since 0.4


clutter_actor_get_ryangx ()

ClutterFixed        clutter_actor_get_ryangx            (ClutterActor *self);

Gets the angle of rotation around the Y axis.

self : A ClutterActor
Returns : the angle of rotation, as a fixed point value

Since 0.4


clutter_actor_get_rzangx ()

ClutterFixed        clutter_actor_get_rzangx            (ClutterActor *self);

Gets the angle of rotation around x axis in degrees.

self : A ClutterActor
Returns : the angle of rotation, as a fixed point value

Since 0.4


ClutterVertex

typedef struct {
  ClutterUnit x;
  ClutterUnit y;
  ClutterUnit z;
} ClutterVertex;

Vertex of an actor in 3D space, expressed in device independent units.

ClutterUnit x; X coordinate of the vertex
ClutterUnit y; Y coordinate of the vertex
ClutterUnit z; Z coordinate of the vertex

Since 0.4


clutter_actor_get_vertices ()

void                clutter_actor_get_vertices          (ClutterActor *self,
                                                         ClutterVertex verts[4]);

Calculates the tranformed screen coordinaces of the four corners of the actor; the returned vertices relate to the ClutterActoBox coordinances as follows:

v[0] contains (x1, y1) v[1] contains (x2, y1) v[2] contains (x1, y2) v[3] contains (x2, y2)

self : A ClutterActor
verts : Pointer to a location of an array of 4 ClutterVertex where to store the result.

Since 0.4


clutter_actor_pick ()

void                clutter_actor_pick                  (ClutterActor *self,
                                                         const ClutterColor *color);

Renders a silhouette of the actor in supplied color.

This function should not never be called directly by applications.

self : A ClutterActor
color : A ClutterColor

clutter_actor_rotate_xx ()

void                clutter_actor_rotate_xx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint y,
                                                         gint z);

Rotates actor around the X axis.

self : A ClutterActor
angle : Angle of rotation
y : Y co-ord to rotate actor around ( relative to actor position )
z : Z co-ord to rotate actor around ( relative to actor position )

clutter_actor_rotate_yx ()

void                clutter_actor_rotate_yx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint x,
                                                         gint z);

Rotates actor around the X axis.

self : A ClutterActor
angle : Angle of rotation
x : X co-ord to rotate actor around ( relative to actor position )
z : Z co-ord to rotate actor around ( relative to actor position )

clutter_actor_rotate_zx ()

void                clutter_actor_rotate_zx             (ClutterActor *self,
                                                         ClutterFixed angle,
                                                         gint x,
                                                         gint y);

Rotates actor around the Z axis.

self : A ClutterActor
angle : Angle of rotation
x : X co-ord to rotate actor around ( relative to actor position )
y : Y co-ord to rotate actor around ( relative to actor position )

clutter_actor_set_scale_with_gravity ()

void                clutter_actor_set_scale_with_gravity
                                                        (ClutterActor *self,
                                                         gfloat scale_x,
                                                         gfloat scale_y,
                                                         ClutterGravity gravity);

Scales the actor by scale_x, scale_y taking into consideration the required gravity.

self : A ClutterActor
scale_x : scaling factor for x axis
scale_y : scaling factor for y axis
gravity : ClutterGravity to apply to scaling.

Since 0.4


clutter_actor_set_scale_with_gravityx ()

void                clutter_actor_set_scale_with_gravityx
                                                        (ClutterActor *self,
                                                         ClutterFixed scale_x,
                                                         ClutterFixed scale_y,
                                                         ClutterGravity gravity);

Scales the actor by scale_x, scale_y taking into consideration the required gravity.

self : A ClutterActor
scale_x : ClutterFixed scaling factor for x axis
scale_y : ClutterFixed scaling factor for y axis
gravity : ClutterGravity to apply to scaling.

Since 0.4

Property Details

The "clip" property

  "clip"                     ClutterGeometry       : Read / Write

The clip region for the actor.


The "has-clip" property

  "has-clip"                 gboolean              : Read

Whether the actor has the clip property set or not.

Default value: FALSE


The "height" property

  "height"                   gint                  : Read / Write

Height of the actor (in pixels).

Allowed values: >= 0

Default value: 0


The "name" property

  "name"                     gchararray            : Read / Write

The name of the actor.

Default value: NULL

Since 0.2


The "opacity" property

  "opacity"                  guchar                : Read / Write / Construct

Opacity of the actor.

Default value: 255


The "visible" property

  "visible"                  gboolean              : Read / Write

Whether the actor is visible or not.

Default value: FALSE


The "width" property

  "width"                    gint                  : Read / Write

Width of the actor (in pixels).

Allowed values: >= 0

Default value: 0


The "x" property

  "x"                        gint                  : Read / Write

X coordinate of the actor.

Allowed values: >= -2147483647

Default value: 0


The "y" property

  "y"                        gint                  : Read / Write

Y coordinate of the actor.

Allowed values: >= -2147483647

Default value: 0

Signal Details

The "destroy" signal

void                user_function                      (ClutterActor *actor,
                                                        gpointer      user_data)      : Cleanup / No Recursion / No Hooks

The ::destroy signal is emitted when an actor is destroyed, either by direct invocation of clutter_actor_destroy() or when the ClutterGroup that contains the actor is destroyed.

actor : the object which received the signal
user_data : user data set when the signal handler was connected.

Since 0.2


The "hide" signal

void                user_function                      (ClutterActor *actor,
                                                        gpointer      user_data)      : Run First

The ::hide signal is emitted when an actor is no longer visible.

actor : the object which received the signal
user_data : user data set when the signal handler was connected.

Since 0.2


The "parent-set" signal

void                user_function                      (ClutterActor *actor,
                                                        ClutterActor *old_parent,
                                                        gpointer      user_data)       : Run Last

This signal is emitted when the parent of the actor changes.

actor : the object which received the signal
old_parent : the previous parent of the actor, or NULL
user_data : user data set when the signal handler was connected.

Since 0.2


The "show" signal

void                user_function                      (ClutterActor *actor,
                                                        gpointer      user_data)      : Run First

The ::show signal is emitted when an actor becomes visible.

actor : the object which received the signal
user_data : user data set when the signal handler was connected.

Since 0.2