← Back to branch summary

~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/clutter/html/ClutterBehaviourPath.html

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/html/ClutterBehaviourPath.html
5
5
<title>ClutterBehaviourPath</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
 
<link rel="up" href="ch05.html" title="Behaviours">
 
8
<link rel="up" href="ch06.html" title="Behaviours">
9
9
<link rel="prev" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">
10
10
<link rel="next" href="ClutterPath.html" title="ClutterPath">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
17
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
19
<link rel="chapter" href="ch03.html" title="Container actors">
 
20
<link rel="chapter" href="ch04.html" title="Layout managers">
20
21
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
21
 
<link rel="chapter" href="ch04.html" title="Base classes">
22
 
<link rel="chapter" href="ch05.html" title="Behaviours">
23
 
<link rel="chapter" href="ch06.html" title="High Level API">
 
22
<link rel="chapter" href="ch05.html" title="Base classes">
 
23
<link rel="chapter" href="ch06.html" title="Behaviours">
 
24
<link rel="chapter" href="ch07.html" title="High Level API">
24
25
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
25
 
<link rel="chapter" href="ch07.html" title="General purpose API">
26
 
<link rel="chapter" href="ch08.html" title="User interface definition">
27
 
<link rel="chapter" href="ch09.html" title="Generic list model">
 
26
<link rel="chapter" href="ch08.html" title="General purpose API">
 
27
<link rel="chapter" href="ch09.html" title="User interface definition">
 
28
<link rel="chapter" href="ch10.html" title="Generic list model">
28
29
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
29
30
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
30
31
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
47
48
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
48
49
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
49
50
<link rel="index" href="ix07.html" title="Index of new symbols in 1.0">
 
51
<link rel="index" href="ix08.html" title="Index of new symbols in 1.2">
50
52
<link rel="appendix" href="license.html" title="Appendix A. License">
51
53
</head>
52
54
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
53
55
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
54
56
<tr valign="middle">
55
57
<td><a accesskey="p" href="ClutterBehaviourOpacity.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
56
 
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
58
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
57
59
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
58
60
<th width="100%" align="center">Clutter Reference Manual</th>
59
61
<td><a accesskey="n" href="ClutterPath.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
60
62
</tr>
61
63
<tr><td colspan="5" class="shortcuts">
62
64
<a href="#ClutterBehaviourPath.synopsis" class="shortcut">Top</a>
63
 
                 | 
64
 
                <a href="#ClutterBehaviourPath.description" class="shortcut">Description</a>
65
 
                 | 
66
 
                <a href="#ClutterBehaviourPath.object-hierarchy" class="shortcut">Object Hierarchy</a>
67
 
                 | 
68
 
                <a href="#ClutterBehaviourPath.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
69
 
                 | 
70
 
                <a href="#ClutterBehaviourPath.properties" class="shortcut">Properties</a>
71
 
                 | 
72
 
                <a href="#ClutterBehaviourPath.signals" class="shortcut">Signals</a>
 
65
                   | 
 
66
                  <a href="#ClutterBehaviourPath.description" class="shortcut">Description</a>
 
67
                   | 
 
68
                  <a href="#ClutterBehaviourPath.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
69
                   | 
 
70
                  <a href="#ClutterBehaviourPath.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
71
                   | 
 
72
                  <a href="#ClutterBehaviourPath.properties" class="shortcut">Properties</a>
 
73
                   | 
 
74
                  <a href="#ClutterBehaviourPath.signals" class="shortcut">Signals</a>
73
75
</td></tr>
74
76
</table>
75
77
<div class="refentry" title="ClutterBehaviourPath">
83
85
</tr></table></div>
84
86
<div class="refsynopsisdiv" title="Synopsis">
85
87
<a name="ClutterBehaviourPath.synopsis"></a><h2>Synopsis</h2>
86
 
<pre class="synopsis">
87
 
                    <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath-struct" title="ClutterBehaviourPath">ClutterBehaviourPath</a>;
 
