Actor transformations

Each actor can be transformed using methods like clutter_actor_set_scale() or clutter_actor_set_rotation(). The order in which the transformations are applied is decided by Clutter and it is the following:

Modifying an actor's geometry

Each actor has a bounding box, called “allocation” which is either set by its parent or explicitly through the clutter_actor_set_position() and clutter_actor_set_size() methods. Each actor also has an implicit preferred size.

An actor’s preferred size can be defined by any subclass by overriding the ClutterActorClass.get_preferred_width() and the ClutterActorClass.get_preferred_height() virtual functions, or it can be explicitly set by using clutter_actor_set_width() and clutter_actor_set_height().

An actor’s position can be set explicitly by using clutter_actor_set_x() and clutter_actor_set_y(); the coordinates are relative to the origin of the actor’s parent.

Managing actor children

Each actor can have multiple children, by calling clutter_actor_add_child() to add a new child actor, and clutter_actor_remove_child() to remove an existing child. ClutterActor will hold a reference on each child actor, which will be released when the child is removed from its parent, or destroyed using clutter_actor_destroy().

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

ClutterActor *actor = clutter_actor_new ();

// set the bounding box of the actor
clutter_actor_set_position (actor, 0, 0);
clutter_actor_set_size (actor, 480, 640);

// set the background color of the actor
clutter_actor_set_background_color (actor, CLUTTER_COLOR_Orange);

// set the bounding box of the child, relative to the parent
ClutterActor *child = clutter_actor_new ();
clutter_actor_set_position (child, 20, 20);
clutter_actor_set_size (child, 80, 240);

// set the background color of the child
clutter_actor_set_background_color (child, CLUTTER_COLOR_Blue);

// add the child to the actor
clutter_actor_add_child (actor, child);

Children can be inserted at a given index, or above and below another child actor. The order of insertion determines the order of the children when iterating over them. Iterating over children is performed by using clutter_actor_get_first_child(), clutter_actor_get_previous_sibling(), clutter_actor_get_next_sibling(), and clutter_actor_get_last_child(). It is also possible to retrieve a list of children by using clutter_actor_get_children(), as well as retrieving a specific child at a given index by using clutter_actor_get_child_at_index().

If you need to track additions of children to a ClutterActor, use the “actor-added” signal; similarly, to track removals of children from a ClutterActor, use the “actor-removed” signal.

See basic-actor.c.

Painting an actor

There are three ways to paint an actor:

A ClutterContent is a delegate object that takes over the painting operations of one, or more actors. The ClutterContent painting will be performed on top of the “background-color” of the actor, and before calling the actor's own implementation of the ClutterActorClass.paint_node() virtual function.

1
2
3
4
5
6
7
8

ClutterActor *actor = clutter_actor_new ();

// set the bounding box
clutter_actor_set_position (actor, 50, 50);
clutter_actor_set_size (actor, 100, 100);

// set the content; the image_content variable is set elsewhere
clutter_actor_set_content (actor, image_content);

The ClutterActorClass.paint_node() virtual function is invoked whenever an actor needs to be painted. The implementation of the virtual function must only paint the contents of the actor itself, and not the contents of its children, if the actor has any.

The ClutterPaintNode passed to the virtual function is the local root of the render tree; any node added to it will be rendered at the correct position, as defined by the actor's “allocation”.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

static void
my_actor_paint_node (ClutterActor     *actor,
                     ClutterPaintNode *root)
{
  ClutterPaintNode *node;
  ClutterActorBox box;

  // where the content of the actor should be painted
  clutter_actor_get_allocation_box (actor, &box);

  // the cogl_texture variable is set elsewhere
  node = clutter_texture_node_new (cogl_texture, CLUTTER_COLOR_White,
                                   CLUTTER_SCALING_FILTER_TRILINEAR,
                                   CLUTTER_SCALING_FILTER_LINEAR);

  // paint the content of the node using the allocation
  clutter_paint_node_add_rectangle (node, &box);

  // add the node, and transfer ownership
  clutter_paint_node_add_child (root, node);
  clutter_paint_node_unref (node);
}

The #ClutterActorClass.paint() virtual function is invoked when the
#ClutterActor::paint signal is emitted, and after the other signal
handlers have been invoked. Overriding the paint virtual function
gives total control to the paint sequence of the actor itself,
including the children of the actor, if any.

It is strongly discouraged to override the #ClutterActorClass.paint()
virtual function, as well as connecting to the #ClutterActor::paint
signal. These hooks into the paint sequence are considered legacy, and
will be removed when the Clutter API changes.

Handling events on an actor

A ClutterActor can receive and handle input device events, for instance pointer events and key events, as long as its “reactive” property is set to TRUE.

Once an actor has been determined to be the source of an event, Clutter will traverse the scene graph from the top-level actor towards the event source, emitting the “captured-event” signal on each ancestor until it reaches the source; this phase is also called the "capture" phase. If the event propagation was not stopped, the graph is walked backwards, from the source actor to the top-level, and the “event” signal is emitted, alongside eventual event-specific signals like “button-press-event” or “motion-event”; this phase is also called the "bubble" phase.

At any point of the signal emission, signal handlers can stop the propagation through the scene graph by returning CLUTTER_EVENT_STOP; otherwise, they can continue the propagation by returning CLUTTER_EVENT_PROPAGATE.

Animation

