39
32
<h2><span class="refentrytitle"><a name="ClutterBehaviourEllipse.top_of_page"></a>ClutterBehaviourEllipse</span></h2>
40
33
<p>ClutterBehaviourEllipse — A behaviour interpolating position along an ellipse</p>
42
<td valign="top" align="right"></td>
35
<td class="gallery_image" valign="top" align="right"></td>
43
36
</tr></table></div>
44
<div class="refsynopsisdiv">
45
<a name="ClutterBehaviourEllipse.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis">struct <a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse-struct" title="struct ClutterBehaviourEllipse">ClutterBehaviourEllipse</a>;
47
struct <a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipseClass" title="struct ClutterBehaviourEllipseClass">ClutterBehaviourEllipseClass</a>;
48
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-new" title="clutter_behaviour_ellipse_new ()">clutter_behaviour_ellipse_new</a> (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
49
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
50
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
51
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
52
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
53
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>,
54
<em class="parameter"><code><span class="type">gdouble</span> start</code></em>,
55
<em class="parameter"><code><span class="type">gdouble</span> end</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-center" title="clutter_behaviour_ellipse_set_center ()">clutter_behaviour_ellipse_set_center</a>
57
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
58
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
59
<em class="parameter"><code><span class="type">gint</span> y</code></em>);
60
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-center" title="clutter_behaviour_ellipse_get_center ()">clutter_behaviour_ellipse_get_center</a>
61
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
62
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
63
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);
64
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-angle-start" title="clutter_behaviour_ellipse_set_angle_start ()">clutter_behaviour_ellipse_set_angle_start</a>
65
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
66
<em class="parameter"><code><span class="type">gdouble</span> angle_start</code></em>);
67
<span class="returnvalue">gdouble</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-angle-start" title="clutter_behaviour_ellipse_get_angle_start ()">clutter_behaviour_ellipse_get_angle_start</a>
68
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);
69
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-angle-end" title="clutter_behaviour_ellipse_set_angle_end ()">clutter_behaviour_ellipse_set_angle_end</a>
70
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
71
<em class="parameter"><code><span class="type">gdouble</span> angle_end</code></em>);
72
<span class="returnvalue">gdouble</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-angle-end" title="clutter_behaviour_ellipse_get_angle_end ()">clutter_behaviour_ellipse_get_angle_end</a>
73
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);
74
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-angle-tilt" title="clutter_behaviour_ellipse_set_angle_tilt ()">clutter_behaviour_ellipse_set_angle_tilt</a>
75
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
76
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>,
77
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt</code></em>);
78
<span class="returnvalue">gdouble</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-angle-tilt" title="clutter_behaviour_ellipse_get_angle_tilt ()">clutter_behaviour_ellipse_get_angle_tilt</a>
79
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
80
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>);
81
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-height" title="clutter_behaviour_ellipse_set_height ()">clutter_behaviour_ellipse_set_height</a>
82
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
83
<em class="parameter"><code><span class="type">gint</span> height</code></em>);
84
<span class="returnvalue">gint</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-height" title="clutter_behaviour_ellipse_get_height ()">clutter_behaviour_ellipse_get_height</a>
85
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);
86
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-width" title="clutter_behaviour_ellipse_set_width ()">clutter_behaviour_ellipse_set_width</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
87
<em class="parameter"><code><span class="type">gint</span> width</code></em>);
88
<span class="returnvalue">gint</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-width" title="clutter_behaviour_ellipse_get_width ()">clutter_behaviour_ellipse_get_width</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);
89
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-tilt" title="clutter_behaviour_ellipse_set_tilt ()">clutter_behaviour_ellipse_set_tilt</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
90
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_x</code></em>,
91
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_y</code></em>,
92
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_z</code></em>);
93
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-tilt" title="clutter_behaviour_ellipse_get_tilt ()">clutter_behaviour_ellipse_get_tilt</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
94
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_x</code></em>,
95
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_y</code></em>,
96
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_z</code></em>);
97
<span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-direction" title="clutter_behaviour_ellipse_set_direction ()">clutter_behaviour_ellipse_set_direction</a>
98
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
99
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>);
100
<a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="returnvalue">ClutterRotateDirection</span></a> <a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-direction" title="clutter_behaviour_ellipse_get_direction ()">clutter_behaviour_ellipse_get_direction</a>
101
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);
37
<div class="refsect1">
38
<a name="ClutterBehaviourEllipse.functions"></a><h2>Functions</h2>
39
<div class="informaltable"><table width="100%" border="0">
41
<col width="150px" class="functions_return">
42
<col class="functions_name">
46
<td class="function_type">
47
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
49
<td class="function_name">
50
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-new" title="clutter_behaviour_ellipse_new ()">clutter_behaviour_ellipse_new</a> <span class="c_punctuation">()</span>
54
<td class="function_type">
55
<span class="returnvalue">void</span>
57
<td class="function_name">
58
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-center" title="clutter_behaviour_ellipse_set_center ()">clutter_behaviour_ellipse_set_center</a> <span class="c_punctuation">()</span>
62
<td class="function_type">
63
<span class="returnvalue">void</span>
65
<td class="function_name">
66
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-center" title="clutter_behaviour_ellipse_get_center ()">clutter_behaviour_ellipse_get_center</a> <span class="c_punctuation">()</span>
70
<td class="function_type">
71
<span class="returnvalue">void</span>
73
<td class="function_name">
74
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-angle-start" title="clutter_behaviour_ellipse_set_angle_start ()">clutter_behaviour_ellipse_set_angle_start</a> <span class="c_punctuation">()</span>
78
<td class="function_type">
79
<span class="returnvalue">gdouble</span>
81
<td class="function_name">
82
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-angle-start" title="clutter_behaviour_ellipse_get_angle_start ()">clutter_behaviour_ellipse_get_angle_start</a> <span class="c_punctuation">()</span>
86
<td class="function_type">
87
<span class="returnvalue">void</span>
89
<td class="function_name">
90
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-angle-end" title="clutter_behaviour_ellipse_set_angle_end ()">clutter_behaviour_ellipse_set_angle_end</a> <span class="c_punctuation">()</span>
94
<td class="function_type">
95
<span class="returnvalue">gdouble</span>
97
<td class="function_name">
98
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-angle-end" title="clutter_behaviour_ellipse_get_angle_end ()">clutter_behaviour_ellipse_get_angle_end</a> <span class="c_punctuation">()</span>
102
<td class="function_type">
103
<span class="returnvalue">void</span>
105
<td class="function_name">
106
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-angle-tilt" title="clutter_behaviour_ellipse_set_angle_tilt ()">clutter_behaviour_ellipse_set_angle_tilt</a> <span class="c_punctuation">()</span>
110
<td class="function_type">
111
<span class="returnvalue">gdouble</span>
113
<td class="function_name">
114
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-angle-tilt" title="clutter_behaviour_ellipse_get_angle_tilt ()">clutter_behaviour_ellipse_get_angle_tilt</a> <span class="c_punctuation">()</span>
118
<td class="function_type">
119
<span class="returnvalue">void</span>
121
<td class="function_name">
122
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-height" title="clutter_behaviour_ellipse_set_height ()">clutter_behaviour_ellipse_set_height</a> <span class="c_punctuation">()</span>
126
<td class="function_type">
127
<span class="returnvalue">gint</span>
129
<td class="function_name">
130
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-height" title="clutter_behaviour_ellipse_get_height ()">clutter_behaviour_ellipse_get_height</a> <span class="c_punctuation">()</span>
134
<td class="function_type">
135
<span class="returnvalue">void</span>
137
<td class="function_name">
138
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-width" title="clutter_behaviour_ellipse_set_width ()">clutter_behaviour_ellipse_set_width</a> <span class="c_punctuation">()</span>
142
<td class="function_type">
143
<span class="returnvalue">gint</span>
145
<td class="function_name">
146
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-width" title="clutter_behaviour_ellipse_get_width ()">clutter_behaviour_ellipse_get_width</a> <span class="c_punctuation">()</span>
150
<td class="function_type">
151
<span class="returnvalue">void</span>
153
<td class="function_name">
154
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-tilt" title="clutter_behaviour_ellipse_set_tilt ()">clutter_behaviour_ellipse_set_tilt</a> <span class="c_punctuation">()</span>
158
<td class="function_type">
159
<span class="returnvalue">void</span>
161
<td class="function_name">
162
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-tilt" title="clutter_behaviour_ellipse_get_tilt ()">clutter_behaviour_ellipse_get_tilt</a> <span class="c_punctuation">()</span>
166
<td class="function_type">
167
<span class="returnvalue">void</span>
169
<td class="function_name">
170
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-set-direction" title="clutter_behaviour_ellipse_set_direction ()">clutter_behaviour_ellipse_set_direction</a> <span class="c_punctuation">()</span>
174
<td class="function_type">
175
<a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="returnvalue">ClutterRotateDirection</span></a>
177
<td class="function_name">
178
<a class="link" href="ClutterBehaviourEllipse.html#clutter-behaviour-ellipse-get-direction" title="clutter_behaviour_ellipse_get_direction ()">clutter_behaviour_ellipse_get_direction</a> <span class="c_punctuation">()</span>
184
<div class="refsect1">
185
<a name="ClutterBehaviourEllipse.properties"></a><h2>Properties</h2>
186
<div class="informaltable"><table border="0">
188
<col width="150px" class="properties_type">
189
<col width="300px" class="properties_name">
190
<col width="200px" class="properties_flags">
194
<td class="property_type"><span class="type">gdouble</span></td>
195
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-end" title="The “angle-end” property">angle-end</a></td>
196
<td class="property_flags">Read / Write</td>
199
<td class="property_type"><span class="type">gdouble</span></td>
200
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-start" title="The “angle-start” property">angle-start</a></td>
201
<td class="property_flags">Read / Write</td>
204
<td class="property_type"><span class="type">gdouble</span></td>
205
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-tilt-x" title="The “angle-tilt-x” property">angle-tilt-x</a></td>
206
<td class="property_flags">Read / Write</td>
209
<td class="property_type"><span class="type">gdouble</span></td>
210
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-tilt-y" title="The “angle-tilt-y” property">angle-tilt-y</a></td>
211
<td class="property_flags">Read / Write</td>
214
<td class="property_type"><span class="type">gdouble</span></td>
215
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-tilt-z" title="The “angle-tilt-z” property">angle-tilt-z</a></td>
216
<td class="property_flags">Read / Write</td>
219
<td class="property_type">
220
<a class="link" href="clutter-Base-geometric-types.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *</td>
221
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--center" title="The “center” property">center</a></td>
222
<td class="property_flags">Read / Write</td>
225
<td class="property_type"><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a></td>
226
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--direction" title="The “direction” property">direction</a></td>
227
<td class="property_flags">Read / Write</td>
230
<td class="property_type"><span class="type">gint</span></td>
231
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--height" title="The “height” property">height</a></td>
232
<td class="property_flags">Read / Write</td>
235
<td class="property_type"><span class="type">gint</span></td>
236
<td class="property_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--width" title="The “width” property">width</a></td>
237
<td class="property_flags">Read / Write</td>
242
<div class="refsect1">
243
<a name="ClutterBehaviourEllipse.other"></a><h2>Types and Values</h2>
244
<div class="informaltable"><table width="100%" border="0">
246
<col width="150px" class="name">
247
<col class="description">
251
<td class="datatype_keyword">struct</td>
252
<td class="function_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse-struct" title="struct ClutterBehaviourEllipse">ClutterBehaviourEllipse</a></td>
255
<td class="datatype_keyword">struct</td>
256
<td class="function_name"><a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipseClass" title="struct ClutterBehaviourEllipseClass">ClutterBehaviourEllipseClass</a></td>
104
261
<div class="refsect1">
105
262
<a name="ClutterBehaviourEllipse.object-hierarchy"></a><h2>Object Hierarchy</h2>
106
<pre class="synopsis">
108
+----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
109
+----ClutterBehaviourEllipse
263
<pre class="screen"> GObject
264
<span class="lineart">╰──</span> <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
265
<span class="lineart">╰──</span> ClutterBehaviourEllipse
112
268
<div class="refsect1">
116
272
<a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
118
274
<div class="refsect1">
119
<a name="ClutterBehaviourEllipse.properties"></a><h2>Properties</h2>
120
<pre class="synopsis">
121
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-end" title='The "angle-end" property'>angle-end</a>" <span class="type">gdouble</span> : Read / Write
122
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-start" title='The "angle-start" property'>angle-start</a>" <span class="type">gdouble</span> : Read / Write
123
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-tilt-x" title='The "angle-tilt-x" property'>angle-tilt-x</a>" <span class="type">gdouble</span> : Read / Write
124
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-tilt-y" title='The "angle-tilt-y" property'>angle-tilt-y</a>" <span class="type">gdouble</span> : Read / Write
125
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--angle-tilt-z" title='The "angle-tilt-z" property'>angle-tilt-z</a>" <span class="type">gdouble</span> : Read / Write
126
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--center" title='The "center" property'>center</a>" <a class="link" href="clutter-Base-geometric-types.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a>* : Read / Write
127
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--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
128
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--height" title='The "height" property'>height</a>" <span class="type">gint</span> : Read / Write
129
"<a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipse--width" title='The "width" property'>width</a>" <span class="type">gint</span> : Read / Write
132
<div class="refsect1">
133
275
<a name="ClutterBehaviourEllipse.description"></a><h2>Description</h2>
135
<a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> interpolates actors along a path defined by
140
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
141
<h3 class="title">Note</h3>
276
<p><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> interpolates actors along a path defined by
142
278
<p>When applying an ellipse behaviour to an actor, the
143
279
behaviour will update the actor's position and depth and set them
144
280
to what is dictated by the ellipses initial position.</p>
149
<div class="refsect1">
150
<a name="ClutterBehaviourEllipse.details"></a><h2>Details</h2>
282
<div class="refsect1">
283
<a name="ClutterBehaviourEllipse.functions_details"></a><h2>Functions</h2>
284
<div class="refsect2">
285
<a name="clutter-behaviour-ellipse-new"></a><h3>clutter_behaviour_ellipse_new ()</h3>
286
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
287
clutter_behaviour_ellipse_new (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
288
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
289
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
290
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
291
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
292
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>,
293
<em class="parameter"><code><span class="type">gdouble</span> start</code></em>,
294
<em class="parameter"><code><span class="type">gdouble</span> end</code></em>);</pre>
295
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_new</code> is deprecated and should not be used in newly-written code.</p></div>
296
<p>Creates a behaviour that drives actors along an elliptical path with
297
given center, width and height; the movement starts at <em class="parameter"><code>start</code></em>
299
degrees (with 0 corresponding to 12 o'clock) and ends at <em class="parameter"><code>end</code></em>
301
degrees. Angles greated than 360 degrees get clamped to the canonical
302
interval <0, 360); if <em class="parameter"><code>start</code></em>
303
is equal to <em class="parameter"><code>end</code></em>
305
rotate by exacly 360 degrees.</p>
306
<p>If <em class="parameter"><code>alpha</code></em>
307
is not <code class="literal">NULL</code>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
308
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>
309
is <code class="literal">NULL</code>,
310
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>.</p>
311
<div class="refsect3">
312
<a name="id-1.10.7.9.2.8"></a><h4>Parameters</h4>
313
<div class="informaltable"><table width="100%" border="0">
315
<col width="150px" class="parameters_name">
316
<col class="parameters_description">
317
<col width="200px" class="parameters_annotations">
321
<td class="parameter_name"><p>alpha</p></td>
322
<td class="parameter_description"><p> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>. </p></td>
323
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
326
<td class="parameter_name"><p>x</p></td>
327
<td class="parameter_description"><p>x coordinace of the center</p></td>
328
<td class="parameter_annotations"> </td>
331
<td class="parameter_name"><p>y</p></td>
332
<td class="parameter_description"><p>y coordiance of the center</p></td>
333
<td class="parameter_annotations"> </td>
336
<td class="parameter_name"><p>width</p></td>
337
<td class="parameter_description"><p>width of the ellipse</p></td>
338
<td class="parameter_annotations"> </td>
341
<td class="parameter_name"><p>height</p></td>
342
<td class="parameter_description"><p>height of the ellipse</p></td>
343
<td class="parameter_annotations"> </td>
346
<td class="parameter_name"><p>direction</p></td>
347
<td class="parameter_description"><p><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> of rotation</p></td>
348
<td class="parameter_annotations"> </td>
351
<td class="parameter_name"><p>start</p></td>
352
<td class="parameter_description"><p>angle in degrees at which movement starts, between 0 and 360</p></td>
353
<td class="parameter_annotations"> </td>
356
<td class="parameter_name"><p>end</p></td>
357
<td class="parameter_description"><p>angle in degrees at which movement ends, between 0 and 360</p></td>
358
<td class="parameter_annotations"> </td>
363
<div class="refsect3">
364
<a name="id-1.10.7.9.2.9"></a><h4>Returns</h4>
365
<p> the newly created <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p>
368
<p class="since">Since 0.4</p>
371
<div class="refsect2">
372
<a name="clutter-behaviour-ellipse-set-center"></a><h3>clutter_behaviour_ellipse_set_center ()</h3>
373
<pre class="programlisting"><span class="returnvalue">void</span>
374
clutter_behaviour_ellipse_set_center (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
375
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
376
<em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre>
377
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_center</code> is deprecated and should not be used in newly-written code.</p></div>
378
<p>Sets the center of the elliptical path to the point represented by knot.</p>
379
<div class="refsect3">
380
<a name="id-1.10.7.9.3.7"></a><h4>Parameters</h4>
381
<div class="informaltable"><table width="100%" border="0">
383
<col width="150px" class="parameters_name">
384
<col class="parameters_description">
385
<col width="200px" class="parameters_annotations">
389
<td class="parameter_name"><p>self</p></td>
390
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
391
<td class="parameter_annotations"> </td>
394
<td class="parameter_name"><p>x</p></td>
395
<td class="parameter_description"><p>x coordinace of centre</p></td>
396
<td class="parameter_annotations"> </td>
399
<td class="parameter_name"><p>y</p></td>
400
<td class="parameter_description"><p>y coordinace of centre</p></td>
401
<td class="parameter_annotations"> </td>
406
<p class="since">Since 0.4</p>
409
<div class="refsect2">
410
<a name="clutter-behaviour-ellipse-get-center"></a><h3>clutter_behaviour_ellipse_get_center ()</h3>
411
<pre class="programlisting"><span class="returnvalue">void</span>
412
clutter_behaviour_ellipse_get_center (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
413
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
414
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
415
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_center</code> is deprecated and should not be used in newly-written code.</p></div>
416
<p>Gets the center of the elliptical path path.</p>
417
<div class="refsect3">
418
<a name="id-1.10.7.9.4.7"></a><h4>Parameters</h4>
419
<div class="informaltable"><table width="100%" border="0">
421
<col width="150px" class="parameters_name">
422
<col class="parameters_description">
423
<col width="200px" class="parameters_annotations">
427
<td class="parameter_name"><p>self</p></td>
428
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
429
<td class="parameter_annotations"> </td>
432
<td class="parameter_name"><p>x</p></td>
433
<td class="parameter_description"><p> return location for the X coordinate of the center, or <code class="literal">NULL</code>. </p></td>
434
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
437
<td class="parameter_name"><p>y</p></td>
438
<td class="parameter_description"><p> return location for the Y coordinate of the center, or <code class="literal">NULL</code>. </p></td>
439
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
444
<p class="since">Since 0.4</p>
447
<div class="refsect2">
448
<a name="clutter-behaviour-ellipse-set-angle-start"></a><h3>clutter_behaviour_ellipse_set_angle_start ()</h3>
449
<pre class="programlisting"><span class="returnvalue">void</span>
450
clutter_behaviour_ellipse_set_angle_start
451
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
452
<em class="parameter"><code><span class="type">gdouble</span> angle_start</code></em>);</pre>
453
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_angle_start</code> is deprecated and should not be used in newly-written code.</p></div>
454
<p>Sets the angle at which movement starts; angles >= 360 degress get clamped
455
to the canonical interval <0, 360).</p>
456
<div class="refsect3">
457
<a name="id-1.10.7.9.5.7"></a><h4>Parameters</h4>
458
<div class="informaltable"><table width="100%" border="0">
460
<col width="150px" class="parameters_name">
461
<col class="parameters_description">
462
<col width="200px" class="parameters_annotations">
466
<td class="parameter_name"><p>self</p></td>
467
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
468
<td class="parameter_annotations"> </td>
471
<td class="parameter_name"><p>angle_start</p></td>
472
<td class="parameter_description"><p>angle at which movement starts in degrees, between 0 and 360.</p></td>
473
<td class="parameter_annotations"> </td>
478
<p class="since">Since 0.6</p>
481
<div class="refsect2">
482
<a name="clutter-behaviour-ellipse-get-angle-start"></a><h3>clutter_behaviour_ellipse_get_angle_start ()</h3>
483
<pre class="programlisting"><span class="returnvalue">gdouble</span>
484
clutter_behaviour_ellipse_get_angle_start
485
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
486
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_angle_start</code> is deprecated and should not be used in newly-written code.</p></div>
487
<p>Gets the angle at which movements starts.</p>
488
<div class="refsect3">
489
<a name="id-1.10.7.9.6.7"></a><h4>Parameters</h4>
490
<div class="informaltable"><table width="100%" border="0">
492
<col width="150px" class="parameters_name">
493
<col class="parameters_description">
494
<col width="200px" class="parameters_annotations">
497
<td class="parameter_name"><p>self</p></td>
498
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
499
<td class="parameter_annotations"> </td>
503
<div class="refsect3">
504
<a name="id-1.10.7.9.6.8"></a><h4>Returns</h4>
505
<p> angle in degrees</p>
508
<p class="since">Since 0.6</p>
511
<div class="refsect2">
512
<a name="clutter-behaviour-ellipse-set-angle-end"></a><h3>clutter_behaviour_ellipse_set_angle_end ()</h3>
513
<pre class="programlisting"><span class="returnvalue">void</span>
514
clutter_behaviour_ellipse_set_angle_end
515
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
516
<em class="parameter"><code><span class="type">gdouble</span> angle_end</code></em>);</pre>
517
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_angle_end</code> is deprecated and should not be used in newly-written code.</p></div>
518
<p>Sets the angle at which movement ends; angles >= 360 degress get clamped
519
to the canonical interval <0, 360).</p>
520
<div class="refsect3">
521
<a name="id-1.10.7.9.7.7"></a><h4>Parameters</h4>
522
<div class="informaltable"><table width="100%" border="0">
524
<col width="150px" class="parameters_name">
525
<col class="parameters_description">
526
<col width="200px" class="parameters_annotations">
530
<td class="parameter_name"><p>self</p></td>
531
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
532
<td class="parameter_annotations"> </td>
535
<td class="parameter_name"><p>angle_end</p></td>
536
<td class="parameter_description"><p>angle at which movement ends in degrees, between 0 and 360.</p></td>
537
<td class="parameter_annotations"> </td>
542
<p class="since">Since 0.4</p>
545
<div class="refsect2">
546
<a name="clutter-behaviour-ellipse-get-angle-end"></a><h3>clutter_behaviour_ellipse_get_angle_end ()</h3>
547
<pre class="programlisting"><span class="returnvalue">gdouble</span>
548
clutter_behaviour_ellipse_get_angle_end
549
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
550
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_angle_end</code> is deprecated and should not be used in newly-written code.</p></div>
551
<p>Gets the at which movements ends.</p>
552
<div class="refsect3">
553
<a name="id-1.10.7.9.8.7"></a><h4>Parameters</h4>
554
<div class="informaltable"><table width="100%" border="0">
556
<col width="150px" class="parameters_name">
557
<col class="parameters_description">
558
<col width="200px" class="parameters_annotations">
561
<td class="parameter_name"><p>self</p></td>
562
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
563
<td class="parameter_annotations"> </td>
567
<div class="refsect3">
568
<a name="id-1.10.7.9.8.8"></a><h4>Returns</h4>
569
<p> angle in degrees</p>
572
<p class="since">Since 0.4</p>
575
<div class="refsect2">
576
<a name="clutter-behaviour-ellipse-set-angle-tilt"></a><h3>clutter_behaviour_ellipse_set_angle_tilt ()</h3>
577
<pre class="programlisting"><span class="returnvalue">void</span>
578
clutter_behaviour_ellipse_set_angle_tilt
579
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
580
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>,
581
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt</code></em>);</pre>
582
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_angle_tilt</code> is deprecated and should not be used in newly-written code.</p></div>
583
<p>Sets the angle at which the ellipse should be tilted around it's center.</p>
584
<div class="refsect3">
585
<a name="id-1.10.7.9.9.7"></a><h4>Parameters</h4>
586
<div class="informaltable"><table width="100%" border="0">
588
<col width="150px" class="parameters_name">
589
<col class="parameters_description">
590
<col width="200px" class="parameters_annotations">
594
<td class="parameter_name"><p>self</p></td>
595
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
596
<td class="parameter_annotations"> </td>
599
<td class="parameter_name"><p>axis</p></td>
600
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a></p></td>
601
<td class="parameter_annotations"> </td>
604
<td class="parameter_name"><p>angle_tilt</p></td>
605
<td class="parameter_description"><p>tilt of the elipse around the center in the given axis in
607
<td class="parameter_annotations"> </td>
612
<p class="since">Since 0.4</p>
615
<div class="refsect2">
616
<a name="clutter-behaviour-ellipse-get-angle-tilt"></a><h3>clutter_behaviour_ellipse_get_angle_tilt ()</h3>
617
<pre class="programlisting"><span class="returnvalue">gdouble</span>
618
clutter_behaviour_ellipse_get_angle_tilt
619
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
620
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>);</pre>
621
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_angle_tilt</code> is deprecated and should not be used in newly-written code.</p></div>
622
<p>Gets the tilt of the ellipse around the center in the given axis.</p>
623
<div class="refsect3">
624
<a name="id-1.10.7.9.10.7"></a><h4>Parameters</h4>
625
<div class="informaltable"><table width="100%" border="0">
627
<col width="150px" class="parameters_name">
628
<col class="parameters_description">
629
<col width="200px" class="parameters_annotations">
633
<td class="parameter_name"><p>self</p></td>
634
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
635
<td class="parameter_annotations"> </td>
638
<td class="parameter_name"><p>axis</p></td>
639
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a></p></td>
640
<td class="parameter_annotations"> </td>
645
<div class="refsect3">
646
<a name="id-1.10.7.9.10.8"></a><h4>Returns</h4>
647
<p> angle in degrees.</p>
650
<p class="since">Since 0.4</p>
653
<div class="refsect2">
654
<a name="clutter-behaviour-ellipse-set-height"></a><h3>clutter_behaviour_ellipse_set_height ()</h3>
655
<pre class="programlisting"><span class="returnvalue">void</span>
656
clutter_behaviour_ellipse_set_height (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
657
<em class="parameter"><code><span class="type">gint</span> height</code></em>);</pre>
658
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_height</code> is deprecated and should not be used in newly-written code.</p></div>
659
<p>Sets the height of the elliptical path.</p>
660
<div class="refsect3">
661
<a name="id-1.10.7.9.11.7"></a><h4>Parameters</h4>
662
<div class="informaltable"><table width="100%" border="0">
664
<col width="150px" class="parameters_name">
665
<col class="parameters_description">
666
<col width="200px" class="parameters_annotations">
670
<td class="parameter_name"><p>self</p></td>
671
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
672
<td class="parameter_annotations"> </td>
675
<td class="parameter_name"><p>height</p></td>
676
<td class="parameter_description"><p>height of the ellipse</p></td>
677
<td class="parameter_annotations"> </td>
682
<p class="since">Since 0.4</p>
685
<div class="refsect2">
686
<a name="clutter-behaviour-ellipse-get-height"></a><h3>clutter_behaviour_ellipse_get_height ()</h3>
687
<pre class="programlisting"><span class="returnvalue">gint</span>
688
clutter_behaviour_ellipse_get_height (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
689
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_height</code> is deprecated and should not be used in newly-written code.</p></div>
690
<p>Gets the height of the elliptical path.</p>
691
<div class="refsect3">
692
<a name="id-1.10.7.9.12.7"></a><h4>Parameters</h4>
693
<div class="informaltable"><table width="100%" border="0">
695
<col width="150px" class="parameters_name">
696
<col class="parameters_description">
697
<col width="200px" class="parameters_annotations">
700
<td class="parameter_name"><p>self</p></td>
701
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
702
<td class="parameter_annotations"> </td>
706
<div class="refsect3">
707
<a name="id-1.10.7.9.12.8"></a><h4>Returns</h4>
708
<p> the height of the path</p>
711
<p class="since">Since 0.4</p>
714
<div class="refsect2">
715
<a name="clutter-behaviour-ellipse-set-width"></a><h3>clutter_behaviour_ellipse_set_width ()</h3>
716
<pre class="programlisting"><span class="returnvalue">void</span>
717
clutter_behaviour_ellipse_set_width (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
718
<em class="parameter"><code><span class="type">gint</span> width</code></em>);</pre>
719
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_width</code> is deprecated and should not be used in newly-written code.</p></div>
720
<p>Sets the width of the elliptical path.</p>
721
<div class="refsect3">
722
<a name="id-1.10.7.9.13.7"></a><h4>Parameters</h4>
723
<div class="informaltable"><table width="100%" border="0">
725
<col width="150px" class="parameters_name">
726
<col class="parameters_description">
727
<col width="200px" class="parameters_annotations">
731
<td class="parameter_name"><p>self</p></td>
732
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
733
<td class="parameter_annotations"> </td>
736
<td class="parameter_name"><p>width</p></td>
737
<td class="parameter_description"><p>width of the ellipse</p></td>
738
<td class="parameter_annotations"> </td>
743
<p class="since">Since 0.4</p>
746
<div class="refsect2">
747
<a name="clutter-behaviour-ellipse-get-width"></a><h3>clutter_behaviour_ellipse_get_width ()</h3>
748
<pre class="programlisting"><span class="returnvalue">gint</span>
749
clutter_behaviour_ellipse_get_width (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
750
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_width</code> is deprecated and should not be used in newly-written code.</p></div>
751
<p>Gets the width of the elliptical path.</p>
752
<div class="refsect3">
753
<a name="id-1.10.7.9.14.7"></a><h4>Parameters</h4>
754
<div class="informaltable"><table width="100%" border="0">
756
<col width="150px" class="parameters_name">
757
<col class="parameters_description">
758
<col width="200px" class="parameters_annotations">
761
<td class="parameter_name"><p>self</p></td>
762
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
763
<td class="parameter_annotations"> </td>
767
<div class="refsect3">
768
<a name="id-1.10.7.9.14.8"></a><h4>Returns</h4>
769
<p> the width of the path</p>
772
<p class="since">Since 0.4</p>
775
<div class="refsect2">
776
<a name="clutter-behaviour-ellipse-set-tilt"></a><h3>clutter_behaviour_ellipse_set_tilt ()</h3>
777
<pre class="programlisting"><span class="returnvalue">void</span>
778
clutter_behaviour_ellipse_set_tilt (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
779
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_x</code></em>,
780
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_y</code></em>,
781
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_z</code></em>);</pre>
782
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_tilt</code> is deprecated and should not be used in newly-written code.</p></div>
783
<p>Sets the angles at which the ellipse should be tilted around it's center.</p>
784
<div class="refsect3">
785
<a name="id-1.10.7.9.15.7"></a><h4>Parameters</h4>
786
<div class="informaltable"><table width="100%" border="0">
788
<col width="150px" class="parameters_name">
789
<col class="parameters_description">
790
<col width="200px" class="parameters_annotations">
794
<td class="parameter_name"><p>self</p></td>
795
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
796
<td class="parameter_annotations"> </td>
799
<td class="parameter_name"><p>angle_tilt_x</p></td>
800
<td class="parameter_description"><p>tilt of the elipse around the center in X axis in degrees.</p></td>
801
<td class="parameter_annotations"> </td>
804
<td class="parameter_name"><p>angle_tilt_y</p></td>
805
<td class="parameter_description"><p>tilt of the elipse around the center in Y axis in degrees.</p></td>
806
<td class="parameter_annotations"> </td>
809
<td class="parameter_name"><p>angle_tilt_z</p></td>
810
<td class="parameter_description"><p>tilt of the elipse around the center in Z axis in degrees.</p></td>
811
<td class="parameter_annotations"> </td>
816
<p class="since">Since 0.4</p>
819
<div class="refsect2">
820
<a name="clutter-behaviour-ellipse-get-tilt"></a><h3>clutter_behaviour_ellipse_get_tilt ()</h3>
821
<pre class="programlisting"><span class="returnvalue">void</span>
822
clutter_behaviour_ellipse_get_tilt (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
823
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_x</code></em>,
824
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_y</code></em>,
825
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_z</code></em>);</pre>
826
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_tilt</code> is deprecated and should not be used in newly-written code.</p></div>
827
<p>Gets the tilt of the ellipse around the center in Y axis.</p>
828
<div class="refsect3">
829
<a name="id-1.10.7.9.16.7"></a><h4>Parameters</h4>
830
<div class="informaltable"><table width="100%" border="0">
832
<col width="150px" class="parameters_name">
833
<col class="parameters_description">
834
<col width="200px" class="parameters_annotations">
838
<td class="parameter_name"><p>self</p></td>
839
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
840
<td class="parameter_annotations"> </td>
843
<td class="parameter_name"><p>angle_tilt_x</p></td>
844
<td class="parameter_description"><p> return location for tilt angle on the X axis, or <code class="literal">NULL</code>. </p></td>
845
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
848
<td class="parameter_name"><p>angle_tilt_y</p></td>
849
<td class="parameter_description"><p> return location for tilt angle on the Y axis, or <code class="literal">NULL</code>. </p></td>
850
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
853
<td class="parameter_name"><p>angle_tilt_z</p></td>
854
<td class="parameter_description"><p> return location for tilt angle on the Z axis, or <code class="literal">NULL</code>. </p></td>
855
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
860
<p class="since">Since 0.4</p>
863
<div class="refsect2">
864
<a name="clutter-behaviour-ellipse-set-direction"></a><h3>clutter_behaviour_ellipse_set_direction ()</h3>
865
<pre class="programlisting"><span class="returnvalue">void</span>
866
clutter_behaviour_ellipse_set_direction
867
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
868
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>);</pre>
869
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_set_direction</code> is deprecated and should not be used in newly-written code.</p></div>
870
<p>Sets the rotation direction used by the ellipse behaviour.</p>
871
<div class="refsect3">
872
<a name="id-1.10.7.9.17.7"></a><h4>Parameters</h4>
873
<div class="informaltable"><table width="100%" border="0">
875
<col width="150px" class="parameters_name">
876
<col class="parameters_description">
877
<col width="200px" class="parameters_annotations">
881
<td class="parameter_name"><p>self</p></td>
882
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
883
<td class="parameter_annotations"> </td>
886
<td class="parameter_name"><p>direction</p></td>
887
<td class="parameter_description"><p>the rotation direction</p></td>
888
<td class="parameter_annotations"> </td>
893
<p class="since">Since 0.4</p>
896
<div class="refsect2">
897
<a name="clutter-behaviour-ellipse-get-direction"></a><h3>clutter_behaviour_ellipse_get_direction ()</h3>
898
<pre class="programlisting"><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="returnvalue">ClutterRotateDirection</span></a>
899
clutter_behaviour_ellipse_get_direction
900
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
901
<div class="warning"><p><code class="literal">clutter_behaviour_ellipse_get_direction</code> is deprecated and should not be used in newly-written code.</p></div>
902
<p>Retrieves the <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> used by the ellipse behaviour.</p>
903
<div class="refsect3">
904
<a name="id-1.10.7.9.18.7"></a><h4>Parameters</h4>
905
<div class="informaltable"><table width="100%" border="0">
907
<col width="150px" class="parameters_name">
908
<col class="parameters_description">
909
<col width="200px" class="parameters_annotations">
912
<td class="parameter_name"><p>self</p></td>
913
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a></p></td>
914
<td class="parameter_annotations"> </td>
918
<div class="refsect3">
919
<a name="id-1.10.7.9.18.8"></a><h4>Returns</h4>
920
<p> the rotation direction</p>
923
<p class="since">Since 0.4</p>
926
<div class="refsect1">
927
<a name="ClutterBehaviourEllipse.other_details"></a><h2>Types and Values</h2>
151
928
<div class="refsect2">
152
929
<a name="ClutterBehaviourEllipse-struct"></a><h3>struct ClutterBehaviourEllipse</h3>
153
930
<pre class="programlisting">struct ClutterBehaviourEllipse;</pre>
154
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
155
<h3 class="title">Warning</h3>
156
<p><code class="literal">ClutterBehaviourEllipse</code> is deprecated and should not be used in newly-written code. 1.6</p>
159
The <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> struct contains only private data
160
and should be accessed using the provided API
931
<div class="warning"><p><code class="literal">ClutterBehaviourEllipse</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
932
<p>The <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> struct contains only private data
933
and should be accessed using the provided API</p>
162
934
<p class="since">Since 0.4</p>
167
939
<pre class="programlisting">struct ClutterBehaviourEllipseClass {
170
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
171
<h3 class="title">Warning</h3>
172
<p><code class="literal">ClutterBehaviourEllipseClass</code> is deprecated and should not be used in newly-written code. 1.6</p>
175
The <a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipseClass" title="struct ClutterBehaviourEllipseClass"><span class="type">ClutterBehaviourEllipseClass</span></a> struct contains only private data
177
<p class="since">Since 0.4</p>
180
<div class="refsect2">
181
<a name="clutter-behaviour-ellipse-new"></a><h3>clutter_behaviour_ellipse_new ()</h3>
182
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * clutter_behaviour_ellipse_new (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
183
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
184
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
185
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
186
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
187
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>,
188
<em class="parameter"><code><span class="type">gdouble</span> start</code></em>,
189
<em class="parameter"><code><span class="type">gdouble</span> end</code></em>);</pre>
191
Creates a behaviour that drives actors along an elliptical path with
192
given center, width and height; the movement starts at <em class="parameter"><code>start</code></em>
193
degrees (with 0 corresponding to 12 o'clock) and ends at <em class="parameter"><code>end</code></em>
194
degrees. Angles greated than 360 degrees get clamped to the canonical
195
interval <0, 360); if <em class="parameter"><code>start</code></em> is equal to <em class="parameter"><code>end</code></em>, the behaviour will
196
rotate by exacly 360 degrees.
199
If <em class="parameter"><code>alpha</code></em> is not <code class="literal">NULL</code>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
200
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 <code class="literal">NULL</code>,
201
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>.
203
<div class="variablelist"><table border="0" class="variablelist">
205
<col align="left" valign="top">
210
<td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
211
<td>a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
215
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
216
<td>x coordinace of the center</td>
219
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
220
<td>y coordiance of the center</td>
223
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
224
<td>width of the ellipse</td>
227
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
228
<td>height of the ellipse</td>
231
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
233
<a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> of rotation</td>
236
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
237
<td>angle in degrees at which movement starts, between 0 and 360</td>
240
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
241
<td>angle in degrees at which movement ends, between 0 and 360</td>
244
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
245
<td>the newly created <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
250
<p class="since">Since 0.4</p>
253
<div class="refsect2">
254
<a name="clutter-behaviour-ellipse-set-center"></a><h3>clutter_behaviour_ellipse_set_center ()</h3>
255
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_center
256
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
257
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
258
<em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre>
260
Sets the center of the elliptical path to the point represented by knot.
262
<div class="variablelist"><table border="0" class="variablelist">
264
<col align="left" valign="top">
269
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
270
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
274
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
275
<td>x coordinace of centre</td>
278
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
279
<td>y coordinace of centre</td>
283
<p class="since">Since 0.4</p>
286
<div class="refsect2">
287
<a name="clutter-behaviour-ellipse-get-center"></a><h3>clutter_behaviour_ellipse_get_center ()</h3>
288
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_get_center
289
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
290
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
291
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
293
Gets the center of the elliptical path path.
295
<div class="variablelist"><table border="0" class="variablelist">
297
<col align="left" valign="top">
302
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
303
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
307
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
308
<td>return location for the X coordinate of the center, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
312
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
313
<td>return location for the Y coordinate of the center, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
318
<p class="since">Since 0.4</p>
321
<div class="refsect2">
322
<a name="clutter-behaviour-ellipse-set-angle-start"></a><h3>clutter_behaviour_ellipse_set_angle_start ()</h3>
323
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_angle_start
324
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
325
<em class="parameter"><code><span class="type">gdouble</span> angle_start</code></em>);</pre>
327
Sets the angle at which movement starts; angles >= 360 degress get clamped
328
to the canonical interval <0, 360).
330
<div class="variablelist"><table border="0" class="variablelist">
332
<col align="left" valign="top">
337
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
338
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
342
<td><p><span class="term"><em class="parameter"><code>angle_start</code></em> :</span></p></td>
343
<td>angle at which movement starts in degrees, between 0 and 360.</td>
347
<p class="since">Since 0.6</p>
350
<div class="refsect2">
351
<a name="clutter-behaviour-ellipse-get-angle-start"></a><h3>clutter_behaviour_ellipse_get_angle_start ()</h3>
352
<pre class="programlisting"><span class="returnvalue">gdouble</span> clutter_behaviour_ellipse_get_angle_start
353
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
355
Gets the angle at which movements starts.
357
<div class="variablelist"><table border="0" class="variablelist">
359
<col align="left" valign="top">
364
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
365
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
369
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
370
<td>angle in degrees</td>
374
<p class="since">Since 0.6</p>
377
<div class="refsect2">
378
<a name="clutter-behaviour-ellipse-set-angle-end"></a><h3>clutter_behaviour_ellipse_set_angle_end ()</h3>
379
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_angle_end
380
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
381
<em class="parameter"><code><span class="type">gdouble</span> angle_end</code></em>);</pre>
383
Sets the angle at which movement ends; angles >= 360 degress get clamped
384
to the canonical interval <0, 360).
386
<div class="variablelist"><table border="0" class="variablelist">
388
<col align="left" valign="top">
393
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
394
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
398
<td><p><span class="term"><em class="parameter"><code>angle_end</code></em> :</span></p></td>
399
<td>angle at which movement ends in degrees, between 0 and 360.</td>
403
<p class="since">Since 0.4</p>
406
<div class="refsect2">
407
<a name="clutter-behaviour-ellipse-get-angle-end"></a><h3>clutter_behaviour_ellipse_get_angle_end ()</h3>
408
<pre class="programlisting"><span class="returnvalue">gdouble</span> clutter_behaviour_ellipse_get_angle_end
409
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
411
Gets the at which movements ends.
413
<div class="variablelist"><table border="0" class="variablelist">
415
<col align="left" valign="top">
420
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
421
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
425
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
426
<td>angle in degrees</td>
430
<p class="since">Since 0.4</p>
433
<div class="refsect2">
434
<a name="clutter-behaviour-ellipse-set-angle-tilt"></a><h3>clutter_behaviour_ellipse_set_angle_tilt ()</h3>
435
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_angle_tilt
436
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
437
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>,
438
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt</code></em>);</pre>
440
Sets the angle at which the ellipse should be tilted around it's center.
442
<div class="variablelist"><table border="0" class="variablelist">
444
<col align="left" valign="top">
449
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
450
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
454
<td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
455
<td>a <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a>
459
<td><p><span class="term"><em class="parameter"><code>angle_tilt</code></em> :</span></p></td>
460
<td>tilt of the elipse around the center in the given axis in
465
<p class="since">Since 0.4</p>
468
<div class="refsect2">
469
<a name="clutter-behaviour-ellipse-get-angle-tilt"></a><h3>clutter_behaviour_ellipse_get_angle_tilt ()</h3>
470
<pre class="programlisting"><span class="returnvalue">gdouble</span> clutter_behaviour_ellipse_get_angle_tilt
471
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
472
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a> axis</code></em>);</pre>
474
Gets the tilt of the ellipse around the center in the given axis.
476
<div class="variablelist"><table border="0" class="variablelist">
478
<col align="left" valign="top">
483
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
484
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
488
<td><p><span class="term"><em class="parameter"><code>axis</code></em> :</span></p></td>
489
<td>a <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateAxis" title="enum ClutterRotateAxis"><span class="type">ClutterRotateAxis</span></a>
493
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
494
<td>angle in degrees.</td>
498
<p class="since">Since 0.4</p>
501
<div class="refsect2">
502
<a name="clutter-behaviour-ellipse-set-height"></a><h3>clutter_behaviour_ellipse_set_height ()</h3>
503
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_height
504
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
505
<em class="parameter"><code><span class="type">gint</span> height</code></em>);</pre>
507
Sets the height of the elliptical path.
509
<div class="variablelist"><table border="0" class="variablelist">
511
<col align="left" valign="top">
516
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
517
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
521
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
522
<td>height of the ellipse</td>
526
<p class="since">Since 0.4</p>
529
<div class="refsect2">
530
<a name="clutter-behaviour-ellipse-get-height"></a><h3>clutter_behaviour_ellipse_get_height ()</h3>
531
<pre class="programlisting"><span class="returnvalue">gint</span> clutter_behaviour_ellipse_get_height
532
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
534
Gets the height of the elliptical path.
536
<div class="variablelist"><table border="0" class="variablelist">
538
<col align="left" valign="top">
543
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
544
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
548
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
549
<td>the height of the path</td>
553
<p class="since">Since 0.4</p>
556
<div class="refsect2">
557
<a name="clutter-behaviour-ellipse-set-width"></a><h3>clutter_behaviour_ellipse_set_width ()</h3>
558
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_width (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
559
<em class="parameter"><code><span class="type">gint</span> width</code></em>);</pre>
561
Sets the width of the elliptical path.
563
<div class="variablelist"><table border="0" class="variablelist">
565
<col align="left" valign="top">
570
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
571
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
575
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
576
<td>width of the ellipse</td>
580
<p class="since">Since 0.4</p>
583
<div class="refsect2">
584
<a name="clutter-behaviour-ellipse-get-width"></a><h3>clutter_behaviour_ellipse_get_width ()</h3>
585
<pre class="programlisting"><span class="returnvalue">gint</span> clutter_behaviour_ellipse_get_width (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
587
Gets the width of the elliptical path.
589
<div class="variablelist"><table border="0" class="variablelist">
591
<col align="left" valign="top">
596
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
597
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
601
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
602
<td>the width of the path</td>
606
<p class="since">Since 0.4</p>
609
<div class="refsect2">
610
<a name="clutter-behaviour-ellipse-set-tilt"></a><h3>clutter_behaviour_ellipse_set_tilt ()</h3>
611
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_tilt (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
612
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_x</code></em>,
613
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_y</code></em>,
614
<em class="parameter"><code><span class="type">gdouble</span> angle_tilt_z</code></em>);</pre>
616
Sets the angles at which the ellipse should be tilted around it's center.
618
<div class="variablelist"><table border="0" class="variablelist">
620
<col align="left" valign="top">
625
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
626
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
630
<td><p><span class="term"><em class="parameter"><code>angle_tilt_x</code></em> :</span></p></td>
631
<td>tilt of the elipse around the center in X axis in degrees.</td>
634
<td><p><span class="term"><em class="parameter"><code>angle_tilt_y</code></em> :</span></p></td>
635
<td>tilt of the elipse around the center in Y axis in degrees.</td>
638
<td><p><span class="term"><em class="parameter"><code>angle_tilt_z</code></em> :</span></p></td>
639
<td>tilt of the elipse around the center in Z axis in degrees.</td>
643
<p class="since">Since 0.4</p>
646
<div class="refsect2">
647
<a name="clutter-behaviour-ellipse-get-tilt"></a><h3>clutter_behaviour_ellipse_get_tilt ()</h3>
648
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_get_tilt (<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
649
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_x</code></em>,
650
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_y</code></em>,
651
<em class="parameter"><code><span class="type">gdouble</span> *angle_tilt_z</code></em>);</pre>
653
Gets the tilt of the ellipse around the center in Y axis.
655
<div class="variablelist"><table border="0" class="variablelist">
657
<col align="left" valign="top">
662
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
663
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
667
<td><p><span class="term"><em class="parameter"><code>angle_tilt_x</code></em> :</span></p></td>
668
<td>return location for tilt angle on the X axis, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
672
<td><p><span class="term"><em class="parameter"><code>angle_tilt_y</code></em> :</span></p></td>
673
<td>return location for tilt angle on the Y axis, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
677
<td><p><span class="term"><em class="parameter"><code>angle_tilt_z</code></em> :</span></p></td>
678
<td>return location for tilt angle on the Z axis, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
683
<p class="since">Since 0.4</p>
686
<div class="refsect2">
687
<a name="clutter-behaviour-ellipse-set-direction"></a><h3>clutter_behaviour_ellipse_set_direction ()</h3>
688
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_ellipse_set_direction
689
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>,
690
<em class="parameter"><code><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> direction</code></em>);</pre>
692
Sets the rotation direction used by the ellipse behaviour.
694
<div class="variablelist"><table border="0" class="variablelist">
696
<col align="left" valign="top">
701
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
702
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
706
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
707
<td>the rotation direction</td>
711
<p class="since">Since 0.4</p>
714
<div class="refsect2">
715
<a name="clutter-behaviour-ellipse-get-direction"></a><h3>clutter_behaviour_ellipse_get_direction ()</h3>
716
<pre class="programlisting"><a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="returnvalue">ClutterRotateDirection</span></a> clutter_behaviour_ellipse_get_direction
717
(<em class="parameter"><code><a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a> *self</code></em>);</pre>
719
Retrieves the <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> used by the ellipse behaviour.
721
<div class="variablelist"><table border="0" class="variablelist">
723
<col align="left" valign="top">
728
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
729
<td>a <a class="link" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse"><span class="type">ClutterBehaviourEllipse</span></a>
733
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
734
<td>the rotation direction</td>
942
<div class="warning"><p><code class="literal">ClutterBehaviourEllipseClass</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
943
<p>The <a class="link" href="ClutterBehaviourEllipse.html#ClutterBehaviourEllipseClass" title="struct ClutterBehaviourEllipseClass"><span class="type">ClutterBehaviourEllipseClass</span></a> struct contains only private data</p>
738
944
<p class="since">Since 0.4</p>
741
947
<div class="refsect1">
742
948
<a name="ClutterBehaviourEllipse.property-details"></a><h2>Property Details</h2>
743
949
<div class="refsect2">
744
<a name="ClutterBehaviourEllipse--angle-end"></a><h3>The <code class="literal">"angle-end"</code> property</h3>
745
<pre class="programlisting"> "angle-end" <span class="type">gdouble</span> : Read / Write</pre>
747
The final angle to where the rotation should end.
749
<p>Allowed values: [0,360]</p>
750
<p>Default value: 0</p>
751
<p class="since">Since 0.4</p>
754
<div class="refsect2">
755
<a name="ClutterBehaviourEllipse--angle-start"></a><h3>The <code class="literal">"angle-start"</code> property</h3>
756
<pre class="programlisting"> "angle-start" <span class="type">gdouble</span> : Read / Write</pre>
758
The initial angle from where the rotation should start.
760
<p>Allowed values: [0,360]</p>
761
<p>Default value: 0</p>
762
<p class="since">Since 0.4</p>
765
<div class="refsect2">
766
<a name="ClutterBehaviourEllipse--angle-tilt-x"></a><h3>The <code class="literal">"angle-tilt-x"</code> property</h3>
767
<pre class="programlisting"> "angle-tilt-x" <span class="type">gdouble</span> : Read / Write</pre>
769
The tilt angle for the rotation around center in X axis
771
<p>Allowed values: [0,360]</p>
772
<p>Default value: 360</p>
773
<p class="since">Since 0.4</p>
776
<div class="refsect2">
777
<a name="ClutterBehaviourEllipse--angle-tilt-y"></a><h3>The <code class="literal">"angle-tilt-y"</code> property</h3>
778
<pre class="programlisting"> "angle-tilt-y" <span class="type">gdouble</span> : Read / Write</pre>
780
The tilt angle for the rotation around center in Y axis
782
<p>Allowed values: [0,360]</p>
783
<p>Default value: 360</p>
784
<p class="since">Since 0.4</p>
787
<div class="refsect2">
788
<a name="ClutterBehaviourEllipse--angle-tilt-z"></a><h3>The <code class="literal">"angle-tilt-z"</code> property</h3>
789
<pre class="programlisting"> "angle-tilt-z" <span class="type">gdouble</span> : Read / Write</pre>
791
The tilt angle for the rotation on the Z axis
793
<p>Allowed values: [0,360]</p>
794
<p>Default value: 360</p>
795
<p class="since">Since 0.4</p>
798
<div class="refsect2">
799
<a name="ClutterBehaviourEllipse--center"></a><h3>The <code class="literal">"center"</code> property</h3>
800
<pre class="programlisting"> "center" <a class="link" href="clutter-Base-geometric-types.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a>* : Read / Write</pre>
802
The center of the ellipse.
804
<p class="since">Since 0.4</p>
807
<div class="refsect2">
808
<a name="ClutterBehaviourEllipse--direction"></a><h3>The <code class="literal">"direction"</code> property</h3>
809
<pre class="programlisting"> "direction" <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a> : Read / Write</pre>
811
The direction of the rotation.
950
<a name="ClutterBehaviourEllipse--angle-end"></a><h3>The <code class="literal">“angle-end”</code> property</h3>
951
<pre class="programlisting"> “angle-end” <span class="type">gdouble</span></pre>
952
<p>The final angle to where the rotation should end.</p>
953
<p>Flags: Read / Write</p>
954
<p>Allowed values: [0,360]</p>
955
<p>Default value: 0</p>
956
<p class="since">Since 0.4</p>
959
<div class="refsect2">
960
<a name="ClutterBehaviourEllipse--angle-start"></a><h3>The <code class="literal">“angle-start”</code> property</h3>
961
<pre class="programlisting"> “angle-start” <span class="type">gdouble</span></pre>
962
<p>The initial angle from where the rotation should start.</p>
963
<p>Flags: Read / Write</p>
964
<p>Allowed values: [0,360]</p>
965
<p>Default value: 0</p>
966
<p class="since">Since 0.4</p>
969
<div class="refsect2">
970
<a name="ClutterBehaviourEllipse--angle-tilt-x"></a><h3>The <code class="literal">“angle-tilt-x”</code> property</h3>
971
<pre class="programlisting"> “angle-tilt-x” <span class="type">gdouble</span></pre>
972
<p>The tilt angle for the rotation around center in X axis</p>
973
<p>Flags: Read / Write</p>
974
<p>Allowed values: [0,360]</p>
975
<p>Default value: 360</p>
976
<p class="since">Since 0.4</p>
979
<div class="refsect2">
980
<a name="ClutterBehaviourEllipse--angle-tilt-y"></a><h3>The <code class="literal">“angle-tilt-y”</code> property</h3>
981
<pre class="programlisting"> “angle-tilt-y” <span class="type">gdouble</span></pre>
982
<p>The tilt angle for the rotation around center in Y axis</p>
983
<p>Flags: Read / Write</p>
984
<p>Allowed values: [0,360]</p>
985
<p>Default value: 360</p>
986
<p class="since">Since 0.4</p>
989
<div class="refsect2">
990
<a name="ClutterBehaviourEllipse--angle-tilt-z"></a><h3>The <code class="literal">“angle-tilt-z”</code> property</h3>
991
<pre class="programlisting"> “angle-tilt-z” <span class="type">gdouble</span></pre>
992
<p>The tilt angle for the rotation on the Z axis</p>
993
<p>Flags: Read / Write</p>
994
<p>Allowed values: [0,360]</p>
995
<p>Default value: 360</p>
996
<p class="since">Since 0.4</p>
999
<div class="refsect2">
1000
<a name="ClutterBehaviourEllipse--center"></a><h3>The <code class="literal">“center”</code> property</h3>
1001
<pre class="programlisting"> “center” <a class="link" href="clutter-Base-geometric-types.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *</pre>
1002
<p>The center of the ellipse.</p>
1003
<p>Flags: Read / Write</p>
1004
<p class="since">Since 0.4</p>
1007
<div class="refsect2">
1008
<a name="ClutterBehaviourEllipse--direction"></a><h3>The <code class="literal">“direction”</code> property</h3>
1009
<pre class="programlisting"> “direction” <a class="link" href="ClutterBehaviourRotate.html#ClutterRotateDirection" title="enum ClutterRotateDirection"><span class="type">ClutterRotateDirection</span></a></pre>
1010
<p>The direction of the rotation.</p>
1011
<p>Flags: Read / Write</p>
813
1012
<p>Default value: CLUTTER_ROTATE_CW</p>
814
1013
<p class="since">Since 0.4</p>
817
1016
<div class="refsect2">
818
<a name="ClutterBehaviourEllipse--height"></a><h3>The <code class="literal">"height"</code> property</h3>
819
<pre class="programlisting"> "height" <span class="type">gint</span> : Read / Write</pre>
821
Height of the ellipse, in pixels
1017
<a name="ClutterBehaviourEllipse--height"></a><h3>The <code class="literal">“height”</code> property</h3>
1018
<pre class="programlisting"> “height” <span class="type">gint</span></pre>
1019
<p>Height of the ellipse, in pixels</p>
1020
<p>Flags: Read / Write</p>
823
1021
<p>Allowed values: >= 0</p>
824
1022
<p>Default value: 50</p>
825
1023
<p class="since">Since 0.4</p>
828
1026
<div class="refsect2">
829
<a name="ClutterBehaviourEllipse--width"></a><h3>The <code class="literal">"width"</code> property</h3>
830
<pre class="programlisting"> "width" <span class="type">gint</span> : Read / Write</pre>
832
Width of the ellipse, in pixels
1027
<a name="ClutterBehaviourEllipse--width"></a><h3>The <code class="literal">“width”</code> property</h3>
1028
<pre class="programlisting"> “width” <span class="type">gint</span></pre>
1029
<p>Width of the ellipse, in pixels</p>
1030
<p>Flags: Read / Write</p>
834
1031
<p>Allowed values: >= 0</p>
835
1032
<p>Default value: 100</p>
836
1033
<p class="since">Since 0.4</p>