1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterBehaviourRotate</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="deprecated.html" title="Part X. Deprecated Classes">
9 <link rel="prev" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">
10 <link rel="next" href="ClutterBehaviourScale.html" title="ClutterBehaviourScale">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="ClutterBehaviourPath.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="deprecated.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterBehaviourScale.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterBehaviourRotate.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterBehaviourRotate.description" class="shortcut">Description</a>
28 <a href="#ClutterBehaviourRotate.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterBehaviourRotate.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#ClutterBehaviourRotate.properties" class="shortcut">Properties</a>
35 <div class="refentry">
36 <a name="ClutterBehaviourRotate"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="ClutterBehaviourRotate.top_of_page"></a>ClutterBehaviourRotate</span></h2>
40 <p>ClutterBehaviourRotate — A behaviour controlling rotation</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="ClutterBehaviourRotate.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis">enum <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis">ClutterRotateAxis</a>;
47 enum <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection">ClutterRotateDirection</a>;
48 struct <a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate-struct" title="struct ClutterBehaviourRotate">ClutterBehaviourRotate</a>;
49 struct <a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotateClass" title="struct ClutterBehaviourRotateClass">ClutterBehaviourRotateClass</a>;
50 <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-new" title="clutter_behaviour_rotate_new ()">clutter_behaviour_rotate_new</a> (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
51 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>,
52 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>,
53 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_start</code></em>,
54 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_end</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-set-axis" title="clutter_behaviour_rotate_set_axis ()">clutter_behaviour_rotate_set_axis</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
56 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>);
57 <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="returnvalue">ClutterRotateAxis</span></a> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-get-axis" title="clutter_behaviour_rotate_get_axis ()">clutter_behaviour_rotate_get_axis</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>);
58 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-set-direction" title="clutter_behaviour_rotate_set_direction ()">clutter_behaviour_rotate_set_direction</a>
59 (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
60 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>);
61 <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="returnvalue">ClutterRotateDirection</span></a> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-get-direction" title="clutter_behaviour_rotate_get_direction ()">clutter_behaviour_rotate_get_direction</a>
62 (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>);
63 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-set-bounds" title="clutter_behaviour_rotate_set_bounds ()">clutter_behaviour_rotate_set_bounds</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
64 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_start</code></em>,
65 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_end</code></em>);
66 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-get-bounds" title="clutter_behaviour_rotate_get_bounds ()">clutter_behaviour_rotate_get_bounds</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
67 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *angle_start</code></em>,
68 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *angle_end</code></em>);
69 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-set-center" title="clutter_behaviour_rotate_set_center ()">clutter_behaviour_rotate_set_center</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
70 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
71 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
72 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> z</code></em>);
73 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-get-center" title="clutter_behaviour_rotate_get_center ()">clutter_behaviour_rotate_get_center</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
74 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x</code></em>,
75 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y</code></em>,
76 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *z</code></em>);
79 <div class="refsect1">
80 <a name="ClutterBehaviourRotate.object-hierarchy"></a><h2>Object Hierarchy</h2>
81 <pre class="synopsis">
82 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
83 +----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
84 +----ClutterBehaviourRotate
87 <div class="refsect1">
88 <a name="ClutterBehaviourRotate.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
90 ClutterBehaviourRotate implements
91 <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
93 <div class="refsect1">
94 <a name="ClutterBehaviourRotate.properties"></a><h2>Properties</h2>
95 <pre class="synopsis">
96 "<a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate--angle-end" title='The "angle-end" property'>angle-end</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
97 "<a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate--angle-start" title='The "angle-start" property'>angle-start</a>" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
98 "<a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate--axis" title='The "axis" property'>axis</a>" <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> : Read / Write
99 "<a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate--center-x" title='The "center-x" property'>center-x</a>" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
100 "<a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate--center-y" title='The "center-y" property'>center-y</a>" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
101 "<a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate--center-z" title='The "center-z" property'>center-z</a>" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
102 "<a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotate--direction" title='The "direction" property'>direction</a>" <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> : Read / Write
105 <div class="refsect1">
106 <a name="ClutterBehaviourRotate.description"></a><h2>Description</h2>
108 A <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> rotate actors between a starting and ending
109 angle on a given axis.
112 The <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> is available since version 0.4.
115 <div class="refsect1">
116 <a name="ClutterBehaviourRotate.details"></a><h2>Details</h2>
117 <div class="refsect2">
118 <a name="ClutterRotateAxis"></a><h3>enum ClutterRotateAxis</h3>
119 <pre class="programlisting">typedef enum {
120 /*< prefix=CLUTTER >*/
129 <div class="variablelist"><table border="0">
130 <col align="left" valign="top">
133 <td><p><a name="CLUTTER-X-AXIS:CAPS"></a><span class="term"><code class="literal">CLUTTER_X_AXIS</code></span></p></td>
134 <td>Rotate around the X axis
138 <td><p><a name="CLUTTER-Y-AXIS:CAPS"></a><span class="term"><code class="literal">CLUTTER_Y_AXIS</code></span></p></td>
139 <td>Rotate around the Y axis
143 <td><p><a name="CLUTTER-Z-AXIS:CAPS"></a><span class="term"><code class="literal">CLUTTER_Z_AXIS</code></span></p></td>
144 <td>Rotate around the Z axis
149 <p class="since">Since 0.4</p>
152 <div class="refsect2">
153 <a name="ClutterRotateDirection"></a><h3>enum ClutterRotateDirection</h3>
154 <pre class="programlisting">typedef enum {
155 /*< prefix=CLUTTER_ROTATE >*/
158 } ClutterRotateDirection;
161 Direction of a rotation.
163 <div class="variablelist"><table border="0">
164 <col align="left" valign="top">
167 <td><p><a name="CLUTTER-ROTATE-CW:CAPS"></a><span class="term"><code class="literal">CLUTTER_ROTATE_CW</code></span></p></td>
168 <td>Clockwise rotation
172 <td><p><a name="CLUTTER-ROTATE-CCW:CAPS"></a><span class="term"><code class="literal">CLUTTER_ROTATE_CCW</code></span></p></td>
173 <td>Counter-clockwise rotation
178 <p class="since">Since 0.4</p>
181 <div class="refsect2">
182 <a name="ClutterBehaviourRotate-struct"></a><h3>struct ClutterBehaviourRotate</h3>
183 <pre class="programlisting">struct ClutterBehaviourRotate;</pre>
184 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
185 <h3 class="title">Warning</h3>
186 <p><code class="literal">ClutterBehaviourRotate</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="clutter-Implicit-Animations.html#clutter-actor-animate" title="clutter_actor_animate ()"><code class="function">clutter_actor_animate()</code></a> instead.</p>
189 The <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> struct contains only private data and
190 should be accessed using the provided API
192 <p class="since">Since 0.4</p>
195 <div class="refsect2">
196 <a name="ClutterBehaviourRotateClass"></a><h3>struct ClutterBehaviourRotateClass</h3>
197 <pre class="programlisting">struct ClutterBehaviourRotateClass {
200 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
201 <h3 class="title">Warning</h3>
202 <p><code class="literal">ClutterBehaviourRotateClass</code> is deprecated and should not be used in newly-written code. 1.6</p>
205 The <a class="link" href="ClutterBehaviourRotate.html#ClutterBehaviourRotateClass" title="struct ClutterBehaviourRotateClass"><span class="type">ClutterBehaviourRotateClass</span></a> struct contains only private data
207 <p class="since">Since 0.4</p>
210 <div class="refsect2">
211 <a name="clutter-behaviour-rotate-new"></a><h3>clutter_behaviour_rotate_new ()</h3>
212 <pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * clutter_behaviour_rotate_new (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
213 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>,
214 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>,
215 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_start</code></em>,
216 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_end</code></em>);</pre>
218 Creates a new <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>. This behaviour will rotate actors
219 bound to it on <em class="parameter"><code>axis</code></em>, following <em class="parameter"><code>direction</code></em>, between <em class="parameter"><code>angle_start</code></em> and
220 <em class="parameter"><code>angle_end</code></em>. Angles >= 360 degrees will be clamped to the canonical interval
221 <0, 360), if angle_start == angle_end, the behaviour will carry out a
222 single rotation of 360 degrees.
225 If <em class="parameter"><code>alpha</code></em> is not <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
226 of the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance. In the case when <em class="parameter"><code>alpha</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>,
227 it can be set later with <a class="link" href="ClutterBehaviour.html#clutter-behaviour-set-alpha" title="clutter_behaviour_set_alpha ()"><code class="function">clutter_behaviour_set_alpha()</code></a>.
229 <div class="variablelist"><table border="0">
230 <col align="left" valign="top">
233 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
234 <td>a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
238 <td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
239 <td>the rotation axis</td>
242 <td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
243 <td>the rotation direction</td>
246 <td><p><span class="term"><em class="parameter"><code>angle_start</code></em> :</span></p></td>
247 <td>the starting angle in degrees, between 0 and 360.</td>
250 <td><p><span class="term"><em class="parameter"><code>angle_end</code></em> :</span></p></td>
251 <td>the final angle in degrees, between 0 and 360.</td>
254 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
255 <td>the newly created <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>.</td>
259 <p class="since">Since 0.4</p>
262 <div class="refsect2">
263 <a name="clutter-behaviour-rotate-set-axis"></a><h3>clutter_behaviour_rotate_set_axis ()</h3>
264 <pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_rotate_set_axis (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
265 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>);</pre>
267 Sets the axis used by the rotate behaviour.
269 <div class="variablelist"><table border="0">
270 <col align="left" valign="top">
273 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
274 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
278 <td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
279 <td>a <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a>
284 <p class="since">Since 0.4</p>
287 <div class="refsect2">
288 <a name="clutter-behaviour-rotate-get-axis"></a><h3>clutter_behaviour_rotate_get_axis ()</h3>
289 <pre class="programlisting"><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="returnvalue">ClutterRotateAxis</span></a> clutter_behaviour_rotate_get_axis (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>);</pre>
291 Retrieves the <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> used by the rotate behaviour.
293 <div class="variablelist"><table border="0">
294 <col align="left" valign="top">
297 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
298 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
302 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
303 <td>the rotation axis</td>
307 <p class="since">Since 0.4</p>
310 <div class="refsect2">
311 <a name="clutter-behaviour-rotate-set-direction"></a><h3>clutter_behaviour_rotate_set_direction ()</h3>
312 <pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_rotate_set_direction
313 (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
314 <em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>);</pre>
316 Sets the rotation direction used by the rotate behaviour.
318 <div class="variablelist"><table border="0">
319 <col align="left" valign="top">
322 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
323 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
327 <td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
328 <td>the rotation direction</td>
332 <p class="since">Since 0.4</p>
335 <div class="refsect2">
336 <a name="clutter-behaviour-rotate-get-direction"></a><h3>clutter_behaviour_rotate_get_direction ()</h3>
337 <pre class="programlisting"><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="returnvalue">ClutterRotateDirection</span></a> clutter_behaviour_rotate_get_direction
338 (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>);</pre>
340 Retrieves the <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> used by the rotate behaviour.
342 <div class="variablelist"><table border="0">
343 <col align="left" valign="top">
346 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
347 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
351 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
352 <td>the rotation direction</td>
356 <p class="since">Since 0.4</p>
359 <div class="refsect2">
360 <a name="clutter-behaviour-rotate-set-bounds"></a><h3>clutter_behaviour_rotate_set_bounds ()</h3>
361 <pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_rotate_set_bounds (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
362 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_start</code></em>,
363 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> angle_end</code></em>);</pre>
365 Sets the initial and final angles of a rotation behaviour; angles >= 360
366 degrees get clamped to the canonical interval <0, 360).
368 <div class="variablelist"><table border="0">
369 <col align="left" valign="top">
372 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
373 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
377 <td><p><span class="term"><em class="parameter"><code>angle_start</code></em> :</span></p></td>
378 <td>initial angle in degrees, between 0 and 360.</td>
381 <td><p><span class="term"><em class="parameter"><code>angle_end</code></em> :</span></p></td>
382 <td>final angle in degrees, between 0 and 360.</td>
386 <p class="since">Since 0.4</p>
389 <div class="refsect2">
390 <a name="clutter-behaviour-rotate-get-bounds"></a><h3>clutter_behaviour_rotate_get_bounds ()</h3>
391 <pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_rotate_get_bounds (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
392 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *angle_start</code></em>,
393 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *angle_end</code></em>);</pre>
395 Retrieves the rotation boundaries of the rotate behaviour.
397 <div class="variablelist"><table border="0">
398 <col align="left" valign="top">
401 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
402 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
406 <td><p><span class="term"><em class="parameter"><code>angle_start</code></em> :</span></p></td>
407 <td>return value for the initial angle. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
411 <td><p><span class="term"><em class="parameter"><code>angle_end</code></em> :</span></p></td>
412 <td>return value for the final angle. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
417 <p class="since">Since 0.4</p>
420 <div class="refsect2">
421 <a name="clutter-behaviour-rotate-set-center"></a><h3>clutter_behaviour_rotate_set_center ()</h3>
422 <pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_rotate_set_center (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
423 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
424 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
425 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> z</code></em>);</pre>
427 Sets the center of rotation. The coordinates are relative to the plane
428 normal to the rotation axis set with <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-set-axis" title="clutter_behaviour_rotate_set_axis ()"><code class="function">clutter_behaviour_rotate_set_axis()</code></a>.
430 <div class="variablelist"><table border="0">
431 <col align="left" valign="top">
434 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
435 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
439 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
440 <td>X axis center of rotation</td>
443 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
444 <td>Y axis center of rotation</td>
447 <td><p><span class="term"><em class="parameter"><code>z</code></em> :</span></p></td>
448 <td>Z axis center of rotation</td>
452 <p class="since">Since 0.4</p>
455 <div class="refsect2">
456 <a name="clutter-behaviour-rotate-get-center"></a><h3>clutter_behaviour_rotate_get_center ()</h3>
457 <pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_rotate_get_center (<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a> *rotate</code></em>,
458 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x</code></em>,
459 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y</code></em>,
460 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *z</code></em>);</pre>
462 Retrieves the center of rotation set using
463 <a class="link" href="ClutterBehaviourRotate.html#clutter-behaviour-rotate-set-center" title="clutter_behaviour_rotate_set_center ()"><code class="function">clutter_behaviour_rotate_set_center()</code></a>.
465 <div class="variablelist"><table border="0">
466 <col align="left" valign="top">
469 <td><p><span class="term"><em class="parameter"><code>rotate</code></em> :</span></p></td>
470 <td>a <a class="link" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate"><span class="type">ClutterBehaviourRotate</span></a>
474 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
475 <td>return location for the X center of rotation. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
479 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
480 <td>return location for the Y center of rotation. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
484 <td><p><span class="term"><em class="parameter"><code>z</code></em> :</span></p></td>
485 <td>return location for the Z center of rotation. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
490 <p class="since">Since 0.4</p>
493 <div class="refsect1">
494 <a name="ClutterBehaviourRotate.property-details"></a><h2>Property Details</h2>
495 <div class="refsect2">
496 <a name="ClutterBehaviourRotate--angle-end"></a><h3>The <code class="literal">"angle-end"</code> property</h3>
497 <pre class="programlisting"> "angle-end" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
499 The final angle to where the rotation should end.
501 <p>Allowed values: [0,360]</p>
502 <p>Default value: 0</p>
503 <p class="since">Since 0.4</p>
506 <div class="refsect2">
507 <a name="ClutterBehaviourRotate--angle-start"></a><h3>The <code class="literal">"angle-start"</code> property</h3>
508 <pre class="programlisting"> "angle-start" <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
510 The initial angle from whence the rotation should start.
512 <p>Allowed values: [0,360]</p>
513 <p>Default value: 0</p>
514 <p class="since">Since 0.4</p>
517 <div class="refsect2">
518 <a name="ClutterBehaviourRotate--axis"></a><h3>The <code class="literal">"axis"</code> property</h3>
519 <pre class="programlisting"> "axis" <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> : Read / Write</pre>
521 The axis of rotation.
523 <p>Default value: CLUTTER_Z_AXIS</p>
524 <p class="since">Since 0.4</p>
527 <div class="refsect2">
528 <a name="ClutterBehaviourRotate--center-x"></a><h3>The <code class="literal">"center-x"</code> property</h3>
529 <pre class="programlisting"> "center-x" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
531 The x center of rotation.
533 <p>Allowed values: >= -2147483647</p>
534 <p>Default value: 0</p>
535 <p class="since">Since 0.4</p>
538 <div class="refsect2">
539 <a name="ClutterBehaviourRotate--center-y"></a><h3>The <code class="literal">"center-y"</code> property</h3>
540 <pre class="programlisting"> "center-y" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
542 The y center of rotation.
544 <p>Allowed values: >= -2147483647</p>
545 <p>Default value: 0</p>
546 <p class="since">Since 0.4</p>
549 <div class="refsect2">
550 <a name="ClutterBehaviourRotate--center-z"></a><h3>The <code class="literal">"center-z"</code> property</h3>
551 <pre class="programlisting"> "center-z" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
553 The z center of rotation.
555 <p>Allowed values: >= -2147483647</p>
556 <p>Default value: 0</p>
557 <p class="since">Since 0.4</p>
560 <div class="refsect2">
561 <a name="ClutterBehaviourRotate--direction"></a><h3>The <code class="literal">"direction"</code> property</h3>
562 <pre class="programlisting"> "direction" <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> : Read / Write</pre>
564 The direction of the rotation.
566 <p>Default value: CLUTTER_ROTATE_CW</p>
567 <p class="since">Since 0.4</p>
573 Generated by GTK-Doc V1.18.1</div>