Animation is a core concept of modern user interfaces; Clutter provides a complete and powerful animation framework that automatically tweens the actor's state without requiring direct, frame by frame manipulation from your application code. You have two models at your disposal:

The implicit animation model of Clutter assumes that all the changes in an actor state should be gradual and asynchronous; Clutter will automatically transition an actor's property change between the current state and the desired one without manual intervention, if the property is defined to be animatable in its documentation.

By default, in the 1.0 API series, the transition happens with a duration of zero milliseconds, and the implicit animation is an opt in feature to retain backwards compatibility.

Implicit animations depend on the current easing state; in order to use the default easing state for an actor you should call the clutter_actor_save_easing_state() function:

1
2
3
4
5
6
7
8
9
10
11

// assume that the actor is currently positioned at (100, 100)

// store the current easing state and reset the new easing state to
// its default values
clutter_actor_save_easing_state (actor);

// change the actor's position
clutter_actor_set_position (actor, 500, 500);

// restore the previously saved easing state
clutter_actor_restore_easing_state (actor);

The example above will trigger an implicit animation of the actor between its current position to a new position.

Implicit animations use a default duration of 250 milliseconds, and a default easing mode of CLUTTER_EASE_OUT_CUBIC, unless you call clutter_actor_set_easing_mode() and clutter_actor_set_easing_duration() after changing the easing state of the actor.

It is possible to animate multiple properties of an actor at the same time, and you can animate multiple actors at the same time as well, for instance:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

clutter_actor_save_easing_state (actor);

// animate the actor's opacity and depth
clutter_actor_set_opacity (actor, 0);
clutter_actor_set_depth (actor, -100);

clutter_actor_restore_easing_state (actor);

clutter_actor_save_easing_state (another_actor);

// animate another actor's opacity
clutter_actor_set_opacity (another_actor, 255);
clutter_actor_set_depth (another_actor, 100);

clutter_actor_restore_easing_state (another_actor);

Changing the easing state will affect all the following property transitions, but will not affect existing transitions.

It is important to note that if you modify the state on an animatable property while a transition is in flight, the transition's final value will be updated, as well as its duration and progress mode by using the current easing state; for instance, in the following example:

1
2
3
4
5
6
7
8
9

clutter_actor_save_easing_state (actor);
clutter_actor_set_easing_duration (actor, 1000);
clutter_actor_set_x (actor, 200);
clutter_actor_restore_easing_state (actor);

clutter_actor_save_easing_state (actor);
clutter_actor_set_easing_duration (actor, 500);
clutter_actor_set_x (actor, 100);
clutter_actor_restore_easing_state (actor);

the first call to clutter_actor_set_x() will begin a transition of the “x” property from the current value to the value of 200 over a duration of one second; the second call to clutter_actor_set_x() will change the transition's final value to 100 and the duration to 500 milliseconds.

It is possible to receive a notification of the completion of an implicit transition by using the “transition-stopped” signal, decorated with the name of the property. In case you want to know when all the currently in flight transitions are complete, use the “transitions-completed” signal instead.

It is possible to retrieve the ClutterTransition used by the animatable properties by using clutter_actor_get_transition() and using the property name as the transition name.

The explicit animation model supported by Clutter requires that you create a ClutterTransition object, and optionally set the initial and final values. The transition will not start unless you add it to the ClutterActor.

1
2
3
4
5
6
7
8
9
10

ClutterTransition *transition;

transition = clutter_property_transition_new ("opacity");
clutter_timeline_set_duration (CLUTTER_TIMELINE (transition), 3000);
clutter_timeline_set_repeat_count (CLUTTER_TIMELINE (transition), 2);
clutter_timeline_set_auto_reverse (CLUTTER_TIMELINE (transition), TRUE);
clutter_transition_set_from (transition, G_TYPE_UINT, 255);
clutter_transition_set_to (transition, G_TYPE_UINT, 0);

clutter_actor_add_transition (actor, "animate-opacity", transition);

The example above will animate the “opacity” property of an actor between fully opaque and fully transparent, and back, over a span of 3 seconds. The animation does not begin until it is added to the actor.

The explicit animation API applies to all GObject properties, as well as the custom properties defined through the ClutterAnimatable interface, regardless of whether they are defined as implicitly animatable or not.

The explicit animation API should also be used when using custom animatable properties for ClutterAction, ClutterConstraint, and ClutterEffect instances associated to an actor; see the section on custom animatable properties below for an example.

Finally, explicit animations are useful for creating animations that run continuously, for instance:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// this animation will pulse the actor's opacity continuously
ClutterTransition *transition;
ClutterInterval *interval;

transition = clutter_property_transition_new ("opacity");

// we want to animate the opacity between 0 and 255
clutter_transition_set_from (transition, G_TYPE_UINT, 0);
clutter_transition_set_to (transition, G_TYPE_UINT, 255);

// over a one second duration, running an infinite amount of times
clutter_timeline_set_duration (CLUTTER_TIMELINE (transition), 1000);
clutter_timeline_set_repeat_count (CLUTTER_TIMELINE (transition), -1);

// we want to fade in and out, so we need to auto-reverse the transition
clutter_timeline_set_auto_reverse (CLUTTER_TIMELINE (transition), TRUE);

// and we want to use an easing function that eases both in and out
clutter_timeline_set_progress_mode (CLUTTER_TIMELINE (transition),
                                    CLUTTER_EASE_IN_OUT_CUBIC);