88
<pre class="synopsis">                    <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath-struct" title="ClutterBehaviourPath">ClutterBehaviourPath</a>;
88
89
                    <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="ClutterBehaviourPathClass">ClutterBehaviourPathClass</a>;
89
 
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a> *  <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-new" title="clutter_behaviour_path_new ()">clutter_behaviour_path_new</a>          (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
90
 
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a> *path);
91
 
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</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>
92
 
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
93
 
                                                         const <a
94
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
95
 
>gchar</a> *desc);
96
 
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</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>
97
 
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
98
 
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knots,
99
 
                                                         <a
100
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
101
 
>guint</a> n_knots);
102
 
void                <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-set-path" title="clutter_behaviour_path_set_path ()">clutter_behaviour_path_set_path</a>     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a> *pathb,
103
 
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a> *path);
104
 
<a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a> *       <a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-get-path" title="clutter_behaviour_path_get_path ()">clutter_behaviour_path_get_path</a>     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a> *pathb);
 
90
<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>          (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *alpha,
 
91
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *path);
 
92
<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>
 
93
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *alpha,
 
94
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *desc);
 
95
<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>
 
96
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *alpha,
 
97
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knots,
 
98
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> n_knots);
 
99
<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>     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="returnvalue">ClutterBehaviourPath</span></a> *pathb,
 
100
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *path);
 
101
<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>     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="returnvalue">ClutterBehaviourPath</span></a> *pathb);
105
102
 
106
103
                    <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a>;
107
 
<a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *       <a class="link" href="ClutterBehaviourPath.html#clutter-knot-copy" title="clutter_knot_copy ()">clutter_knot_copy</a>                   (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot);
108
 
void                <a class="link" href="ClutterBehaviourPath.html#clutter-knot-free" title="clutter_knot_free ()">clutter_knot_free</a>                   (<a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot);
109
 
<a
110
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
111
 
>gboolean</a>            <a class="link" href="ClutterBehaviourPath.html#clutter-knot-equal" title="clutter_knot_equal ()">clutter_knot_equal</a>                  (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot_a,
112
 
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot_b);
 
104
<a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *       <a class="link" href="ClutterBehaviourPath.html#clutter-knot-copy" title="clutter_knot_copy ()">clutter_knot_copy</a>                   (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot);
 
105
<span class="returnvalue">void</span>                <a class="link" href="ClutterBehaviourPath.html#clutter-knot-free" title="clutter_knot_free ()">clutter_knot_free</a>                   (<a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot);
 
106
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ClutterBehaviourPath.html#clutter-knot-equal" title="clutter_knot_equal ()">clutter_knot_equal</a>                  (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot_a,
 
107
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot_b);
113
108
</pre>
114
109
</div>
115
110
<div class="refsect1" title="Object Hierarchy">
116
111
<a name="ClutterBehaviourPath.object-hierarchy"></a><h2>Object Hierarchy</h2>
117
112
<pre class="synopsis">
118
 
  <a
119
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
120
 
>GObject</a>
 
113
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
121
114
   +----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
122
115
         +----ClutterBehaviourPath
123
116
</pre>
131
124
<div class="refsect1" title="Properties">
132
125
<a name="ClutterBehaviourPath.properties"></a><h2>Properties</h2>
133
126
<pre class="synopsis">
134
 
  "<a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath--path" title='The "path" property'>path</a>"                     <a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a>*          : Read / Write
 
127
  "<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
135
128
</pre>
136
129
</div>
137
130
<div class="refsect1" title="Signals">
148
141
<p>
149
142
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
150
143
straight line parts and bezier curves. If the path contains
151
 
<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
 
144
<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
152
145
coordinates. This can be used make disjoint paths.
153
146
</p>
154
147
<p>
180
173
</p>
181
174
<p>
182
175
<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> is available since Clutter 0.2</p>
183
 
<p>
184
 
