2006-11-17 18:45:31 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
ClutterBehaviour
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### STRUCT ClutterBehaviour ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### ARG ClutterBehaviour:alpha ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### STRUCT ClutterBehaviourClass ##### -->
|
|
|
|
<para>
|
2006-12-13 18:11:50 +00:00
|
|
|
Class structure.
|
2006-11-17 18:45:31 +00:00
|
|
|
</para>
|
|
|
|
|
2006-12-13 18:11:50 +00:00
|
|
|
@parent_class: parent class
|
|
|
|
@alpha_notify: Override this virtual function when creating a new behaviour.
|
|
|
|
The alpha notify virtual function is called each time the alpha value
|
|
|
|
computed by the #ClutterAlpha object changes; in this virtual function
|
|
|
|
you should update the properties driven by your behaviour for all the
|
|
|
|
actors to which the behaviour applies.
|
2006-11-17 18:45:31 +00:00
|
|
|
@_clutter_behaviour1:
|
|
|
|
@_clutter_behaviour2:
|
|
|
|
@_clutter_behaviour3:
|
|
|
|
@_clutter_behaviour4:
|
|
|
|
@_clutter_behaviour5:
|
|
|
|
@_clutter_behaviour6:
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION clutter_behaviour_apply ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@actor:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION clutter_behaviour_remove ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@actor:
|
|
|
|
|
|
|
|
|
2007-05-17 12:03:43 +00:00
|
|
|
<!-- ##### FUNCTION clutter_behaviour_is_applied ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@actor:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2006-12-08 16:12:52 +00:00
|
|
|
<!-- ##### USER_FUNCTION ClutterBehaviourForeachFunc ##### -->
|
|
|
|
<para>
|
2006-12-13 18:11:50 +00:00
|
|
|
The function used to iterate on every #ClutterActor to which a behaviour
|
|
|
|
applies.
|
2006-12-08 16:12:52 +00:00
|
|
|
</para>
|
|
|
|
|
2006-12-13 18:11:50 +00:00
|
|
|
@behaviour: a #ClutterBehaviour
|
|
|
|
@actor: a #ClutterActor
|
|
|
|
@data: optional user data passed to this function
|
2006-12-08 16:12:52 +00:00
|
|
|
|
|
|
|
|
2006-11-17 18:45:31 +00:00
|
|
|
<!-- ##### FUNCTION clutter_behaviour_actors_foreach ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@func:
|
|
|
|
@data:
|
|
|
|
|
|
|
|
|
2006-12-08 16:12:52 +00:00
|
|
|
<!-- ##### FUNCTION clutter_behaviour_get_actors ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2007-01-16 14:37:54 +00:00
|
|
|
<!-- ##### FUNCTION clutter_behaviour_get_n_actors ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION clutter_behaviour_get_nth_actor ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
2007-01-18 12:36:43 +00:00
|
|
|
@index:
|
2007-01-16 14:37:54 +00:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2006-11-17 18:45:31 +00:00
|
|
|
<!-- ##### FUNCTION clutter_behaviour_get_alpha ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION clutter_behaviour_set_alpha ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@behave:
|
|
|
|
@alpha:
|
|
|
|
|
|
|
|
|