// add the transition to the desired actor to start it
clutter_actor_add_transition (actor, "opacityAnimation", transition);

Implementing an actor

Careful consideration should be given when deciding to implement a ClutterActor sub-class. It is generally recommended to implement a sub-class of ClutterActor only for actors that should be used as leaf nodes of a scene graph.

If your actor should be painted in a custom way, you should override the “paint” signal class handler. You can either opt to chain up to the parent class implementation or decide to fully override the default paint implementation; Clutter will set up the transformations and clip regions prior to emitting the “paint” signal.

By overriding the ClutterActorClass.get_preferred_width() and ClutterActorClass.get_preferred_height() virtual functions it is possible to change or provide the preferred size of an actor; similarly, by overriding the ClutterActorClass.allocate() virtual function it is possible to control the layout of the children of an actor. Make sure to always chain up to the parent implementation of the ClutterActorClass.allocate() virtual function.

In general, it is strongly encouraged to use delegation and composition instead of direct subclassing.

ClutterActor custom properties for ClutterScript

ClutterActor defines a custom "rotation" property which allows a short-hand description of the rotations to be applied to an actor.

The syntax of the "rotation" property is the following:

1

"rotation" : [ { "<axis>" : [ <angle>, [ <center-point> ] ] } ]

where:

ClutterActor also defines a scriptable "margin" property which follows the CSS "margin" shorthand.

1
2
3
4
5
6
7
8

// 4 values
"margin" : [ top, right, bottom, left ]
// 3 values
"margin" : [ top, left/right, bottom ]
// 2 values
"margin" : [ top/bottom, left/right ]
// 1 value
"margin" : [ top/right/bottom/left ]

ClutterActor will also parse every positional and dimensional property defined as a string through clutter_units_from_string(); you should read the documentation for the ClutterUnits parser format for the valid units and syntax.

Custom animatable properties

ClutterActor allows accessing properties of ClutterAction, ClutterEffect, and ClutterConstraint instances associated to an actor instance for animation purposes.

In order to access a specific ClutterAction or a ClutterConstraint property it is necessary to set the “name” property on the given action or constraint.

The property can be accessed using the following syntax:

1

@<section>.<meta-name>.<property-name>

The example below animates a ClutterBindConstraint applied to an actor using an explicit transition. The rect actor has a binding constraint on the origin actor, and in its initial state is overlapping the actor to which is bound to.

1
2
3
4
5
6
7
8
9
10
11
12
13

constraint = clutter_bind_constraint_new (origin, CLUTTER_BIND_X, 0.0);
clutter_actor_meta_set_name (CLUTTER_ACTOR_META (constraint), "bind-x");
clutter_actor_add_constraint (rect, constraint);

constraint = clutter_bind_constraint_new (origin, CLUTTER_BIND_Y, 0.0);
clutter_actor_meta_set_name (CLUTTER_ACTOR_META (constraint), "bind-y");
clutter_actor_add_constraint (rect, constraint);

clutter_actor_set_reactive (origin, TRUE);

g_signal_connect (origin, "button-press-event",
                  G_CALLBACK (on_button_press),
                  rect);

On button press, the rectangle "slides" from behind the actor to which is bound to, using the “offset” property to achieve the effect:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

gboolean
on_button_press (ClutterActor *origin,
                 ClutterEvent *event,
                 ClutterActor *rect)
{
  ClutterTransition *transition;

  // the offset that we want to apply; this will make the actor
  // slide in from behind the origin and rest at the right of
  // the origin, plus a padding value
  float new_offset = clutter_actor_get_width (origin) + h_padding;

  // the property we wish to animate; the "@constraints" section
  // tells Clutter to check inside the constraints associated
  // with the actor; the "bind-x" section is the name of the
  // constraint; and the "offset" is the name of the property
  // on the constraint
  const char *prop = "@constraints.bind-x.offset";

  // create a new transition for the given property
  transition = clutter_property_transition_new (prop);

  // set the easing mode and duration
  clutter_timeline_set_progress_mode (CLUTTER_TIMELINE (transition),
                                      CLUTTER_EASE_OUT_CUBIC);
  clutter_timeline_set_duration (CLUTTER_TIMELINE (transition), 500);

  // create the interval with the initial and final values
  clutter_transition_set_from (transition, G_TYPE_FLOAT, 0.f);
  clutter_transition_set_to (transition, G_TYPE_FLOAT, new_offset);

  // add the transition to the actor; this causes the animation
  // to start. the name "offsetAnimation" can be used to retrieve
  // the transition later
  clutter_actor_add_transition (rect, "offsetAnimation", transition);

  // we handled the event
  return CLUTTER_EVENT_STOP;
}

CLUTTER_ACTOR_SET_FLAGS()

#define             CLUTTER_ACTOR_SET_FLAGS(a,f)

Sets the given flags on a ClutterActor

CLUTTER_ACTOR_UNSET_FLAGS()

#define             CLUTTER_ACTOR_UNSET_FLAGS(a,f)

Unsets the given flags on a ClutterActor

CLUTTER_ACTOR_IS_MAPPED()

#define             CLUTTER_ACTOR_IS_MAPPED(a)

Evaluates to TRUE if the CLUTTER_ACTOR_MAPPED flag is set.