</p>
185
176
</div>
186
177
<div class="refsect1" title="Details">
187
178
<a name="ClutterBehaviourPath.details"></a><h2>Details</h2>
191
182
<p>
192
183
The <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> structure contains only private data
193
184
and should be accessed using the provided API</p>
194
 
<p>
195
 
</p>
196
185
<p class="since">Since 0.2</p>
197
186
</div>
198
187
<hr>
204
193
} ClutterBehaviourPathClass;
205
194
</pre>
206
195
<p>
207
 
The <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="ClutterBehaviourPathClass"><span class="type">ClutterBehaviourPathClass</span></a> struct contains only private data
208
 
</p>
209
 
<p>
210
 
Since 0.2</p>
211
 
<p>
212
 
</p>
 
196
The <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="ClutterBehaviourPathClass"><span class="type">ClutterBehaviourPathClass</span></a> struct contains only private data</p>
213
197
<div class="variablelist"><table border="0">
214
198
<col align="left" valign="top">
215
199
<tbody><tr>
216
 
<td><p><span class="term"><em class="structfield"><code>knot_reached</code></em> ()</span></p></td>
 
200
<td><p><span class="term"><em class="structfield"><code><a name="ClutterBehaviourPathClass.knot-reached"></a>knot_reached</code></em> ()</span></p></td>
217
201
<td> signal class handler for the
218
202
  ClutterBehaviourPath::knot_reached signal
219
203
</td>
220
204
</tr></tbody>
221
205
</table></div>
 
206
<p class="since">Since 0.2</p>
222
207
</div>
223
208
<hr>
224
209
<div class="refsect2" title="clutter_behaviour_path_new ()">
225
210
<a name="clutter-behaviour-path-new"></a><h3>clutter_behaviour_path_new ()</h3>
226
 
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a> *  clutter_behaviour_path_new          (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
227
 
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a> *path);</pre>
 
211
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *  clutter_behaviour_path_new          (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *alpha,
 
212
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *path);</pre>
228
213
<p>
229
214
Creates a new path behaviour. You can use this behaviour to drive
230
215
actors along the nodes of a path, described by <em class="parameter"><code>path</code></em>.
232
217
<p>
233
218
This will claim the floating reference on the <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> so you
234
219
do not need to unref if it.</p>
235
 
<p>
236
 
</p>
237
220
<div class="variablelist"><table border="0">
238
221
<col align="left" valign="top">
239
222
<tbody>
240
223
<tr>
241
224
<td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
242
 
<td> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>, or <a
243
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
244
 
><code class="literal">NULL</code></a>
 
225
<td> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
245
226
</td>
246
227
</tr>
247
228
<tr>
248
229
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
249
 
<td> a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> or <a
250
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
251
 
><code class="literal">NULL</code></a> for an empty path
 
230
<td> a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for an empty path
252
231
</td>
253
232
</tr>
254
233
<tr>
264
243
<hr>
265
244
<div class="refsect2" title="clutter_behaviour_path_new_with_description ()">
266
245
<a name="clutter-behaviour-path-new-with-description"></a><h3>clutter_behaviour_path_new_with_description ()</h3>
267
 
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a> *  clutter_behaviour_path_new_with_description
268
 
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
269
 
                                                         const <a
270
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
271
 
>gchar</a> *desc);</pre>
 
246
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *  clutter_behaviour_path_new_with_description
 
247
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *alpha,
 
248
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *desc);</pre>
272
249
<p>
273
250
Creates a new path behaviour using the path described by <em class="parameter"><code>desc</code></em>. See
274
251
<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.</p>
275
 
<p>
276
 
</p>
277
252
<div class="variablelist"><table border="0">
278
253
<col align="left" valign="top">
279
254
<tbody>
300
275
<hr>
301
276
<div class="refsect2" title="clutter_behaviour_path_new_with_knots ()">
302
277
<a name="clutter-behaviour-path-new-with-knots"></a><h3>clutter_behaviour_path_new_with_knots ()</h3>
303
 
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a> *  clutter_behaviour_path_new_with_knots
304
 
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
305
 
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knots,
306
 
                                                         <a
307
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
308
 
