ClutterGroup

ClutterGroup — Actor class containing multiple children. actors.

Synopsis




ClutterActor*       clutter_group_new                   (void);
void                clutter_group_add                   (ClutterGroup *group,
                                                         ClutterActor *actor);
void                clutter_group_add_many              (ClutterGroup *group,
                                                         ClutterActor *first_actor,
                                                         ...);
void                clutter_group_add_many_valist       (ClutterGroup *group,
                                                         ClutterActor *first_actor,
                                                         va_list var_args);
void                clutter_group_remove                (ClutterGroup *group,
                                                         ClutterActor *actor);
void                clutter_group_remove_all            (ClutterGroup *group);
gint                clutter_group_get_n_children        (ClutterGroup *self);
ClutterActor*       clutter_group_get_nth_child         (ClutterGroup *self,
                                                         gint index_);
ClutterActor*       clutter_group_find_child_by_id      (ClutterGroup *self,
                                                         guint id);
void                clutter_group_raise                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);
void                clutter_group_lower                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);
void                clutter_group_sort_depth_order      (ClutterGroup *self);


Description

A ClutterGroup is an Actor which contains multiple child actors positioned relative to the ClutterGroup position. Other operations such as scaling, rotating and clipping of the group will child actors.

A ClutterGroup's size is defined by the size and position of it it children. Resize requests via parent ClutterActor API will be ignored.

Details

clutter_group_new ()

ClutterActor*       clutter_group_new                   (void);

Create a new ClutterGroup instance.

Returns : a new ClutterGroup

clutter_group_add ()

void                clutter_group_add                   (ClutterGroup *group,
                                                         ClutterActor *actor);

Adds a new child ClutterActor to the ClutterGroup.

Deprecated: 0.4: This function is obsolete, use clutter_container_add_actor() instead.

group : A ClutterGroup
actor : A ClutterActor

clutter_group_add_many ()

void                clutter_group_add_many              (ClutterGroup *group,
                                                         ClutterActor *first_actor,
                                                         ...);

Adds a NULL-terminated list of actors to a group. This function is equivalent to calling clutter_group_add() for each member of the list.

Deprecated: 0.4: This function is obsolete, use clutter_container_add() instead.

group : A ClutterGroup
first_actor : the ClutterActor actor to add to the group
... : additional actors to add to the group

clutter_group_add_many_valist ()

void                clutter_group_add_many_valist       (ClutterGroup *group,
                                                         ClutterActor *first_actor,
                                                         va_list var_args);

Similar to clutter_group_add_many() but using a va_list. Use this function inside bindings.

Deprecated: 0.4: This function is obsolete, use clutter_container_add_valist() instead.

group : a ClutterGroup
first_actor : the ClutterActor actor to add to the group
var_args : the actors to be added

clutter_group_remove ()

void                clutter_group_remove                (ClutterGroup *group,
                                                         ClutterActor *actor);

Removes a child ClutterActor from the parent ClutterGroup.

Deprecated: 0.4: This function is obsolete, use clutter_container_remove_actor() instead.

group : A ClutterGroup
actor : A ClutterActor

clutter_group_remove_all ()

void                clutter_group_remove_all            (ClutterGroup *group);

Removes all children actors from the ClutterGroup.

group : A ClutterGroup

clutter_group_get_n_children ()

gint                clutter_group_get_n_children        (ClutterGroup *self);

Gets the number of actors held in the group.

self : A ClutterGroup
Returns : The number of child actors held in the group.

Since 0.2


clutter_group_get_nth_child ()

ClutterActor*       clutter_group_get_nth_child         (ClutterGroup *self,
                                                         gint index_);

Gets a groups child held at index_ in stack.

self : A ClutterGroup
index_ : the position of the requested actor.
Returns : A Clutter actor or NULL if index_ is invalid.

Since 0.2


clutter_group_find_child_by_id ()

ClutterActor*       clutter_group_find_child_by_id      (ClutterGroup *self,
                                                         guint id);

Finds a child actor of a group by its unique ID. Search recurses into any child groups.

self : A ClutterGroup
id : A unique Clutteractor ID
Returns : the ClutterActor if found, or NULL.

clutter_group_raise ()

void                clutter_group_raise                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);

FIXME

self : a ClutterGroup
actor : a ClutterActor
sibling : a ClutterActor

clutter_group_lower ()

void                clutter_group_lower                 (ClutterGroup *self,
                                                         ClutterActor *actor,
                                                         ClutterActor *sibling);

FIXME

self : a ClutterGroup
actor : a ClutterActor
sibling : a ClutterActor

clutter_group_sort_depth_order ()

void                clutter_group_sort_depth_order      (ClutterGroup *self);

Sorts a ClutterGroup's children by there depth value. This function should not be used by applications.

self : A ClutterGroup