The mapped state is set when the actor is visible and all its parents up to a top-level (e.g. a ClutterStage) are visible, realized, and mapped.

This check can be used to see if an actor is going to be painted, as only actors with the CLUTTER_ACTOR_MAPPED flag set are going to be painted.

The CLUTTER_ACTOR_MAPPED flag is managed by Clutter itself, and it should not be checked directly; instead, the recommended usage is to connect a handler on the “notify” signal for the “mapped” property of ClutterActor, and check the presence of the CLUTTER_ACTOR_MAPPED flag on state changes.

It is also important to note that Clutter may delay the changes of the CLUTTER_ACTOR_MAPPED flag on top-levels due to backend-specific limitations, or during the reparenting of an actor, to optimize unnecessary (and potentially expensive) state changes.

Since: 0.2

CLUTTER_ACTOR_IS_REALIZED()

#define             CLUTTER_ACTOR_IS_REALIZED(a)

Evaluates to TRUE if the CLUTTER_ACTOR_REALIZED flag is set.

The realized state has an actor-dependant interpretation. If an actor wants to delay allocating resources until it is attached to a stage, it may use the realize state to do so. However it is perfectly acceptable for an actor to allocate Cogl resources before being realized because there is only one drawing context used by Clutter so any resources will work on any stage. If an actor is mapped it must also be realized, but an actor can be realized and unmapped (this is so hiding an actor temporarily doesn't do an expensive unrealize/realize).

To be realized an actor must be inside a stage, and all its parents must be realized.

Since: 0.2

CLUTTER_ACTOR_IS_VISIBLE()

#define             CLUTTER_ACTOR_IS_VISIBLE(a)

Evaluates to TRUE if the actor has been shown, FALSE if it's hidden. Equivalent to the ClutterActor::visible object property.

Note that an actor is only painted onscreen if it's mapped, which means it's visible, and all its parents are visible, and one of the parents is a toplevel stage; see also CLUTTER_ACTOR_IS_MAPPED.

Since: 0.2

CLUTTER_ACTOR_IS_REACTIVE()

#define             CLUTTER_ACTOR_IS_REACTIVE(a)

Evaluates to TRUE if the CLUTTER_ACTOR_REACTIVE flag is set.

Only reactive actors will receive event-related signals.

Since: 0.6

CLUTTER_CALLBACK()

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

Convenience macro to cast a function to ClutterCallback

ClutterCallback ()

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

Generic callback

clutter_actor_new ()

ClutterActor *
clutter_actor_new (void);

Creates a new ClutterActor.

A newly created actor has a floating reference, which will be sunk when it is added to another actor.

Since: 1.10

clutter_actor_set_flags ()

void
clutter_actor_set_flags (ClutterActor *self,
                         ClutterActorFlags flags);

Sets flags on self

This function will emit notifications for the changed properties

Since: 1.0

clutter_actor_unset_flags ()

void
clutter_actor_unset_flags (ClutterActor *self,
                           ClutterActorFlags flags);

Unsets flags on self

This function will emit notifications for the changed properties

Since: 1.0

clutter_actor_get_flags ()

ClutterActorFlags
clutter_actor_get_flags (ClutterActor *self);

Retrieves the flags set on self

Since: 1.0

clutter_actor_set_name ()

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.

clutter_actor_get_name ()

const gchar *
clutter_actor_get_name (ClutterActor *self);

Retrieves the name of self .

clutter_actor_get_gid ()

guint32
clutter_actor_get_gid (ClutterActor *self);

Retrieves the unique id for self .

Since: 0.6

clutter_actor_show ()

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.

Actors are visible by default.

If this function is called on an actor without a parent, the “show-on-set-parent” will be set to TRUE as a side effect.

clutter_actor_show_all ()

void
clutter_actor_show_all (ClutterActor *self);

Calls clutter_actor_show() on all children of an actor (if any).

Since: 0.2

clutter_actor_hide ()

void
clutter_actor_hide (ClutterActor *self);

Flags an actor to be hidden. A hidden actor will not be rendered on the stage.

Actors are visible by default.

If this function is called on an actor without a parent, the “show-on-set-parent” property will be set to FALSE as a side-effect.

clutter_actor_hide_all ()

void
clutter_actor_hide_all (ClutterActor *self);

Calls clutter_actor_hide() on all child actors (if any).

Since: 0.2

clutter_actor_is_visible ()

gboolean
clutter_actor_is_visible (ClutterActor *self);

Checks whether an actor is marked as visible.

See also CLUTTER_ACTOR_IS_VISIBLE and “visible”.

Since: 1.24

clutter_actor_realize ()

void
clutter_actor_realize (ClutterActor *self);

Realization informs the actor that it is attached to a stage. It can use this to allocate resources if it wanted to delay allocation until it would be rendered. However it is perfectly acceptable for an actor to create resources before being realized because Clutter only ever has a single rendering context so that actor is free to be moved from one stage to another.

This function does nothing if the actor is already realized.

Because a realized actor must have realized parent actors, calling clutter_actor_realize() will also realize all parents of the actor.

This function does not realize child actors, except in the special case that realizing the stage, when the stage is visible, will suddenly map (and thus realize) the children of the stage.

clutter_actor_unrealize ()

void
clutter_actor_unrealize (ClutterActor *self);

Unrealization informs the actor that it may be being destroyed or moved to another stage. The actor may want to destroy any underlying graphics resources at this point. However it is perfectly acceptable for it to retain the resources until the actor is destroyed because Clutter only ever uses a single rendering context and all of the graphics resources are valid on any stage.

Because mapped actors must be realized, actors may not be unrealized if they are mapped. This function hides the actor to be sure it isn't mapped, an application-visible side effect that you may not be expecting.

This function should not be called by application code.

This function should not really be in the public API, because there isn't a good reason to call it. ClutterActor will already unrealize things for you when it's important to do so.

If you were using clutter_actor_unrealize() in a dispose implementation, then don't, just chain up to ClutterActor's dispose.

If you were using clutter_actor_unrealize() to implement unrealizing children of your container, then don't, ClutterActor will already take care of that.

clutter_actor_is_realized ()

gboolean
clutter_actor_is_realized (ClutterActor *self);

Checks whether a ClutterActor is realized.

See also CLUTTER_ACTOR_IS_REALIZED and “realized”.

Since: 1.24

clutter_actor_paint ()

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.

This function is context-aware, and will either cause a regular paint or a pick paint.

This function will emit the “paint” signal or the “pick” signal, depending on the context.

This function does not paint the actor if the actor is set to 0, unless it is performing a pick paint.

clutter_actor_continue_paint ()

void
clutter_actor_continue_paint (ClutterActor *self);

Run the next stage of the paint sequence. This function should only be called within the implementation of the ‘run’ virtual of a ClutterEffect. It will cause the run method of the next effect to be applied, or it will paint the actual actor if the current effect is the last effect in the chain.

Since: 1.8

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.

This function will not do anything if self is not visible, or if the actor is inside an invisible part of the scenegraph.

Also be aware that painting is a NOP for actors with an opacity of 0

When you are implementing a custom actor you must queue a redraw whenever some private state changes that will affect painting or picking of your actor.

clutter_actor_queue_redraw_with_clip ()

void
clutter_actor_queue_redraw_with_clip (ClutterActor *self,
                                      const cairo_rectangle_int_t *clip);

Queues a redraw on self limited to a specific, actor-relative rectangular area.

If clip is NULL this function is equivalent to clutter_actor_queue_redraw().

Since: 1.10

clutter_actor_queue_relayout ()

void
clutter_actor_queue_relayout (ClutterActor *self);

Indicates that the actor's size request or other layout-affecting properties may have changed. This function is used inside ClutterActor subclass implementations, not by applications directly.

Queueing a new layout automatically queues a redraw as well.

Since: 0.8

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 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().

clutter_actor_event ()

gboolean
clutter_actor_event (ClutterActor *actor,
                     const 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.

Since: 0.6

clutter_actor_should_pick_paint ()

gboolean
clutter_actor_should_pick_paint (ClutterActor *self);

Should be called inside the implementation of the “pick” virtual function in order to check whether the actor should paint itself in pick mode or not.

This function should never be called directly by applications.

clutter_actor_map ()

void
clutter_actor_map (ClutterActor *self);

Sets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly maps and realizes its children if they are visible. Does nothing if the actor is not visible.

Calling this function is strongly disencouraged: the default implementation of ClutterActorClass.map() will map all the children of an actor when mapping its parent.

When overriding map, it is mandatory to chain up to the parent implementation.

Since: 1.0

clutter_actor_unmap ()

void
clutter_actor_unmap (ClutterActor *self);

Unsets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly unmaps its children if they were mapped.

Calling this function is not encouraged: the default ClutterActor implementation of ClutterActorClass.unmap() will also unmap any eventual children by default when their parent is unmapped.

When overriding ClutterActorClass.unmap(), it is mandatory to chain up to the parent implementation.

It is important to note that the implementation of the ClutterActorClass.unmap() virtual function may be called after the ClutterActorClass.destroy() or the GObjectClass.dispose() implementation, but it is guaranteed to be called before the GObjectClass.finalize() implementation.

Since: 1.0

clutter_actor_is_mapped ()

gboolean
clutter_actor_is_mapped (ClutterActor *self);

Checks whether a ClutterActor has been set as mapped.

See also CLUTTER_ACTOR_IS_MAPPED and “mapped”

Since: 1.24

clutter_actor_has_overlaps ()

gboolean
clutter_actor_has_overlaps (ClutterActor *self);

Asks the actor's implementation whether it may contain overlapping primitives.

For example; Clutter may use this to determine whether the painting should be redirected to an offscreen buffer to correctly implement the opacity property.

Custom actors can override the default response by implementing the ClutterActorClass.has_overlaps() virtual function. See clutter_actor_set_offscreen_redirect() for more information.

Since: 1.8

clutter_actor_has_mapped_clones ()

gboolean
clutter_actor_has_mapped_clones (ClutterActor *self);

Returns whether a ClutterActor has any mapped clones.

Return: TRUE if the actor has mapped clones, and FALSE otherwise

Since: 1.16

clutter_actor_allocate ()

void
clutter_actor_allocate (ClutterActor *self,
                        const ClutterActorBox *box,
                        ClutterAllocationFlags flags);

Assigns the size of a ClutterActor from the given box .

This function should only be called on the children of an actor when overriding the ClutterActorClass.allocate() virtual function.

This function will adjust the stored allocation to take into account the alignment flags set in the “x-align” and “y-align” properties, as well as the margin values set in the “margin-top”, “margin-right”, “margin-bottom”, and “margin-left” properties.

This function will respect the easing state of the ClutterActor and interpolate between the current allocation and the new one if the easing state duration is a positive value.

Actors can know from their allocation box whether they have moved with respect to their parent actor. The flags parameter describes additional information about the allocation, for instance whether the parent has moved with respect to the stage, for example because a grandparent's origin has moved.

Since: 0.8

clutter_actor_allocate_preferred_size ()

void
clutter_actor_allocate_preferred_size (ClutterActor *self,
                                       ClutterAllocationFlags flags);

Allocates the natural size of self .

This function is a utility call for ClutterActor implementations that allocates the actor's preferred natural size. It can be used by fixed layout managers (like ClutterGroup or so called 'composite actors') inside the ClutterActor::allocate implementation to give each child exactly how much space it requires, regardless of the size of the parent.

This function is not meant to be used by applications. It is also not meant to be used outside the implementation of the ClutterActorClass.allocate virtual function.

Since: 0.8

clutter_actor_allocate_available_size ()

void
clutter_actor_allocate_available_size (ClutterActor *self,
                                       gfloat x,
                                       gfloat y,
                                       gfloat available_width,
                                       gfloat available_height,
                                       ClutterAllocationFlags flags);

Allocates self taking into account the ClutterActor's preferred size, but limiting it to the maximum available width and height provided.

This function will do the right thing when dealing with the actor's request mode.

The implementation of this function is equivalent to:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

if (request_mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH)
  {
    clutter_actor_get_preferred_width (self, available_height,
                                       &min_width,
                                       &natural_width);
    width = CLAMP (natural_width, min_width, available_width);

    clutter_actor_get_preferred_height (self, width,
                                        &min_height,
                                        &natural_height);
    height = CLAMP (natural_height, min_height, available_height);
  }
else if (request_mode == CLUTTER_REQUEST_WIDTH_FOR_HEIGHT)
  {
    clutter_actor_get_preferred_height (self, available_width,
                                        &min_height,
                                        &natural_height);
    height = CLAMP (natural_height, min_height, available_height);

    clutter_actor_get_preferred_width (self, height,
                                       &min_width,
                                       &natural_width);
    width = CLAMP (natural_width, min_width, available_width);
  }
else if (request_mode == CLUTTER_REQUEST_CONTENT_SIZE)
  {
    clutter_content_get_preferred_size (content, &natural_width, &natural_height);

    width = CLAMP (natural_width, 0, available_width);
    height = CLAMP (natural_height, 0, available_height);
  }

box.x1 = x; box.y1 = y;
box.x2 = box.x1 + available_width;
box.y2 = box.y1 + available_height;
clutter_actor_allocate (self, &box, flags);

This function can be used by fluid layout managers to allocate an actor's preferred size without making it bigger than the area available for the container.

Since: 1.0

clutter_actor_allocate_align_fill ()

void
clutter_actor_allocate_align_fill (ClutterActor *self,
                                   const ClutterActorBox *box,
                                   gdouble x_align,
                                   gdouble y_align,
                                   gboolean x_fill,
                                   gboolean y_fill,
                                   ClutterAllocationFlags flags);

Allocates self by taking into consideration the available allocation area; an alignment factor on either axis; and whether the actor should fill the allocation on either axis.

The box should contain the available allocation width and height; if the x1 and y1 members of ClutterActorBox are not set to 0, the allocation will be offset by their value.

This function takes into consideration the geometry request specified by the “request-mode” property, and the text direction.

This function is useful for fluid layout managers using legacy alignment flags. Newly written layout managers should use the “x-align” and “y-align” properties, instead, and just call clutter_actor_allocate() inside their ClutterActorClass.allocate() implementation.

Since: 1.4

clutter_actor_set_allocation ()

void
clutter_actor_set_allocation (ClutterActor *self,
                              const ClutterActorBox *box,
                              ClutterAllocationFlags flags);

Stores the allocation of self as defined by box .

This function can only be called from within the implementation of the ClutterActorClass.allocate() virtual function.

The allocation should have been adjusted to take into account constraints, alignment, and margin properties. If you are implementing a ClutterActor subclass that provides its own layout management policy for its children instead of using a ClutterLayoutManager delegate, you should not call this function on the children of self ; instead, you should call clutter_actor_allocate(), which will adjust the allocation box for you.

This function should only be used by subclasses of ClutterActor that wish to store their allocation but cannot chain up to the parent's implementation; the default implementation of the ClutterActorClass.allocate() virtual function will call this function.

It is important to note that, while chaining up was the recommended behaviour for ClutterActor subclasses prior to the introduction of this function, it is recommended to call clutter_actor_set_allocation() instead.

If the ClutterActor is using a ClutterLayoutManager delegate object to handle the allocation of its children, this function will call the clutter_layout_manager_allocate() function only if the CLUTTER_DELEGATE_LAYOUT flag is set on flags , otherwise it is expected that the subclass will call clutter_layout_manager_allocate() by itself. For instance, the following code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

static void
my_actor_allocate (ClutterActor *actor,
                   const ClutterActorBox *allocation,
                   ClutterAllocationFlags flags)
{
  ClutterActorBox new_alloc;
  ClutterAllocationFlags new_flags;

  adjust_allocation (allocation, &new_alloc);

  new_flags = flags | CLUTTER_DELEGATE_LAYOUT;

  // this will use the layout manager set on the actor
  clutter_actor_set_allocation (actor, &new_alloc, new_flags);
}

is equivalent to this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

static void
my_actor_allocate (ClutterActor *actor,
                   const ClutterActorBox *allocation,
                   ClutterAllocationFlags flags)
{
  ClutterLayoutManager *layout;
  ClutterActorBox new_alloc;

  adjust_allocation (allocation, &new_alloc);

  clutter_actor_set_allocation (actor, &new_alloc, flags);

  layout = clutter_actor_get_layout_manager (actor);
  clutter_layout_manager_allocate (layout,
                                   CLUTTER_CONTAINER (actor),
                                   &new_alloc,
                                   flags);
}

Since: 1.10

clutter_actor_get_allocation_box ()

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

Gets the layout box an actor has been assigned. The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date.

An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.

Do not call any of the clutter_actor_get_allocation_*() family of functions inside the implementation of the get_preferred_width() or get_preferred_height() virtual functions.

Since: 0.8

clutter_actor_get_allocation_geometry ()

void
clutter_actor_get_allocation_geometry (ClutterActor *self,
                                       ClutterGeometry *geom);

Gets the layout box an actor has been assigned. The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date.

An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.

The returned rectangle is in pixels.

Since: 0.8

clutter_actor_get_allocation_vertices ()

void
clutter_actor_get_allocation_vertices (ClutterActor *self,
                                       ClutterActor *ancestor,
                                       ClutterVertex verts[]);

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:

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_abs_allocation_vertices().

Since: 0.6

clutter_actor_get_preferred_size ()

void
clutter_actor_get_preferred_size (ClutterActor *self,
                                  gfloat *min_width_p,
                                  gfloat *min_height_p,
                                  gfloat *natural_width_p,
                                  gfloat *natural_height_p);

Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height).

The width and height used to compute the preferred height and preferred width are the actor's natural ones.

If you need to control the height for the preferred width, or the width for the preferred height, you should use clutter_actor_get_preferred_width() and clutter_actor_get_preferred_height(), and check the actor's preferred geometry management using the “request-mode” property.

Since: 0.8

clutter_actor_get_preferred_width ()

void
clutter_actor_get_preferred_width (ClutterActor *self,
                                   gfloat for_height,
                                   gfloat *min_width_p,
                                   gfloat *natural_width_p);

Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values.

An actor may not get its request - depending on the layout manager that's in effect.

A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.

Since: 0.8

clutter_actor_get_preferred_height ()

void
clutter_actor_get_preferred_height (ClutterActor *self,
                                    gfloat for_width,
                                    gfloat *min_height_p,
                                    gfloat *natural_height_p);

Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values.

An actor may not get its request - depending on the layout manager that's in effect.

A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.

Since: 0.8

clutter_actor_set_fixed_position_set ()

void
clutter_actor_set_fixed_position_set (ClutterActor *self,
                                      gboolean is_set);

Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager).