>guint</a> n_knots);</pre>
 
278
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *  clutter_behaviour_path_new_with_knots
 
279
                                                        (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *alpha,
 
280
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knots,
 
281
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> n_knots);</pre>
309
282
<p>
310
283
Creates a new path behaviour that will make the actors visit all of
311
284
the given knots in order with straight lines in between.
312
285
</p>
313
286
<p>
314
287
A path will be created where the first knot is used in a
315
 
<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
316
 
<a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO--CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a>s.</p>
317
 
<p>
318
 
</p>
 
288
<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
 
289
<a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a>s.</p>
319
290
<div class="variablelist"><table border="0">
320
291
<col align="left" valign="top">
321
292
<tbody>
347
318
<hr>
348
319
<div class="refsect2" title="clutter_behaviour_path_set_path ()">
349
320
<a name="clutter-behaviour-path-set-path"></a><h3>clutter_behaviour_path_set_path ()</h3>
350
 
<pre class="programlisting">void                clutter_behaviour_path_set_path     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a> *pathb,
351
 
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a> *path);</pre>
 
321
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_behaviour_path_set_path     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="returnvalue">ClutterBehaviourPath</span></a> *pathb,
 
322
                                                         <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *path);</pre>
352
323
<p>
353
324
Change the path that the actors will follow. This will take the
354
325
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
355
326
it.</p>
356
 
<p>
357
 
</p>
358
327
<div class="variablelist"><table border="0">
359
328
<col align="left" valign="top">
360
329
<tbody>
375
344
<hr>
376
345
<div class="refsect2" title="clutter_behaviour_path_get_path ()">
377
346
<a name="clutter-behaviour-path-get-path"></a><h3>clutter_behaviour_path_get_path ()</h3>
378
 
<pre class="programlisting"><a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a> *       clutter_behaviour_path_get_path     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a> *pathb);</pre>
 
347
<pre class="programlisting"><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *       clutter_behaviour_path_get_path     (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="returnvalue">ClutterBehaviourPath</span></a> *pathb);</pre>
379
348
<p>
380
349
Get the current path of the behaviour</p>
381
 
<p>
382
 
</p>
383
350
<div class="variablelist"><table border="0">
384
351
<col align="left" valign="top">
385
352
<tbody>
390
357
</tr>
391
358
<tr>
392
359
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
393
 
<td> the path. <a href="http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=transfer"><span class="acronym">transfer</span></a> none. </td>
 
360
<td> the path. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
394
361
</tr>
395
362
</tbody>
396
363
</table></div>
406
373
</pre>
407
374
<p>
408
375
Point in a path behaviour.</p>
409
 
<p>
410
 
</p>
411
376
<div class="variablelist"><table border="0">
412
377
<col align="left" valign="top">
413
378
<tbody>
414
379
<tr>
415
 
<td><p><span class="term"><a
416
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
417
 
>gint</a> <em class="structfield"><code>x</code></em>;</span></p></td>
 
380
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="ClutterKnot.x"></a>x</code></em>;</span></p></td>
418
381
<td> X coordinate of the knot
419
382
</td>
420
383
</tr>
421
384
<tr>
422
 
<td><p><span class="term"><a
423
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
424
 
>gint</a> <em class="structfield"><code>y</code></em>;</span></p></td>
 
385
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="ClutterKnot.y"></a>y</code></em>;</span></p></td>
425
386
<td> Y coordinate of the knot
426
387
</td>
427
388
</tr>
432
393
<hr>
433
394
<div class="refsect2" title="clutter_knot_copy ()">
434
395
<a name="clutter-knot-copy"></a><h3>clutter_knot_copy ()</h3>
435
 
<pre class="programlisting"><a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *       clutter_knot_copy                   (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot);</pre>
 
396
<pre class="programlisting"><a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *       clutter_knot_copy                   (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot);</pre>
436
397
<p>
437
398
Makes an allocated copy of a knot.</p>
438
 
<p>
439
 
