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>ClutterBehaviourPath</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="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">
10 <link rel="next" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate">
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="ClutterBehaviourOpacity.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="ClutterBehaviourRotate.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="#ClutterBehaviourPath.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterBehaviourPath.description" class="shortcut">Description</a>
28 <a href="#ClutterBehaviourPath.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterBehaviourPath.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#ClutterBehaviourPath.properties" class="shortcut">Properties</a>
34 <a href="#ClutterBehaviourPath.signals" class="shortcut">Signals</a>
37 <div class="refentry">
38 <a name="ClutterBehaviourPath"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
41 <h2><span class="refentrytitle"><a name="ClutterBehaviourPath.top_of_page"></a>ClutterBehaviourPath</span></h2>
42 <p>ClutterBehaviourPath — A behaviour for moving actors along a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p>
44 <td valign="top" align="right"></td>
46 <div class="refsynopsisdiv">
47 <a name="ClutterBehaviourPath.synopsis"></a><h2>Synopsis</h2>
48 <pre class="synopsis">struct <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath-struct" title="struct ClutterBehaviourPath">ClutterBehaviourPath</a>;
49 struct <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="struct ClutterBehaviourPathClass">ClutterBehaviourPathClass</a>;
50 <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-new" title="clutter_behaviour_path_new ()">clutter_behaviour_path_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="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);
52 <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-new-with-description" title="clutter_behaviour_path_new_with_description ()">clutter_behaviour_path_new_with_description</a>
53 (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
54 <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);
55 <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-new-with-knots" title="clutter_behaviour_path_new_with_knots ()">clutter_behaviour_path_new_with_knots</a>
56 (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
57 <em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knots</code></em>,
58 <em class="parameter"><code><span class="type">guint</span> n_knots</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-set-path" title="clutter_behaviour_path_set_path ()">clutter_behaviour_path_set_path</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> *pathb</code></em>,
60 <em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);
61 <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> * <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-get-path" title="clutter_behaviour_path_get_path ()">clutter_behaviour_path_get_path</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> *pathb</code></em>);
63 struct <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot">ClutterKnot</a>;
64 <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> * <a class="link" href="ClutterBehaviourPath.html#clutter-knot-copy" title="clutter_knot_copy ()">clutter_knot_copy</a> (<em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot</code></em>);
65 <span class="returnvalue">void</span> <a class="link" href="ClutterBehaviourPath.html#clutter-knot-free" title="clutter_knot_free ()">clutter_knot_free</a> (<em class="parameter"><code><a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot</code></em>);
66 <span class="returnvalue">gboolean</span> <a class="link" href="ClutterBehaviourPath.html#clutter-knot-equal" title="clutter_knot_equal ()">clutter_knot_equal</a> (<em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot_a</code></em>,
67 <em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot_b</code></em>);
70 <div class="refsect1">
71 <a name="ClutterBehaviourPath.object-hierarchy"></a><h2>Object Hierarchy</h2>
72 <pre class="synopsis">
74 +----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
75 +----ClutterBehaviourPath
78 <div class="refsect1">
79 <a name="ClutterBehaviourPath.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
81 ClutterBehaviourPath implements
82 <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
84 <div class="refsect1">
85 <a name="ClutterBehaviourPath.properties"></a><h2>Properties</h2>
86 <pre class="synopsis">
87 "<a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath--path" title='The "path" property'>path</a>" <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a>* : Read / Write
90 <div class="refsect1">
91 <a name="ClutterBehaviourPath.signals"></a><h2>Signals</h2>
92 <pre class="synopsis">
93 "<a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath-knot-reached" title='The "knot-reached" signal'>knot-reached</a>" : <code class="literal">Run Last</code>
96 <div class="refsect1">
97 <a name="ClutterBehaviourPath.description"></a><h2>Description</h2>
99 <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> interpolates actors along a defined path.
102 A path is described by a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> object. The path can contain
103 straight line parts and bezier curves. If the path contains
104 <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> parts then the actors will jump to those
105 coordinates. This can be used make disjoint paths.
108 When creating a path behaviour in a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>, you can specify
109 the path property directly as a string. For example:
113 <div class="informalexample">
114 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
117 <td class="listing_lines" align="right"><pre>1
126 <td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
127 <span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"spline-path"</span><span class="symbol">,</span>
128 <span class="normal"> </span><span class="string">"type"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ClutterBehaviourPath"</span><span class="symbol">,</span>
129 <span class="normal"> </span><span class="string">"path"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"M 50 50 L 100 100"</span><span class="symbol">,</span>
130 <span class="normal"> </span><span class="string">"alpha"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="cbracket">{</span>
131 <span class="normal"> </span><span class="string">"timeline"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"main-timeline"</span><span class="symbol">,</span>
132 <span class="normal"> </span><span class="string">"function"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"ramp</span>
133 <span class="string"> }</span>
134 <span class="string">}</span></pre></td>
144 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
145 <h3 class="title">Note</h3>If the alpha function is a periodic function, i.e. it returns to
146 0.0 after reaching 1.0, then the actors will walk the path back to the
147 starting <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a>.</div>
151 <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> is available since Clutter 0.2
154 <div class="refsect1">
155 <a name="ClutterBehaviourPath.details"></a><h2>Details</h2>
156 <div class="refsect2">
157 <a name="ClutterBehaviourPath-struct"></a><h3>struct ClutterBehaviourPath</h3>
158 <pre class="programlisting">struct ClutterBehaviourPath;</pre>
159 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
160 <h3 class="title">Warning</h3>
161 <p><code class="literal">ClutterBehaviourPath</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="ClutterPathConstraint.html" title="ClutterPathConstraint"><span class="type">ClutterPathConstraint</span></a> and <a class="link" href="clutter-Implicit-Animations.html#clutter-actor-animate" title="clutter_actor_animate ()"><code class="function">clutter_actor_animate()</code></a>
165 The <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> structure contains only private data
166 and should be accessed using the provided API
168 <p class="since">Since 0.2</p>
171 <div class="refsect2">
172 <a name="ClutterBehaviourPathClass"></a><h3>struct ClutterBehaviourPathClass</h3>
173 <pre class="programlisting">struct ClutterBehaviourPathClass {
174 void (*knot_reached) (ClutterBehaviourPath *pathb,
178 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
179 <h3 class="title">Warning</h3>
180 <p><code class="literal">ClutterBehaviourPathClass</code> is deprecated and should not be used in newly-written code. 1.6</p>
183 The <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="struct ClutterBehaviourPathClass"><span class="type">ClutterBehaviourPathClass</span></a> struct contains only private data
185 <div class="variablelist"><table border="0">
186 <col align="left" valign="top">
188 <td><p><span class="term"><em class="structfield"><code><a name="ClutterBehaviourPathClass.knot-reached"></a>knot_reached</code></em> ()</span></p></td>
189 <td>signal class handler for the
190 ClutterBehaviourPath::knot_reached signal</td>
193 <p class="since">Since 0.2</p>
196 <div class="refsect2">
197 <a name="clutter-behaviour-path-new"></a><h3>clutter_behaviour_path_new ()</h3>
198 <pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * clutter_behaviour_path_new (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
199 <em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
200 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
201 <h3 class="title">Warning</h3>
202 <p><code class="literal">clutter_behaviour_path_new</code> is deprecated and should not be used in newly-written code. 1.6</p>
205 Creates a new path behaviour. You can use this behaviour to drive
206 actors along the nodes of a path, described by <em class="parameter"><code>path</code></em>.
209 This will claim the floating reference on the <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> so you
210 do not need to unref if it.
213 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
214 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>,
215 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>.
217 <div class="variablelist"><table border="0">
218 <col align="left" valign="top">
221 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
222 <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>
226 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
227 <td>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for an empty path</td>
230 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
231 <td>a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
236 <p class="since">Since 0.2</p>
239 <div class="refsect2">
240 <a name="clutter-behaviour-path-new-with-description"></a><h3>clutter_behaviour_path_new_with_description ()</h3>
241 <pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * clutter_behaviour_path_new_with_description
242 (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
243 <em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);</pre>
244 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
245 <h3 class="title">Warning</h3>
246 <p><code class="literal">clutter_behaviour_path_new_with_description</code> is deprecated and should not be used in newly-written code. 1.6</p>
249 Creates a new path behaviour using the path described by <em class="parameter"><code>desc</code></em>. See
250 <a class="link" href="ClutterPath.html#clutter-path-add-string" title="clutter_path_add_string ()"><code class="function">clutter_path_add_string()</code></a> for a description of the format.
253 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
254 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>,
255 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>.
257 <div class="variablelist"><table border="0">
258 <col align="left" valign="top">
261 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
262 <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>
266 <td><p><span class="term"><em class="parameter"><code>desc</code></em> :</span></p></td>
267 <td>a string description of the path</td>
270 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
271 <td>a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
276 <p class="since">Since 1.0</p>
279 <div class="refsect2">
280 <a name="clutter-behaviour-path-new-with-knots"></a><h3>clutter_behaviour_path_new_with_knots ()</h3>
281 <pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> * clutter_behaviour_path_new_with_knots
282 (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
283 <em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knots</code></em>,
284 <em class="parameter"><code><span class="type">guint</span> n_knots</code></em>);</pre>
285 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
286 <h3 class="title">Warning</h3>
287 <p><code class="literal">clutter_behaviour_path_new_with_knots</code> is deprecated and should not be used in newly-written code. 1.6</p>
290 Creates a new path behaviour that will make the actors visit all of
291 the given knots in order with straight lines in between.
294 A path will be created where the first knot is used in a
295 <a class="link" href="ClutterPath.html#CLUTTER-PATH-MOVE-TO:CAPS"><code class="literal">CLUTTER_PATH_MOVE_TO</code></a> and the subsequent knots are used in
296 <a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a>s.
299 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
300 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>,
301 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>.
303 <div class="variablelist"><table border="0">
304 <col align="left" valign="top">
307 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
308 <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>
312 <td><p><span class="term"><em class="parameter"><code>knots</code></em> :</span></p></td>
313 <td>an array of <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a>s. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_knots]</span>
317 <td><p><span class="term"><em class="parameter"><code>n_knots</code></em> :</span></p></td>
318 <td>number of entries in <em class="parameter"><code>knots</code></em>
322 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
323 <td>a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
328 <p class="since">Since 1.0</p>
331 <div class="refsect2">
332 <a name="clutter-behaviour-path-set-path"></a><h3>clutter_behaviour_path_set_path ()</h3>
333 <pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_path_set_path (<em class="parameter"><code><a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> *pathb</code></em>,
334 <em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
335 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
336 <h3 class="title">Warning</h3>
337 <p><code class="literal">clutter_behaviour_path_set_path</code> is deprecated and should not be used in newly-written code. 1.6</p>
340 Change the path that the actors will follow. This will take the
341 floating reference on the <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> so you do not need to unref
344 <div class="variablelist"><table border="0">
345 <col align="left" valign="top">
348 <td><p><span class="term"><em class="parameter"><code>pathb</code></em> :</span></p></td>
349 <td>the path behaviour</td>
352 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
353 <td>the new path to follow</td>
357 <p class="since">Since 1.0</p>
360 <div class="refsect2">
361 <a name="clutter-behaviour-path-get-path"></a><h3>clutter_behaviour_path_get_path ()</h3>
362 <pre class="programlisting"><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> * clutter_behaviour_path_get_path (<em class="parameter"><code><a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> *pathb</code></em>);</pre>
363 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
364 <h3 class="title">Warning</h3>
365 <p><code class="literal">clutter_behaviour_path_get_path</code> is deprecated and should not be used in newly-written code. 1.6</p>
368 Get the current path of the behaviour
370 <div class="variablelist"><table border="0">
371 <col align="left" valign="top">
374 <td><p><span class="term"><em class="parameter"><code>pathb</code></em> :</span></p></td>
375 <td>a <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> instance</td>
378 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
379 <td>the path. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
384 <p class="since">Since 1.0</p>
387 <div class="refsect2">
388 <a name="ClutterKnot"></a><h3>struct ClutterKnot</h3>
389 <pre class="programlisting">struct ClutterKnot {
395 Point in a path behaviour.
397 <div class="variablelist"><table border="0">
398 <col align="left" valign="top">
401 <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="ClutterKnot.x"></a>x</code></em>;</span></p></td>
402 <td>X coordinate of the knot</td>
405 <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="ClutterKnot.y"></a>y</code></em>;</span></p></td>
406 <td>Y coordinate of the knot</td>
410 <p class="since">Since 0.2</p>
413 <div class="refsect2">
414 <a name="clutter-knot-copy"></a><h3>clutter_knot_copy ()</h3>
415 <pre class="programlisting"><a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> * clutter_knot_copy (<em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot</code></em>);</pre>
417 Makes an allocated copy of a knot.
419 <div class="variablelist"><table border="0">
420 <col align="left" valign="top">
423 <td><p><span class="term"><em class="parameter"><code>knot</code></em> :</span></p></td>
424 <td>a <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a>
428 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
429 <td>the copied knot.</td>
433 <p class="since">Since 0.2</p>
436 <div class="refsect2">
437 <a name="clutter-knot-free"></a><h3>clutter_knot_free ()</h3>
438 <pre class="programlisting"><span class="returnvalue">void</span> clutter_knot_free (<em class="parameter"><code><a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot</code></em>);</pre>
440 Frees the memory of an allocated knot.
442 <div class="variablelist"><table border="0">
443 <col align="left" valign="top">
445 <td><p><span class="term"><em class="parameter"><code>knot</code></em> :</span></p></td>
446 <td>a <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a>
450 <p class="since">Since 0.2</p>
453 <div class="refsect2">
454 <a name="clutter-knot-equal"></a><h3>clutter_knot_equal ()</h3>
455 <pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_knot_equal (<em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot_a</code></em>,
456 <em class="parameter"><code>const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> *knot_b</code></em>);</pre>
458 Compares to knot and checks if the point to the same location.
460 <div class="variablelist"><table border="0">
461 <col align="left" valign="top">
464 <td><p><span class="term"><em class="parameter"><code>knot_a</code></em> :</span></p></td>
468 <td><p><span class="term"><em class="parameter"><code>knot_b</code></em> :</span></p></td>
472 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
474 <code class="literal">TRUE</code> if the knots point to the same location.</td>
478 <p class="since">Since 0.2</p>
481 <div class="refsect1">
482 <a name="ClutterBehaviourPath.property-details"></a><h2>Property Details</h2>
483 <div class="refsect2">
484 <a name="ClutterBehaviourPath--path"></a><h3>The <code class="literal">"path"</code> property</h3>
485 <pre class="programlisting"> "path" <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a>* : Read / Write</pre>
486 <p>The ClutterPath object representing the path to animate along.</p>
489 <div class="refsect1">
490 <a name="ClutterBehaviourPath.signal-details"></a><h2>Signal Details</h2>
491 <div class="refsect2">
492 <a name="ClutterBehaviourPath-knot-reached"></a><h3>The <code class="literal">"knot-reached"</code> signal</h3>
493 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> *pathb,
494 <span class="type">guint</span> knot_num,
495 <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
496 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
497 <h3 class="title">Warning</h3>
498 <p><code class="literal">ClutterBehaviourPath::knot-reached</code> is deprecated and should not be used in newly-written code. 1.6</p>
501 This signal is emitted each time a node defined inside the path
504 <div class="variablelist"><table border="0">
505 <col align="left" valign="top">
508 <td><p><span class="term"><em class="parameter"><code>pathb</code></em> :</span></p></td>
509 <td>the object which received the signal</td>
512 <td><p><span class="term"><em class="parameter"><code>knot_num</code></em> :</span></p></td>
513 <td>the index of the <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="struct ClutterKnot"><span class="type">ClutterKnot</span></a> reached</td>
516 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
517 <td>user data set when the signal handler was connected.</td>
521 <p class="since">Since 0.2</p>
527 Generated by GTK-Doc V1.18.1</div>