Since: 0.8

clutter_actor_get_fixed_position_set ()

gboolean
clutter_actor_get_fixed_position_set (ClutterActor *self);

Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).

Since: 0.8

clutter_actor_set_request_mode ()

void
clutter_actor_set_request_mode (ClutterActor *self,
                                ClutterRequestMode mode);

Sets the geometry request mode of self .

The mode determines the order for invoking clutter_actor_get_preferred_width() and clutter_actor_get_preferred_height()

Since: 1.2

clutter_actor_get_request_mode ()

ClutterRequestMode
clutter_actor_get_request_mode (ClutterActor *self);

Retrieves the geometry request mode of self

Since: 1.2

clutter_actor_has_allocation ()

gboolean
clutter_actor_has_allocation (ClutterActor *self);

Checks if the actor has an up-to-date allocation assigned to it. This means that the actor should have an allocation: it's visible and has a parent. It also means that there is no outstanding relayout request in progress for the actor or its children (There might be other outstanding layout requests in progress that will cause the actor to get a new allocation when the stage is laid out, however).

If this function returns FALSE, then the actor will normally be allocated before it is next drawn on the screen.

Since: 1.4

clutter_actor_set_x_align ()

void
clutter_actor_set_x_align (ClutterActor *self,
                           ClutterActorAlign x_align);