</p>
440
399
<div class="variablelist"><table border="0">
441
400
<col align="left" valign="top">
442
401
<tbody>
458
417
<hr>
459
418
<div class="refsect2" title="clutter_knot_free ()">
460
419
<a name="clutter-knot-free"></a><h3>clutter_knot_free ()</h3>
461
 
<pre class="programlisting">void                clutter_knot_free                   (<a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot);</pre>
 
420
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_knot_free                   (<a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot);</pre>
462
421
<p>
463
422
Frees the memory of an allocated knot.</p>
464
 
<p>
465
 
</p>
466
423
<div class="variablelist"><table border="0">
467
424
<col align="left" valign="top">
468
425
<tbody><tr>
476
433
<hr>
477
434
<div class="refsect2" title="clutter_knot_equal ()">
478
435
<a name="clutter-knot-equal"></a><h3>clutter_knot_equal ()</h3>
479
 
<pre class="programlisting"><a
480
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
481
 
>gboolean</a>            clutter_knot_equal                  (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot_a,
482
 
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot">ClutterKnot</a> *knot_b);</pre>
 
436
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_knot_equal                  (const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot_a,
 
437
                                                         const <a class="link" href="ClutterBehaviourPath.html#ClutterKnot" title="ClutterKnot"><span class="returnvalue">ClutterKnot</span></a> *knot_b);</pre>
483
438
<p>
484
439
Compares to knot and checks if the point to the same location.</p>
485
 
<p>
486
 
</p>
487
440
<div class="variablelist"><table border="0">
488
441
<col align="left" valign="top">
489
442
<tbody>
499
452
</tr>
500
453
<tr>
501
454
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
502
 
<td> <a
503
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
504
 
><code class="literal">TRUE</code></a> if the knots point to the same location.
 
455
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the knots point to the same location.
505
456
 
506
457
</td>
507
458
</tr>
514
465
<a name="ClutterBehaviourPath.property-details"></a><h2>Property Details</h2>
515
466
<div class="refsect2" title='The "path" property'>
516
467
<a name="ClutterBehaviourPath--path"></a><h3>The <code class="literal">"path"</code> property</h3>
517
 
<pre class="programlisting">  "path"                     <a class="link" href="ClutterPath.html" title="ClutterPath">ClutterPath</a>*          : Read / Write</pre>
 
468
<pre class="programlisting">  "path"                     <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a>*          : Read / Write</pre>
518
469
<p>The ClutterPath object representing the path to animate along.</p>
519
470
</div>
520
471
</div>
522
473
<a name="ClutterBehaviourPath.signal-details"></a><h2>Signal Details</h2>
523
474
<div class="refsect2" title='The "knot-reached" signal'>
524
475
<a name="ClutterBehaviourPath-knot-reached"></a><h3>The <code class="literal">"knot-reached"</code> signal</h3>
525
 
<pre class="programlisting">void                user_function                      (<a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">ClutterBehaviourPath</a> *pathb,
526
 
                                                        <a
527
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
528
 
>guint</a>                 knot_num,
529
 
                                                        <a
530
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
531
 
>gpointer</a>              user_data)      : Run Last</pre>
 
476
<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,
 
477
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 knot_num,
 
478
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              user_data)      : Run Last</pre>
532
479
<p>
533
480
This signal is emitted each time a node defined inside the path
534
481
is reached.</p>
535
 
<p>
536
 
</p>
537
482
<div class="variablelist"><table border="0">
538
483
<col align="left" valign="top">
539
484
<tbody>
553
498
</tr>
554
499
</tbody>
555
500
</table></div>
556
 
<p>Since 0.2</p>
 
501
<p class="since">Since 0.2</p>
557
502
</div>
558
503
</div>
559
504
</div>
560
505
<div class="footer">
561
506
<hr>
562
 
          Generated by GTK-Doc V1.11</div>
 
507
          Generated by GTK-Doc V1.13</div>
563
508
</body>
564
 
</html>
 
509
</html>
 
 
b'\\ No newline at end of file'