![]() |
![]() |
![]() |
Clutter 0.6 Reference Manual | ![]() |
---|---|---|---|---|
#define CLUTTER_ACTOR_SET_FLAGS (a,f) #define CLUTTER_ACTOR_UNSET_FLAGS (a,f) #define CLUTTER_ACTOR_IS_MAPPED (e) #define CLUTTER_ACTOR_IS_REALIZED (e) #define CLUTTER_ACTOR_IS_VISIBLE (e) #define CLUTTER_ACTOR_IS_REACTIVE (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); gboolean clutter_actor_event (ClutterActor *actor, ClutterEvent *event, gboolean capture); void clutter_actor_pick (ClutterActor *self, const ClutterColor *color); gboolean clutter_actor_should_pick_paint (ClutterActor *self); 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_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); void clutter_actor_set_x (ClutterActor *self, gint x); gint clutter_actor_get_x (ClutterActor *self); void clutter_actor_set_y (ClutterActor *self, gint y); gint clutter_actor_get_y (ClutterActor *self); void clutter_actor_move_by (ClutterActor *self, gint dx, gint dy); void clutter_actor_set_rotation (ClutterActor *self, ClutterRotateAxis axis, gdouble angle, gint x, gint y, gint z); gdouble clutter_actor_get_rotation (ClutterActor *self, ClutterRotateAxis axis, gint *x, gint *y, gint *z); gboolean clutter_actor_is_rotated (ClutterActor *self); 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_gid (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_get_clip (ClutterActor *self, gint *xoff, gint *yoff, gint *width, gint *height); 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_scale (ClutterActor *self, gdouble scale_x, gdouble scale_y); void clutter_actor_get_scale (ClutterActor *self, gdouble *scale_x, gdouble *scale_y); gboolean clutter_actor_is_scaled (ClutterActor *self); 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); gboolean clutter_actor_transform_stage_point (ClutterActor *self, ClutterUnit x, ClutterUnit y, ClutterUnit *x_out, ClutterUnit *y_out); void clutter_actor_apply_relative_transform_to_point (ClutterActor *self, ClutterActor *ancestor, ClutterVertex *point, ClutterVertex *vertex); ClutterVertex; void clutter_actor_get_vertices (ClutterActor *self, ClutterVertex verts[4]); void clutter_actor_get_relative_vertices (ClutterActor *self, ClutterActor *ancestor, ClutterVertex verts[4]); void clutter_actor_box_get_from_vertices (ClutterVertex vtx[4], ClutterActorBox *box); void clutter_actor_set_anchor_point (ClutterActor *self, gint anchor_x, gint anchor_y); void clutter_actor_get_anchor_point (ClutterActor *self, gint *anchor_x, gint *anchor_y); void clutter_actor_set_anchor_point_from_gravity (ClutterActor *self, ClutterGravity gravity); void clutter_actor_move_anchor_point (ClutterActor *self, gint anchor_x, gint anchor_y); void clutter_actor_move_anchor_point_from_gravity (ClutterActor *self, ClutterGravity gravity); void clutter_actor_set_reactive (ClutterActor *actor, gboolean reactive); gboolean clutter_actor_get_reactive (ClutterActor *actor); gboolean clutter_actor_set_shader (ClutterActor *self, ClutterShader *shader); ClutterShader* clutter_actor_get_shader (ClutterActor *self); void clutter_actor_set_shader_param (ClutterActor *self, const gchar *param, gfloat value); void clutter_actor_set_depthu (ClutterActor *self, ClutterUnit depth); ClutterUnit clutter_actor_get_depthu (ClutterActor *self); void clutter_actor_set_heightu (ClutterActor *self, ClutterUnit height); ClutterUnit clutter_actor_get_heightu (ClutterActor *self); void clutter_actor_set_widthu (ClutterActor *self, ClutterUnit width); ClutterUnit clutter_actor_get_widthu (ClutterActor *self); void clutter_actor_set_xu (ClutterActor *self, ClutterUnit x); ClutterUnit clutter_actor_get_xu (ClutterActor *self); void clutter_actor_set_yu (ClutterActor *self, ClutterUnit y); ClutterUnit clutter_actor_get_yu (ClutterActor *self); void clutter_actor_set_positionu (ClutterActor *self, ClutterUnit x, ClutterUnit y); void clutter_actor_get_positionu (ClutterActor *self, ClutterUnit *x, ClutterUnit *y); void clutter_actor_set_sizeu (ClutterActor *self, ClutterUnit width, ClutterUnit height); void clutter_actor_get_sizeu (ClutterActor *self, ClutterUnit *width, ClutterUnit *height); void clutter_actor_set_anchor_pointu (ClutterActor *self, ClutterUnit anchor_x, ClutterUnit anchor_y); void clutter_actor_get_anchor_pointu (ClutterActor *self, ClutterUnit *anchor_x, ClutterUnit *anchor_y); void clutter_actor_move_anchor_pointu (ClutterActor *self, ClutterUnit anchor_x, ClutterUnit anchor_y); void clutter_actor_set_clipu (ClutterActor *self, ClutterUnit xoff, ClutterUnit yoff, ClutterUnit width, ClutterUnit height); void clutter_actor_get_clipu (ClutterActor *self, ClutterUnit *xoff, ClutterUnit *yoff, ClutterUnit *width, ClutterUnit *height); void clutter_actor_move_byu (ClutterActor *self, ClutterUnit dx, ClutterUnit dy); void clutter_actor_set_scalex (ClutterActor *self, ClutterFixed scale_x, ClutterFixed scale_y); void clutter_actor_get_scalex (ClutterActor *self, ClutterFixed *scale_x, ClutterFixed *scale_y); void clutter_actor_set_rotationx (ClutterActor *self, ClutterRotateAxis axis, ClutterFixed angle, gint x, gint y, gint z); ClutterFixed clutter_actor_get_rotationx (ClutterActor *self, ClutterRotateAxis axis, gint *x, gint *y, gint *z);
GObject +----GInitiallyUnowned +----ClutterActor +----ClutterGroup +----ClutterRectangle +----ClutterTexture +----ClutterCloneTexture +----ClutterLabel +----ClutterEntry
"clip" ClutterGeometry : Read / Write "depth" gint : Read / Write "has-clip" gboolean : Read "height" gint : Read / Write "name" gchararray : Read / Write "opacity" guchar : Read / Write "reactive" gboolean : Read / Write "rotation-angle-x" gdouble : Read / Write "rotation-angle-y" gdouble : Read / Write "rotation-angle-z" gdouble : Read / Write "rotation-center-x" ClutterVertex : Read / Write "rotation-center-y" ClutterVertex : Read / Write "rotation-center-z" ClutterVertex : Read / Write "scale-x" gdouble : Read / Write "scale-y" gdouble : Read / Write "visible" gboolean : Read / Write "width" gint : Read / Write "x" gint : Read / Write "y" gint : Read / Write
"button-press-event" : Run Last "button-release-event" : Run Last "captured-event" : Run Last "destroy" : Cleanup / No Recursion / No Hooks "enter-event" : Run Last "event" : Run Last "focus-in" : Run Last "focus-out" : Run Last "hide" : Run First "key-press-event" : Run Last "key-release-event" : Run Last "leave-event" : Run Last "motion-event" : Run Last "parent-set" : Run Last "scroll-event" : Run Last "show" : Run First
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.
Every actor is a 2D surface in a 3D environment. The surface is contained inside its bounding box, described by the ClutterActorBox structure:
The OpenGL modelview matrix for the actor is constructed from the actor settings by the following order of operations:
Translation by actor x, y coords,
Scaling by scale_x, scale_y,
Negative translation by anchor point x, y,
Rotation around z axis,
Rotation around y axis,
Rotation around x axis,
Translation by actor depth (z),
Clip stencil is applied (not an operation on the matrix as such, but done as part of the transform set up).
Events are handled in the following ways:
Actors emit pointer events if set reactive, see
clutter_actor_set_reactive()
The stage is always reactive
Events are handled by connecting signal handlers to the numerous event signal types.
Event handlers must return TRUE
if they handled
the event and wish to block the event emission chain, or FALSE
if the emission chain must continue
Keyboard events are emitted if actor has focus, see
clutter_stage_set_key_focus()
Motion events (motion, enter, leave) are not emitted
if clutter_set_motion_events_enabled()
is called with FALSE
.
See clutter_set_motion_events_enabled()
documentation for more
information.
Once emitted, an event emission chain has two
phases: capture and bubble. An emitted event starts in the capture
phase (see ClutterActor::captured-event) beginning at the stage and
traversing every child actor until the event source actor is reached.
The emission then enters the bubble phase, traversing back up the
chain via parents until it reaches the stage. Any event handler can
abort this chain by returning TRUE
(meaning "event handled").
Pointer events will 'pass through' non reactive overlapping actors.
Every '?' box in the diagram above is an entry point for application code.
For implementing a new actor class, please read the corresponding section of the API reference.
#define CLUTTER_ACTOR_SET_FLAGS(a,f) (((ClutterActor*)(a))->flags |= (f))
Sets the given flags on a ClutterActor
a : |
a ClutterActor |
f : |
the ClutterActorFlags to set |
#define CLUTTER_ACTOR_UNSET_FLAGS(a,f) (((ClutterActor*)(a))->flags &= ~(f))
Unsets the given flags on a ClutterActor
a : |
a ClutterActor |
f : |
the ClutterActorFlags to unset |
#define CLUTTER_ACTOR_IS_MAPPED(e) (((ClutterActor*)(e))->flags & CLUTTER_ACTOR_MAPPED)
Evaluates to TRUE
if the CLUTTER_ACTOR_MAPPED
flag is set.
e : |
a ClutterActor |
Since 0.2
#define CLUTTER_ACTOR_IS_REALIZED(e) (((ClutterActor*)(e))->flags & CLUTTER_ACTOR_REALIZED)
Evaluates to TRUE
if the CLUTTER_ACTOR_REALIZED
flag is set.
e : |
a ClutterActor |
Since 0.2
#define CLUTTER_ACTOR_IS_VISIBLE(e) (CLUTTER_ACTOR_IS_MAPPED (e) && CLUTTER_ACTOR_IS_REALIZED (e))
Evaluates to TRUE
if the actor is both realized and mapped.
e : |
a ClutterActor |
Since 0.2
#define CLUTTER_ACTOR_IS_REACTIVE(e) (((ClutterActor*)(e))->flags & CLUTTER_ACTOR_REACTIVE)
Evaluates to TRUE
if the CLUTTER_ACTOR_REACTIVE
flag is set.
e : |
a ClutterActor |
Since 0.6
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 |
typedef enum { CLUTTER_ACTOR_MAPPED = 1 << 1, CLUTTER_ACTOR_REALIZED = 1 << 2, CLUTTER_ACTOR_REACTIVE = 1 << 3 } ClutterActorFlags;
Flags used to signal the state of an actor.
typedef struct { gint x; gint y; guint width; guint height; } ClutterGeometry;
The rectangle containing an actor's bounding box, measured in pixels.
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 |
#define CLUTTER_CALLBACK(f) ((ClutterCallback) (f))
Convenience macro to cast a function to ClutterCallback
f : |
a function |
void (*ClutterCallback) (ClutterActor *actor, gpointer data);
Generic callback
actor : |
a ClutterActor |
data : |
user data |
typedef struct { guint32 flags; } ClutterActor;
Base class for actors.
guint32 flags ; |
ClutterActorFlags |
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 (* parent_set) (ClutterActor *actor, ClutterActor *old_parent); void (* destroy) (ClutterActor *actor); void (* pick) (ClutterActor *actor, const ClutterColor *color); /* event signals */ gboolean (* event) (ClutterActor *actor, ClutterEvent *event); gboolean (* button_press_event) (ClutterActor *actor, ClutterButtonEvent *event); gboolean (* button_release_event) (ClutterActor *actor, ClutterButtonEvent *event); gboolean (* scroll_event) (ClutterActor *actor, ClutterScrollEvent *event); gboolean (* key_press_event) (ClutterActor *actor, ClutterKeyEvent *event); gboolean (* key_release_event) (ClutterActor *actor, ClutterKeyEvent *event); gboolean (* motion_event) (ClutterActor *actor, ClutterMotionEvent *event); gboolean (* enter_event) (ClutterActor *actor, ClutterCrossingEvent *event); gboolean (* leave_event) (ClutterActor *actor, ClutterCrossingEvent *event); gboolean (* captured_event) (ClutterActor *actor, ClutterEvent *event); void (* focus_in) (ClutterActor *actor); void (* focus_out) (ClutterActor *actor); } ClutterActorClass;
Base class for actors.
show () |
signal class handler for ClutterActor::show; it must chain up to the parent's implementation |
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 ClutterActor::hide; it must chain up to the parent's implementation |
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_hide() .
|
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; it must chain up to the parent's implementation |
parent_set () |
signal class closure for the ClutterActor::parent-set |
destroy () |
signal class closure for ClutterActor::destroy |
pick () |
virtual function, used to draw an outline of the actor with the given colour |
event () |
signal class closure for ClutterActor::event |
button_press_event () |
signal class closure for ClutterActor::button-press-event |
button_release_event () |
signal class closure for ClutterActor::button-release-event |
scroll_event () |
signal class closure for ClutterActor::scroll-event |
key_press_event () |
signal class closure for ClutterActor::key-press-event |
key_release_event () |
signal class closure for ClutterActor::key-release-event |
motion_event () |
signal class closure for ClutterActor::motion-event |
enter_event () |
signal class closure for ClutterActor::enter-event |
leave_event () |
signal class closure for ClutterActor::leave-event |
captured_event () |
signal class closure for ClutterActor::captured-event |
focus_in () |
signal class closure for ClutterActor::focus-in |
focus_out () |
signal class closure for ClutterActor::focus-out |
void clutter_actor_show (ClutterActor *self);
Flags an actor to be displayed. An actor that isn't shown will not be rendered on the stage.
self : |
A ClutterActor |
void clutter_actor_show_all (ClutterActor *self);
Call show()
on all children of an actor (if any).
self : |
a ClutterActor |
Since 0.2
void clutter_actor_hide (ClutterActor *self);
Flags an actor to be hidden. A hidden actor will not be rendered on the stage.
self : |
A ClutterActor |
void clutter_actor_hide_all (ClutterActor *self);
Call hide()
on all child actors (if any).
self : |
a ClutterActor |
Since 0.2
void clutter_actor_realize (ClutterActor *self);
Creates any underlying graphics resources needed by the actor to be displayed.
self : |
A ClutterActor |
void clutter_actor_unrealize (ClutterActor *self);
Frees up any underlying graphics resources needed by the actor to be displayed.
self : |
A ClutterActor |
void clutter_actor_paint (ClutterActor *self);
Renders the actor to display.
This function should not be called directly by applications.
Call clutter_actor_queue_redraw()
to queue paints, instead.
self : |
A ClutterActor |
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 |
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 container, the actor will be removed.
When you destroy a container, its children will be destroyed as well.
Note: you cannot destroy the ClutterStage returned by
clutter_stage_get_default()
.
self : |
a ClutterActor |
void clutter_actor_request_coords (ClutterActor *self, ClutterActorBox *box);
Requests new untransformed coordinates for the bounding box of a ClutterActor. The coordinates must be relative to the current parent of the actor.
This function should not be called directly by applications; instead, the various position/geometry methods should be used.
Note: Actors overriding the ClutterActor::request_coords()
virtual
function should always chain up to the parent class request_coords()
method. Actors should override this function only if they need to
recompute some internal state or need to reposition their children.
self : |
A ClutterActor |
box : |
A ClutterActorBox with the new coordinates, in ClutterUnits |
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. The various position/geometry methods should be used instead.
self : |
A ClutterActor |
box : |
A location to store the actor's ClutterActorBox |
gboolean clutter_actor_event (ClutterActor *actor, ClutterEvent *event, gboolean capture);
This function is used to emit an event on the main stage. You should rarely need to use this function, except for synthetising events.
actor : |
a ClutterActor |
event : |
a ClutterEvent |
capture : |
TRUE if event in in capture phase, FALSE otherwise. |
Returns : | the return value from the signal emission: TRUE
if the actor handled the event, or FALSE if the event was
not handled
|
Since 0.6
void clutter_actor_pick (ClutterActor *self, const ClutterColor *color);
Renders a silhouette of the actor using the supplied color. Used internally for mapping pointer events to actors.
This function should never be called directly by applications.
Subclasses overiding the ClutterActor::pick()
method should call
clutter_actor_should_pick_paint()
to decide whether to render their
silhouette. Containers should always recursively call pick for
each child.
Since 0.4
self : |
A ClutterActor |
color : |
A ClutterColor |
gboolean clutter_actor_should_pick_paint (ClutterActor *self);
Utility call for subclasses overiding the pick method.
This function should never be called directly by applications.
self : |
A ClutterActor |
Returns : | TRUE if the actor should paint its silhouette,
FALSE otherwise
|
void clutter_actor_set_geometry (ClutterActor *self, const ClutterGeometry *geometry);
Sets the actor's untransformed geometry in pixels relative to any parent actor.
self : |
A ClutterActor |
geometry : |
A ClutterGeometry |
void clutter_actor_get_geometry (ClutterActor *self, ClutterGeometry *geometry);
Gets the actor's untransformed geometry in pixels relative to any parent actor.
self : |
A ClutterActor |
geometry : |
A location to store actors ClutterGeometry |
void clutter_actor_get_coords (ClutterActor *self, gint *x_1, gint *y_1, gint *x_2, gint *y_2);
Gets the actor's untransformed bounding rectangle coordinates 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 .
|
void clutter_actor_set_size (ClutterActor *self, gint width, gint height);
Sets the actor's size in pixels.
If width
and/or height
are -1 the actor will assume the same size
of its bounding box.
clutter_actor_set_size()
might
not produce visible results. Calling this function on a ClutterGroup,
for instance, will not resize the group - as its size is dependant
on bounding box of actual contents
self : |
A ClutterActor |
width : |
New width of actor in pixels, or -1 |
height : |
New height of actor in pixels, or -1 |
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 : |
return location for the width, or NULL .
|
height : |
return location for the height, or NULL .
|
Since 0.2
void clutter_actor_set_position (ClutterActor *self, gint x, gint y);
Sets the actor's 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. |
void clutter_actor_get_position (ClutterActor *self, gint *x, gint *y);
Retrieves the position of an actor.
self : |
a ClutterActor |
x : |
return location for the X coordinate, or NULL
|
y : |
return location for the Y coordinate, or NULL
|
Since 0.6
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 : |
return location for the X coordinate, or NULL
|
y : |
return location for the Y coordinate, or NULL
|
void clutter_actor_set_width (ClutterActor *self, guint width);
Requests a new width for the actor
self : |
A ClutterActor |
width : |
Requested new width for the actor, in pixels |
Since 0.2
guint clutter_actor_get_width (ClutterActor *self);
Retrieves the actor's width ignoring any scaling factors.
self : |
A ClutterActor |
Returns : | the width in pixels |
void clutter_actor_set_height (ClutterActor *self, guint height);
Requests a new height for the actor
self : |
A ClutterActor |
height : |
Requested new height for the actor, in pixels |
Since 0.2
guint clutter_actor_get_height (ClutterActor *self);
Retrieves the actor's height ignoring any scaling factors.
self : |
A ClutterActor |
Returns : | the height in pixels |
void clutter_actor_set_x (ClutterActor *self, gint x);
Sets the actor's X coordinate, relative to its parent.
self : |
a ClutterActor |
x : |
the actor's position on the X axis |
Since 0.6
gint clutter_actor_get_x (ClutterActor *self);
Retrieves the actor's X coordinate, relative to any parent.
self : |
A ClutterActor |
Returns : | the X coordinate, in pixels, ignoring any transformation (i.e. scaling, rotation). |
void clutter_actor_set_y (ClutterActor *self, gint y);
Sets the actor's Y coordinate, relative to its parent.
self : |
a ClutterActor |
y : |
the actor's position on the Y axis |
Since 0.6
gint clutter_actor_get_y (ClutterActor *self);
Retrieves the actor's Y coordinate, relative to any parent.
self : |
A ClutterActor |
Returns : | the Y coordinate, in pixels, ignoring any transformation (i.e. scaling, rotation). |
void clutter_actor_move_by (ClutterActor *self, gint dx, gint dy);
Moves an actor by the specified distance relative to its 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
void clutter_actor_set_rotation (ClutterActor *self, ClutterRotateAxis axis, gdouble angle, gint x, gint y, gint z);
Sets the rotation angle of self
around the given axis.
The rotation center coordinates used depend on the value of axis
:
CLUTTER_X_AXIS
requires y
and z
CLUTTER_Y_AXIS
requires x
and z
CLUTTER_Z_AXIS
requires x
and y
The rotation coordinates are relative to the anchor point of the
actor, set using clutter_actor_set_anchor_point()
. If no anchor
point is set, the upper left corner is assumed as the origin.
self : |
a ClutterActor |
axis : |
the axis of rotation |
angle : |
the angle of rotation |
x : |
X coordinate of the rotation center |
y : |
Y coordinate of the rotation center |
z : |
Z coordinate of the rotation center |
Since 0.6
gdouble clutter_actor_get_rotation (ClutterActor *self, ClutterRotateAxis axis, gint *x, gint *y, gint *z);
Retrieves the angle and center of rotation on the given axis,
set using clutter_actor_set_angle()
.
The coordinates of the center returned by this function depend on the axis passed.
self : |
a ClutterActor |
axis : |
the axis of rotation |
x : |
return value for the X coordinate of the center of rotation |
y : |
return value for the Y coordinate of the center of rotation |
z : |
return value for the Z coordinate of the center of rotation |
Returns : | the angle of rotation. |
Since 0.6
gboolean clutter_actor_is_rotated (ClutterActor *self);
Checks whether any rotation is applied to the actor.
self : |
a ClutterActor |
Returns : | TRUE if the actor is rotated.
|
Since 0.6
void clutter_actor_set_opacity (ClutterActor *self, guint8 opacity);
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.
self : |
A ClutterActor |
opacity : |
New opacity value for the actor. |
guint8 clutter_actor_get_opacity (ClutterActor *self);
Retrieves the actor's opacity.
self : |
A ClutterActor |
Returns : | The actor opacity value. |
void clutter_actor_set_name (ClutterActor *self, const gchar *name);
Sets the given name to self
. The name can be used to identify
a ClutterActor.
self : |
A ClutterActor |
name : |
Textual tag to apply to actor |
const gchar* clutter_actor_get_name (ClutterActor *self);
Retrieves the name of self
.
self : |
A ClutterActor |
Returns : | the name of the actor, or NULL . The returned string is
owned by the actor and should not be modified or freed.
|
guint32 clutter_actor_get_gid (ClutterActor *self);
Retrieves the unique id for self
.
self : |
A ClutterActor |
Returns : | Globally unique value for this object instance. |
Since 0.6
void clutter_actor_set_clip (ClutterActor *self, gint xoff, gint yoff, gint width, gint height);
Sets clip area in pixels for self
. The clip area is always computed
from the upper left corner of the actor, even if the anchor point is
set otherwise.
self : |
A ClutterActor |
xoff : |
X offset of the clip rectangle, in pixels |
yoff : |
Y offset of the clip rectangle, in pixels |
width : |
Width of the clip rectangle, in pixels |
height : |
Height of the clip rectangle, in pixels |
void clutter_actor_remove_clip (ClutterActor *self);
Removes clip area from self
.
self : |
A ClutterActor |
gboolean clutter_actor_has_clip (ClutterActor *self);
Determines whether the actor has a clip area set or not.
self : |
a ClutterActor |
Returns : | TRUE if the actor has a clip area set.
|
Since 0.1.1
void clutter_actor_get_clip (ClutterActor *self, gint *xoff, gint *yoff, gint *width, gint *height);
Gets the clip area for self
, in pixels.
self : |
a ClutterActor |
xoff : |
return location for the X offset of the clip rectangle, or NULL
|
yoff : |
return location for the Y offset of the clip rectangle, or NULL
|
width : |
return location for the width of the clip rectangle, or NULL
|
height : |
return location for the height of the clip rectangle, or NULL
|
Since 0.6
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 subclasses.
self : |
A ClutterActor |
parent : |
A new ClutterActor parent |
ClutterActor* clutter_actor_get_parent (ClutterActor *self);
Retrieves the parent of self
.
self : |
A ClutterActor |
Returns : | The ClutterActor parent, or NULL if no parent is set
|
void clutter_actor_reparent (ClutterActor *self, ClutterActor *new_parent);
This function resets the parent actor of self
. It is
logically equivalent to calling clutter_actor_unparent()
and clutter_actor_set_parent()
.
self : |
a ClutterActor |
new_parent : |
the new ClutterActor parent |
Since 0.2
void clutter_actor_unparent (ClutterActor *self);
This function should not be used in applications. It should be called by implementations of container actors, to dissociate a child from the container.
self : |
a ClutterActor |
Since 0.1.1
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. |
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 |
void clutter_actor_raise_top (ClutterActor *self);
Raises self
to the top.
self : |
A ClutterActor |
void clutter_actor_lower_bottom (ClutterActor *self);
Lowers self
to the bottom.
self : |
A ClutterActor |
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 |
gint clutter_actor_get_depth (ClutterActor *self);
Retrieves the depth of self
.
self : |
a ClutterActor |
Returns : | the depth of the actor |
void clutter_actor_set_scale (ClutterActor *self, gdouble scale_x, gdouble scale_y);
Scales an actor with the given factors. The scaling is always relative to the anchor point.
self : |
A ClutterActor |
scale_x : |
double factor to scale actor by horizontally. |
scale_y : |
double factor to scale actor by vertically. |
Since 0.2
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, or NULL .
|
scale_y : |
Location to store vertical float scale factor, or NULL .
|
Since 0.2
gboolean clutter_actor_is_scaled (ClutterActor *self);
Checks whether the actor is scaled in either dimension.
self : |
a ClutterActor |
Returns : | TRUE if the actor is scaled.
|
Since 0.6
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 : |
return location for the width, or NULL
|
height : |
return location for the height, or NULL
|
void clutter_actor_apply_transform_to_point (ClutterActor *self, ClutterVertex *point, ClutterVertex *vertex);
Transforms point
in coordinates relative to the actor
into screen-relative coordinates with the current actor
transformation (i.e. scale, rotation, etc)
self : |
A ClutterActor |
point : |
A point as ClutterVertex |
vertex : |
The translated ClutterVertex |
Since 0.4
gboolean clutter_actor_transform_stage_point (ClutterActor *self, ClutterUnit x, ClutterUnit y, ClutterUnit *x_out, ClutterUnit *y_out);
This function translates screen coordinates (x
, y
) to
coordinates relative to the actor. For example, it can be used to translate
screen events from global screen coordinates into actor-local coordinates.
The conversion can fail, notably if the transform stack results in the actor being projected on the screen as a mere line.
The conversion should not be expected to be pixel-perfect due to the nature of the operation. In general the error grows when the skewing of the actor rectangle on screen increases.
Note: This function is fairly computationally intensive.
self : |
A ClutterActor |
x : |
x screen coordinate of the point to unproject, in ClutterUnits |
y : |
y screen coordinate of the point to unproject, in ClutterUnits |
x_out : |
return location for the unprojected x coordinance, in ClutterUnits |
y_out : |
return location for the unprojected y coordinance, in ClutterUnits |
Returns : | TRUE if conversion was successful.
|
Since 0.6
void clutter_actor_apply_relative_transform_to_point (ClutterActor *self, ClutterActor *ancestor, ClutterVertex *point, ClutterVertex *vertex);
Transforms point
in coordinates relative to the actor into
ancestor-relative coordinates using the relevant transform
stack (i.e. scale, rotation, etc).
If ancestor
is NULL
the ancestor will be the ClutterStage. In
this case, the coordinates returned will be the coordinates on
the stage before the projection is applied. This is different from
the behaviour of clutter_actor_apply_transform_to_point()
.
self : |
A ClutterActor |
ancestor : |
A ClutterActor ancestor, or NULL to use the
default ClutterStage
|
point : |
A point as ClutterVertex |
vertex : |
The translated ClutterVertex |
Since 0.6
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
void clutter_actor_get_vertices (ClutterActor *self, ClutterVertex verts[4]);
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the ClutterActorBox coordinates 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
void clutter_actor_get_relative_vertices (ClutterActor *self, ClutterActor *ancestor, ClutterVertex verts[4]);
Calculates the transformed coordinates of the four corners of the
actor in the plane of ancestor
. The returned vertices relate to
the ClutterActorBox coordinates as follows:
v[0] contains (x1, y1)
v[1] contains (x2, y1)
v[2] contains (x1, y2)
v[3] contains (x2, y2)
If ancestor
is NULL
the ancestor will be the ClutterStage. In
this case, the coordinates returned will be the coordinates on
the stage before the projection is applied. This is different from
the behaviour of clutter_actor_get_vertices()
.
self : |
A ClutterActor |
ancestor : |
A ClutterActor to calculate the vertices against, or NULL
to use the default ClutterStage
|
verts : |
return location for an array of 4 ClutterVertex in which to store the result. |
Since 0.6
void clutter_actor_box_get_from_vertices (ClutterVertex vtx[4], ClutterActorBox *box);
Calculates the bounding box represented by the four vertices; for details
of the vertex array see clutter_actor_get_vertices()
.
vtx : |
array of four ClutterVertex |
box : |
return location for a ClutterActorBox |
Since 0.6
void clutter_actor_set_anchor_point (ClutterActor *self, gint anchor_x, gint anchor_y);
Sets an anchor point for the actor
. The anchor point is a point in the
coordinate space of an actor to which the actor position within its
parent is relative; the default is (0, 0), i.e. the top-left corner of
the actor.
self : |
a ClutterActor |
anchor_x : |
X coordinate of the anchor point |
anchor_y : |
Y coordinate of the anchor point |
Since 0.6
void clutter_actor_get_anchor_point (ClutterActor *self, gint *anchor_x, gint *anchor_y);
Gets the current anchor point of the actor
in pixels.
self : |
a ClutterActor |
anchor_x : |
return location for the X coordinate of the anchor point |
anchor_y : |
return location for the y coordinate of the anchor point |
Since 0.6
void clutter_actor_set_anchor_point_from_gravity (ClutterActor *self, ClutterGravity gravity);
Sets an anchor point on the actor, based on the given gravity (this is a
convenience function wrapping clutter_actor_set_anchor_point()
).
self : |
a ClutterActor |
gravity : |
ClutterGravity. |
Since 0.6
void clutter_actor_move_anchor_point (ClutterActor *self, gint anchor_x, gint anchor_y);
Sets an anchor point for the actor
, and adjusts the actor postion so
that the relative position of the actor toward its parent remains the
same.
self : |
a ClutterActor |
anchor_x : |
X coordinate of the anchor point |
anchor_y : |
Y coordinate of the anchor point |
Since 0.6
void clutter_actor_move_anchor_point_from_gravity (ClutterActor *self, ClutterGravity gravity);
Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged.
self : |
a ClutterActor |
gravity : |
ClutterGravity. |
Since 0.6
void clutter_actor_set_reactive (ClutterActor *actor, gboolean reactive);
Sets actor
as reactive. Reactive actors will receive events.
actor : |
a ClutterActor |
reactive : |
whether the actor should be reactive to events |
Since 0.6
gboolean clutter_actor_get_reactive (ClutterActor *actor);
Checks whether actor
is marked as reactive.
actor : |
a ClutterActor |
Returns : | TRUE if the actor is reactive
|
Since 0.6
gboolean clutter_actor_set_shader (ClutterActor *self, ClutterShader *shader);
Sets the ClutterShader to be used when rendering self
.
If shader
is NULL
it will unset any currently set shader
for the actor.
self : |
a ClutterActor |
shader : |
a ClutterShader or NULL to unset the shader.
|
Returns : | TRUE if the shader was successfully applied
|
Since 0.6
ClutterShader* clutter_actor_get_shader (ClutterActor *self);
Queries the currently set ClutterShader on self
.
self : |
a ClutterActor |
Returns : | The currently set ClutterShader or NULL if no
shader is set.
|
Since 0.6
void clutter_actor_set_shader_param (ClutterActor *self, const gchar *param, gfloat value);
Sets the value for a named parameter of the shader applied
to actor
.
self : |
a ClutterActor |
param : |
the name of the parameter |
value : |
the value of the parameter |
Since 0.6
void clutter_actor_set_depthu (ClutterActor *self, ClutterUnit depth);
Sets the Z co-ordinate of self
to depth
in ClutterUnits, the
units of which are dependant on the perspective setup.
self : |
a ClutterActor |
depth : |
Z co-ordinate, in ClutterUnits |
ClutterUnit clutter_actor_get_depthu (ClutterActor *self);
Retrieves the depth of self
.
self : |
a ClutterActor |
Returns : | the depth of the actor, in ClutterUnits |
Since 0.6
void clutter_actor_set_heightu (ClutterActor *self, ClutterUnit height);
Requests a new height for the actor
self : |
A ClutterActor |
height : |
Requested new height for the actor, in ClutterUnits |
Since 0.6
ClutterUnit clutter_actor_get_heightu (ClutterActor *self);
Retrieves the actor's height ignoring any scaling factors.
self : |
A ClutterActor |
Returns : | the height in ClutterUnits |
Since 0.6
void clutter_actor_set_widthu (ClutterActor *self, ClutterUnit width);
Requests a new width for the actor
self : |
A ClutterActor |
width : |
Requested new width for the actor, in ClutterUnits |
Since 0.6
ClutterUnit clutter_actor_get_widthu (ClutterActor *self);
Retrieves the actor's width ignoring any scaling factors.
self : |
A ClutterActor |
Returns : | the width in ClutterUnits |
Since 0.6
void clutter_actor_set_xu (ClutterActor *self, ClutterUnit x);
Sets the actor's X coordinate, relative to its parent.
self : |
a ClutterActor |
x : |
the actor's position on the X axis, in ClutterUnits |
Since 0.6
ClutterUnit clutter_actor_get_xu (ClutterActor *self);
Retrieves the actor's X coordinate, relative to any parent, in ClutterUnits.
self : |
A ClutterActor |
Returns : | the X coordinate, in ClutterUnits, ignoring any transformation (i.e. scaling, rotation). |
Since 0.6
void clutter_actor_set_yu (ClutterActor *self, ClutterUnit y);
Sets the actor's Y coordinate, relative to its parent.
self : |
a ClutterActor |
y : |
the actor's position on the Y axis, in ClutterUnits |
Since 0.6
ClutterUnit clutter_actor_get_yu (ClutterActor *self);
Retrieves the actor's Y coordinate, relative to any parent, in ClutterUnits.
self : |
A ClutterActor |
Returns : | the Y coordinate, in ClutterUnits, ignoring any transformation (i.e. scaling, rotation). |
void clutter_actor_set_positionu (ClutterActor *self, ClutterUnit x, ClutterUnit y);
Sets the actor's position in ClutterUnits relative to any parent actor.
self : |
A ClutterActor |
x : |
New left position of actor in ClutterUnits |
y : |
New top position of actor in ClutterUnits |
Since 0.6
void clutter_actor_get_positionu (ClutterActor *self, ClutterUnit *x, ClutterUnit *y);
Retrieves the position of an actor in ClutterUnits.
self : |
a ClutterActor |
x : |
return location for the X coordinate, or NULL
|
y : |
return location for the Y coordinate, or NULL
|
Since 0.6
void clutter_actor_set_sizeu (ClutterActor *self, ClutterUnit width, ClutterUnit height);
Sets the actor's size in ClutterUnits. If width
and/or height
are -1 the actor will assume the same size as its bounding box.
self : |
A ClutterActor |
width : |
New width of actor in ClutterUnits, or -1 |
height : |
New height of actor in ClutterUnits, or -1 |
Since 0.6
void clutter_actor_get_sizeu (ClutterActor *self, ClutterUnit *width, ClutterUnit *height);
Gets the size of an actor in ClutterUnits, ignoring any scaling factors.
self : |
A ClutterActor |
width : |
return location for the width, or NULL
|
height : |
return location for the height, or NULL
|
Since 0.6
void clutter_actor_set_anchor_pointu (ClutterActor *self, ClutterUnit anchor_x, ClutterUnit anchor_y);
Sets an anchor point for self
. The anchor point is a point in the
coordinate space of an actor to which the actor position within its
parent is relative; the default is (0, 0), i.e. the top-left corner
of the actor.
self : |
a ClutterActor |
anchor_x : |
X coordinate of the anchor point, in ClutterUnits |
anchor_y : |
Y coordinate of the anchor point, in ClutterUnits |
Since 0.6
void clutter_actor_get_anchor_pointu (ClutterActor *self, ClutterUnit *anchor_x, ClutterUnit *anchor_y);
Gets the current anchor point of the actor
in ClutterUnits.
self : |
a ClutterActor |
anchor_x : |
return location for the X coordinace of the anchor point |
anchor_y : |
return location for the X coordinace of the anchor point |
Since 0.6
void clutter_actor_move_anchor_pointu (ClutterActor *self, ClutterUnit anchor_x, ClutterUnit anchor_y);
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.
self : |
a ClutterActor |
anchor_x : |
X coordinate of the anchor point |
anchor_y : |
Y coordinate of the anchor point |
Since 0.6
void clutter_actor_set_clipu (ClutterActor *self, ClutterUnit xoff, ClutterUnit yoff, ClutterUnit width, ClutterUnit height);
Unit-based variant of clutter_actor_set_clip()
Sets clip area for self
. The clip area is always computed from the
upper left corner of the actor, even if the anchor point is set
otherwise.
self : |
A ClutterActor |
xoff : |
X offset of the clip rectangle, in ClutterUnits |
yoff : |
Y offset of the clip rectangle, in ClutterUnits |
width : |
Width of the clip rectangle, in ClutterUnits |
height : |
Height of the clip rectangle, in ClutterUnits |
Since 0.6
void clutter_actor_get_clipu (ClutterActor *self, ClutterUnit *xoff, ClutterUnit *yoff, ClutterUnit *width, ClutterUnit *height);
Unit-based variant of clutter_actor_get_clip()
.
Gets the clip area for self
, in ClutterUnits.
self : |
a ClutterActor |
xoff : |
return location for the X offset of the clip rectangle, or NULL
|
yoff : |
return location for the Y offset of the clip rectangle, or NULL
|
width : |
return location for the width of the clip rectangle, or NULL
|
height : |
return location for the height of the clip rectangle, or NULL
|
Since 0.6
void clutter_actor_move_byu (ClutterActor *self, ClutterUnit dx, ClutterUnit dy);
Moves an actor by the specified distance relative to its current position.
self : |
A ClutterActor |
dx : |
Distance to move Actor on X axis, in ClutterUnits. |
dy : |
Distance to move Actor on Y axis, in ClutterUnits. |
Since 0.6
void clutter_actor_set_scalex (ClutterActor *self, ClutterFixed scale_x, ClutterFixed scale_y);
Fixed point version of clutter_actor_set_scale()
.
Scales an actor with the given factors. The scaling is always relative to the anchor point.
self : |
A ClutterActor |
scale_x : |
ClutterFixed factor to scale actor by horizontally. |
scale_y : |
ClutterFixed factor to scale actor by vertically. |
void clutter_actor_get_scalex (ClutterActor *self, ClutterFixed *scale_x, ClutterFixed *scale_y);
Fixed point version of clutter_actor_get_scale()
.
Retrieves the scale factors of an actor.
self : |
A ClutterActor |
scale_x : |
Location to store horizonal scale factor, or NULL .
|
scale_y : |
Location to store vertical scale factor, or NULL .
|
Since 0.2
void clutter_actor_set_rotationx (ClutterActor *self, ClutterRotateAxis axis, ClutterFixed angle, gint x, gint y, gint z);
Sets the rotation angle of self
around the given axis.
This function is the fixed point variant of clutter_actor_set_rotation()
.
self : |
a ClutterActor |
axis : |
the axis of rotation |
angle : |
the angle of rotation |
x : |
X coordinate of the rotation center |
y : |
Y coordinate of the rotation center |
z : |
Z coordinate of the rotation center |
Since 0.6
ClutterFixed clutter_actor_get_rotationx (ClutterActor *self, ClutterRotateAxis axis, gint *x, gint *y, gint *z);
Retrieves the angle and center of rotation on the given axis,
set using clutter_actor_set_rotation()
.
This function is the fixed point variant of clutter_actor_get_rotation()
.
self : |
a ClutterActor |
axis : |
the axis of rotation |
x : |
return value for the X coordinate of the center of rotation |
y : |
return value for the Y coordinate of the center of rotation |
z : |
return value for the Z coordinate of the center of rotation |
Returns : | the angle of rotation as a fixed point value. |
Since 0.6
depth
" property"depth" gint : Read / Write
Depth of the actor.
Allowed values: >= -2147483647
Default value: 0
Since 0.6
has-clip
" property"has-clip" gboolean : Read
Whether the actor has the clip property set or not.
Default value: FALSE
height
" property"height" gint : Read / Write
Height of the actor (in pixels).
Allowed values: >= 0
Default value: 0
name
" property"name" gchararray : Read / Write
The name of the actor.
Default value: NULL
Since 0.2
reactive
" property"reactive" gboolean : Read / Write
Whether the actor is reactive to events or not.
Default value: FALSE
Since 0.6
rotation-angle-x
" property"rotation-angle-x" gdouble : Read / Write
The rotation angle on the X axis.
Allowed values: >= 0
Default value: 0
rotation-angle-y
" property"rotation-angle-y" gdouble : Read / Write
The rotation angle on the Y axis.
Allowed values: >= 0
Default value: 0
rotation-angle-z
" property"rotation-angle-z" gdouble : Read / Write
The rotation angle on the Z axis.
Allowed values: >= 0
Default value: 0
rotation-center-x
" property"rotation-center-x" ClutterVertex : Read / Write
The rotation center on the X axis.
rotation-center-y
" property"rotation-center-y" ClutterVertex : Read / Write
The rotation center on the Y axis.
rotation-center-z
" property"rotation-center-z" ClutterVertex : Read / Write
The rotation center on the Z axis.
scale-x
" property"scale-x" gdouble : Read / Write
Scale factor on the X axis.
Allowed values: >= 0
Default value: 1
scale-y
" property"scale-y" gdouble : Read / Write
Scale factor on the Y axis.
Allowed values: >= 0
Default value: 1
visible
" property"visible" gboolean : Read / Write
Whether the actor is visible or not.
Default value: FALSE
width
" property"width" gint : Read / Write
Width of the actor (in pixels).
Allowed values: >= 0
Default value: 0
x
" property"x" gint : Read / Write
X coordinate of the actor.
Allowed values: >= -2147483647
Default value: 0
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::button-press-event signal is emitted each time a mouse button
is pressed on actor
.
actor : |
the actor which received the event |
event : |
a ClutterButtonEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::button-release-event signal is emitted each time a mouse button
is released on actor
.
actor : |
the actor which received the event |
event : |
a ClutterButtonEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::captured-event signal is emitted when an event is captured by Clutter. This signal will be emitted starting from the top-level container (the ClutterStage) to the actor which received the event going down the hierarchy. This signal can be used to intercept every event before the specialized events (like ClutterActor::button-press-event or ::key-released-event) are emitted.
actor : |
the actor which received the signal |
event : |
a ClutterEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
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
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::enter-event signal is emitted when the pointer enters the actor
actor : |
the actor which the pointer has entered. |
event : |
a ClutterCrossingEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::event signal is emitted each time an event is received
by the actor
. This signal will be emitted on every actor,
following the hierarchy chain, until it reaches the top-level
container (the ClutterStage).
actor : |
the actor which received the event |
event : |
a ClutterEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
void user_function (ClutterActor *actor, gpointer user_data) : Run Last
The ::focus-in signal is emitted when actor
recieves key focus.
actor : |
the actor which now has key focus |
user_data : |
user data set when the signal handler was connected. |
Since 0.6
void user_function (ClutterActor *actor, gpointer user_data) : Run Last
The ::focus-out signal is emitted when actor
loses key focus.
actor : |
the actor which now has key focus |
user_data : |
user data set when the signal handler was connected. |
Since 0.6
void user_function (ClutterActor *actor, gpointer user_data) : Run First
The ::hide signal is emitted when an actor is no longer rendered on the stage.
actor : |
the object which received the signal |
user_data : |
user data set when the signal handler was connected. |
Since 0.2
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::key-press-event signal is emitted each time a keyboard button
is pressed while actor
has key focus (see clutter_stage_set_key_focus()
).
actor : |
the actor which received the event |
event : |
a ClutterKeyEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::key-release-event signal is emitted each time a keyboard button
is released while actor
has key focus (see
clutter_stage_set_key_focus()
).
actor : |
the actor which received the event |
event : |
a ClutterKeyEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::leave-event signal is emitted when the pointer leaves the actor
.
actor : |
the actor which the pointer has left |
event : |
a ClutterCrossingEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::motion-event signal is emitted each time the mouse pointer is
moved over actor
.
actor : |
the actor which received the event |
event : |
a ClutterMotionEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
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
gboolean user_function (ClutterActor *actor, ClutterEvent *event, gpointer user_data) : Run Last
The ::scroll-event signal is emitted each time the mouse is
scrolled on actor
actor : |
the actor which received the event |
event : |
a ClutterScrollEvent |
user_data : |
user data set when the signal handler was connected. |
Returns : | TRUE if the event has been handled by the actor,
or FALSE to continue the emission.
|
Since 0.6
void user_function (ClutterActor *actor, gpointer user_data) : Run First
The ::show signal is emitted when an actor is visible and rendered on the stage.
actor : |
the object which received the signal |
user_data : |
user data set when the signal handler was connected. |
Since 0.2