Sets the horizontal alignment policy of a ClutterActor, in case the actor received extra horizontal space.

See also the “x-align” property.

Since: 1.10

clutter_actor_get_x_align ()

ClutterActorAlign
clutter_actor_get_x_align (ClutterActor *self);

Retrieves the horizontal alignment policy set using clutter_actor_set_x_align().

Since: 1.10

clutter_actor_set_y_align ()

void
clutter_actor_set_y_align (ClutterActor *self,
                           ClutterActorAlign y_align);

Sets the vertical alignment policy of a ClutterActor, in case the actor received extra vertical space.

See also the “y-align” property.

Since: 1.10

clutter_actor_get_y_align ()

ClutterActorAlign
clutter_actor_get_y_align (ClutterActor *self);

Retrieves the vertical alignment policy set using clutter_actor_set_y_align().

Since: 1.10

clutter_margin_copy ()

ClutterMargin *
clutter_margin_copy (const ClutterMargin *margin_);

Creates a new ClutterMargin and copies the contents of margin_ into the newly created structure.

Since: 1.10

clutter_margin_free ()

void
clutter_margin_free (ClutterMargin *margin_);

Frees the resources allocated by clutter_margin_new() and clutter_margin_copy().

Since: 1.10

clutter_margin_new ()

ClutterMargin *
clutter_margin_new (void);

Creates a new ClutterMargin.

Since: 1.10

clutter_actor_set_margin ()

void
clutter_actor_set_margin (ClutterActor *self,
                          const ClutterMargin *margin);

Sets all the components of the margin of a ClutterActor.

Since: 1.10

clutter_actor_get_margin ()

void
clutter_actor_get_margin (ClutterActor *self,
                          ClutterMargin *margin);

Retrieves all the components of the margin of a ClutterActor.

Since: 1.10

clutter_actor_set_margin_top ()

void
clutter_actor_set_margin_top (ClutterActor *self,
                              gfloat margin);

Sets the margin from the top of a ClutterActor.

The “margin-top” property is animatable.

Since: 1.10

clutter_actor_get_margin_top ()

gfloat
clutter_actor_get_margin_top (ClutterActor *self);

Retrieves the top margin of a ClutterActor.

Since: 1.10

clutter_actor_set_margin_right ()

void
clutter_actor_set_margin_right (ClutterActor *self,
                                gfloat margin);

Sets the margin from the right of a ClutterActor.

The “margin-right” property is animatable.

Since: 1.10

clutter_actor_get_margin_right ()

gfloat
clutter_actor_get_margin_right (ClutterActor *self);

Retrieves the right margin of a ClutterActor.

Since: 1.10

clutter_actor_set_margin_bottom ()

void
clutter_actor_set_margin_bottom (ClutterActor *self,
                                 gfloat margin);

Sets the margin from the bottom of a ClutterActor.

The “margin-bottom” property is animatable.

Since: 1.10

clutter_actor_get_margin_bottom ()

gfloat
clutter_actor_get_margin_bottom (ClutterActor *self);

Retrieves the bottom margin of a ClutterActor.

Since: 1.10

clutter_actor_set_margin_left ()

void
clutter_actor_set_margin_left (ClutterActor *self,
                               gfloat margin);

Sets the margin from the left of a ClutterActor.

The “margin-left” property is animatable.

Since: 1.10

clutter_actor_get_margin_left ()

gfloat
clutter_actor_get_margin_left (ClutterActor *self);

Retrieves the left margin of a ClutterActor.

Since: 1.10

clutter_actor_set_x_expand ()

void
clutter_actor_set_x_expand (ClutterActor *self,
                            gboolean expand);

Sets whether a ClutterActor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible.

Setting an actor to expand will also make all its parent expand, so that it's possible to build an actor tree and only set this flag on its leaves and not on every single actor.

Since: 1.12

clutter_actor_get_x_expand ()

gboolean
clutter_actor_get_x_expand (ClutterActor *self);

Retrieves the value set with clutter_actor_set_x_expand().

See also: clutter_actor_needs_expand()

Since: 1.12

clutter_actor_set_y_expand ()

void
clutter_actor_set_y_expand (ClutterActor *self,
                            gboolean expand);

Sets whether a ClutterActor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible.

Setting an actor to expand will also make all its parent expand, so that it's possible to build an actor tree and only set this flag on its leaves and not on every single actor.

Since: 1.12

clutter_actor_get_y_expand ()

gboolean
clutter_actor_get_y_expand (ClutterActor *self);

Retrieves the value set with clutter_actor_set_y_expand().

See also: clutter_actor_needs_expand()

Since: 1.12

clutter_actor_needs_expand ()

gboolean
clutter_actor_needs_expand (ClutterActor *self,
                            ClutterOrientation orientation);

Checks whether an actor, or any of its children, is set to expand horizontally or vertically.

This function should only be called by layout managers that can assign extra space to their children.

If you want to know whether the actor was explicitly set to expand, use clutter_actor_get_x_expand() or clutter_actor_get_y_expand().

Since: 1.12

clutter_actor_set_layout_manager ()

void
clutter_actor_set_layout_manager (ClutterActor *self,
                                  ClutterLayoutManager *manager);

Sets the ClutterLayoutManager delegate object that will be used to lay out the children of self .

The ClutterActor will take a reference on the passed manager which will be released either when the layout manager is removed, or when the actor is destroyed.

Since: 1.10

clutter_actor_get_layout_manager ()

ClutterLayoutManager *
clutter_actor_get_layout_manager (ClutterActor *self);

Retrieves the ClutterLayoutManager used by self .

Since: 1.10

clutter_actor_set_background_color ()

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

Sets the background color of a ClutterActor.

The background color will be used to cover the whole allocation of the actor. The default background color of an actor is transparent.

To check whether an actor has a background color, you can use the “background-color-set” actor property.

The “background-color” property is animatable.

Since: 1.10

clutter_actor_get_background_color ()

void
clutter_actor_get_background_color (ClutterActor *self,
                                    ClutterColor *color);

Retrieves the color set using clutter_actor_set_background_color().

Since: 1.10

clutter_actor_set_geometry ()

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

Sets the actor's fixed position and forces its minimum and natural size, in pixels. This means the untransformed actor will have the given geometry. This is the same as calling clutter_actor_set_position() and clutter_actor_set_size().

clutter_actor_get_geometry ()

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