← 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/xml/clutter-behaviour-path.xml

  • 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/xml/clutter-behaviour-path.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version "1.0.8">
5
 
]>
6
 
 
7
 
<refentry id="ClutterBehaviourPath">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="ClutterBehaviourPath.top_of_page">ClutterBehaviourPath</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>CLUTTER Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>ClutterBehaviourPath</refname>
16
 
<refpurpose>A behaviour for moving actors along a <link linkend="ClutterPath"><type>ClutterPath</type></link></refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="ClutterBehaviourPath.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
                    <link linkend="ClutterBehaviourPath-struct">ClutterBehaviourPath</link>;
24
 
                    <link linkend="ClutterBehaviourPathClass">ClutterBehaviourPathClass</link>;
25
 
<link linkend="ClutterBehaviour">ClutterBehaviour</link> *  <link linkend="clutter-behaviour-path-new">clutter_behaviour_path_new</link>          (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
26
 
                                                         <link linkend="ClutterPath">ClutterPath</link> *path);
27
 
<link linkend="ClutterBehaviour">ClutterBehaviour</link> *  <link linkend="clutter-behaviour-path-new-with-description">clutter_behaviour_path_new_with_description</link>
28
 
                                                        (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
29
 
                                                         const <link linkend="gchar">gchar</link> *desc);
30
 
<link linkend="ClutterBehaviour">ClutterBehaviour</link> *  <link linkend="clutter-behaviour-path-new-with-knots">clutter_behaviour_path_new_with_knots</link>
31
 
                                                        (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
32
 
                                                         const <link linkend="ClutterKnot">ClutterKnot</link> *knots,
33
 
                                                         <link linkend="guint">guint</link> n_knots);
34
 
<link linkend="void">void</link>                <link linkend="clutter-behaviour-path-set-path">clutter_behaviour_path_set_path</link>     (<link linkend="ClutterBehaviourPath">ClutterBehaviourPath</link> *pathb,
35
 
                                                         <link linkend="ClutterPath">ClutterPath</link> *path);
36
 
<link linkend="ClutterPath">ClutterPath</link> *       <link linkend="clutter-behaviour-path-get-path">clutter_behaviour_path_get_path</link>     (<link linkend="ClutterBehaviourPath">ClutterBehaviourPath</link> *pathb);
37
 
 
38
 
                    <link linkend="ClutterKnot">ClutterKnot</link>;
39
 
<link linkend="ClutterKnot">ClutterKnot</link> *       <link linkend="clutter-knot-copy">clutter_knot_copy</link>                   (const <link linkend="ClutterKnot">ClutterKnot</link> *knot);
40
 
<link linkend="void">void</link>                <link linkend="clutter-knot-free">clutter_knot_free</link>                   (<link linkend="ClutterKnot">ClutterKnot</link> *knot);
41
 
<link linkend="gboolean">gboolean</link>            <link linkend="clutter-knot-equal">clutter_knot_equal</link>                  (const <link linkend="ClutterKnot">ClutterKnot</link> *knot_a,
42
 
                                                         const <link linkend="ClutterKnot">ClutterKnot</link> *knot_b);
43
 
</synopsis>
44
 
</refsynopsisdiv>
45
 
 
46
 
<refsect1 id="ClutterBehaviourPath.object-hierarchy" role="object_hierarchy">
47
 
<title role="object_hierarchy.title">Object Hierarchy</title>
48
 
<synopsis>
49
 
  <link linkend="GObject">GObject</link>
50
 
   +----<link linkend="ClutterBehaviour">ClutterBehaviour</link>
51
 
         +----ClutterBehaviourPath
52
 
</synopsis>
53
 
</refsect1>
54
 
 
55
 
 
56
 
 
57
 
<refsect1 id="ClutterBehaviourPath.implemented-interfaces" role="impl_interfaces">
58
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
59
 
<para>
60
 
ClutterBehaviourPath implements
61
 
 <link linkend="ClutterScriptable">ClutterScriptable</link>.</para>
62
 
</refsect1>
63
 
 
64
 
 
65
 
<refsect1 id="ClutterBehaviourPath.properties" role="properties">
66
 
<title role="properties.title">Properties</title>
67
 
<synopsis>
68
 
  &quot;<link linkend="ClutterBehaviourPath--path">path</link>&quot;                     <link linkend="ClutterPath">ClutterPath</link>*          : Read / Write
69
 
</synopsis>
70
 
</refsect1>
71
 
 
72
 
<refsect1 id="ClutterBehaviourPath.signals" role="signal_proto">
73
 
<title role="signal_proto.title">Signals</title>
74
 
<synopsis>
75
 
  &quot;<link linkend="ClutterBehaviourPath-knot-reached">knot-reached</link>&quot;                                   : Run Last
76
 
</synopsis>
77
 
</refsect1>
78
 
 
79
 
 
80
 
<refsect1 id="ClutterBehaviourPath.description" role="desc">
81
 
<title role="desc.title">Description</title>
82
 
<para>
83
 
<link linkend="ClutterBehaviourPath"><type>ClutterBehaviourPath</type></link> interpolates actors along a defined path.
84
 
</para>
85
 
<para>
86
 
A path is described by a <link linkend="ClutterPath"><type>ClutterPath</type></link> object. The path can contain
87
 
straight line parts and bezier curves. If the path contains
88
 
<link linkend="CLUTTER-PATH-MOVE-TO--CAPS"><literal>CLUTTER_PATH_MOVE_TO</literal></link> parts then the actors will jump to those
89
 
coordinates. This can be used make disjoint paths.
90
 
</para>
91
 
<para>
92
 
When creating a path behaviour in a <link linkend="ClutterScript"><type>ClutterScript</type></link>, you can specify
93
 
the path property directly as a string. For example:
94
 
</para>
95
 
<para>
96
 
<informalexample><programlisting>
97
 
{
98
 
  "id"     : "spline-path",
99
 
  "type"   : "ClutterBehaviourPath",
100
 
  "path"   : "M 50 50 L 100 100",
101
 
  "alpha"  : {
102
 
     "timeline" : "main-timeline",
103
 
     "function" : "ramp
104
 
   }
105
 
}
106
 
</programlisting></informalexample>
107
 
</para>
108
 
<para>
109
 
<note>If the alpha function is a periodic function, i.e. it returns to
110
 
0 after reaching <link linkend="CLUTTER-ALPHA-MAX-ALPHA--CAPS"><literal>CLUTTER_ALPHA_MAX_ALPHA</literal></link>, then the actors will walk
111
 
the path back to the starting <link linkend="ClutterKnot"><type>ClutterKnot</type></link>.</note>
112
 
</para>
113
 
<para>
114
 
<link linkend="ClutterBehaviourPath"><type>ClutterBehaviourPath</type></link> is available since Clutter 0.2</para>
115
 
<para>
116
 
</para>
117
 
</refsect1>
118
 
 
119
 
<refsect1 id="ClutterBehaviourPath.details" role="details">
120
 
<title role="details.title">Details</title>
121
 
<refsect2 id="ClutterBehaviourPath-struct" role="struct">
122
 
<title>ClutterBehaviourPath</title>
123
 
<indexterm zone="ClutterBehaviourPath-struct" role="0.2"><primary sortas="BehaviourPath">ClutterBehaviourPath</primary></indexterm><programlisting>typedef struct _ClutterBehaviourPath ClutterBehaviourPath;</programlisting>
124
 
<para>
125
 
The <link linkend="ClutterBehaviourPath"><type>ClutterBehaviourPath</type></link> structure contains only private data
126
 
and should be accessed using the provided API</para>
127
 
<para>
128
 
</para><para role="since">Since 0.2</para></refsect2>
129
 
<refsect2 id="ClutterBehaviourPathClass" role="struct">
130
 
<title>ClutterBehaviourPathClass</title>
131
 
<indexterm zone="ClutterBehaviourPathClass"><primary sortas="BehaviourPathClass">ClutterBehaviourPathClass</primary></indexterm><programlisting>typedef struct {
132
 
  void (*knot_reached) (ClutterBehaviourPath *pathb,
133
 
                        guint                 knot_num);
134
 
} ClutterBehaviourPathClass;
135
 
</programlisting>
136
 
<para>
137
 
The <link linkend="ClutterBehaviourPathClass"><type>ClutterBehaviourPathClass</type></link> struct contains only private data
138
 
</para>
139
 
<para>
140
 
Since 0.2</para>
141
 
<para>
142
 
</para><variablelist role="struct">
143
 
<varlistentry>
144
 
<term><structfield>knot_reached</structfield>&#160;()</term>
145
 
<listitem><simpara> signal class handler for the
146
 
  ClutterBehaviourPath::knot_reached signal
147
 
</simpara></listitem>
148
 
</varlistentry>
149
 
</variablelist></refsect2>
150
 
<refsect2 id="clutter-behaviour-path-new" role="function" condition="since:0.2">
151
 
<title>clutter_behaviour_path_new ()</title>
152
 
<indexterm zone="clutter-behaviour-path-new" role="0.2"><primary sortas="behaviour_path_new">clutter_behaviour_path_new</primary></indexterm><programlisting><link linkend="ClutterBehaviour">ClutterBehaviour</link> *  clutter_behaviour_path_new          (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
153
 
                                                         <link linkend="ClutterPath">ClutterPath</link> *path);</programlisting>
154
 
<para>
155
 
Creates a new path behaviour. You can use this behaviour to drive
156
 
actors along the nodes of a path, described by <parameter>path</parameter>.
157
 
</para>
158
 
<para>
159
 
This will claim the floating reference on the <link linkend="ClutterPath"><type>ClutterPath</type></link> so you
160
 
do not need to unref if it.</para>
161
 
<para>
162
 
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>alpha</parameter>&#160;:</term>
164
 
<listitem><simpara> a <link linkend="ClutterAlpha"><type>ClutterAlpha</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
167
 
<listitem><simpara> a <link linkend="ClutterPath"><type>ClutterPath</type></link> or <link linkend="NULL--CAPS"><literal>NULL</literal></link> for an empty path
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="ClutterBehaviour"><type>ClutterBehaviour</type></link>
170
 
 
171
 
</simpara></listitem></varlistentry>
172
 
</variablelist><para role="since">Since 0.2</para></refsect2>
173
 
<refsect2 id="clutter-behaviour-path-new-with-description" role="function" condition="since:1.0">
174
 
<title>clutter_behaviour_path_new_with_description ()</title>
175
 
<indexterm zone="clutter-behaviour-path-new-with-description" role="1.0"><primary sortas="behaviour_path_new_with_description">clutter_behaviour_path_new_with_description</primary></indexterm><programlisting><link linkend="ClutterBehaviour">ClutterBehaviour</link> *  clutter_behaviour_path_new_with_description
176
 
                                                        (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
177
 
                                                         const <link linkend="gchar">gchar</link> *desc);</programlisting>
178
 
<para>
179
 
Creates a new path behaviour using the path described by <parameter>desc</parameter>. See
180
 
<link linkend="clutter-path-add-string"><function>clutter_path_add_string()</function></link> for a description of the format.</para>
181
 
<para>
182
 
</para><variablelist role="params">
183
 
<varlistentry><term><parameter>alpha</parameter>&#160;:</term>
184
 
<listitem><simpara> a <link linkend="ClutterAlpha"><type>ClutterAlpha</type></link>
185
 
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><parameter>desc</parameter>&#160;:</term>
187
 
<listitem><simpara> a string description of the path
188
 
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="ClutterBehaviour"><type>ClutterBehaviour</type></link>
190
 
 
191
 
</simpara></listitem></varlistentry>
192
 
</variablelist><para role="since">Since 1.0</para></refsect2>
193
 
<refsect2 id="clutter-behaviour-path-new-with-knots" role="function" condition="since:1.0">
194
 
<title>clutter_behaviour_path_new_with_knots ()</title>
195
 
<indexterm zone="clutter-behaviour-path-new-with-knots" role="1.0"><primary sortas="behaviour_path_new_with_knots">clutter_behaviour_path_new_with_knots</primary></indexterm><programlisting><link linkend="ClutterBehaviour">ClutterBehaviour</link> *  clutter_behaviour_path_new_with_knots
196
 
                                                        (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
197
 
                                                         const <link linkend="ClutterKnot">ClutterKnot</link> *knots,
198
 
                                                         <link linkend="guint">guint</link> n_knots);</programlisting>
199
 
<para>
200
 
Creates a new path behaviour that will make the actors visit all of
201
 
the given knots in order with straight lines in between.
202
 
</para>
203
 
<para>
204
 
A path will be created where the first knot is used in a
205
 
<link linkend="CLUTTER-PATH-MOVE-TO--CAPS"><literal>CLUTTER_PATH_MOVE_TO</literal></link> and the subsequent knots are used in
206
 
<link linkend="CLUTTER-PATH-LINE-TO--CAPS"><literal>CLUTTER_PATH_LINE_TO</literal></link><!-- -->s.</para>
207
 
<para>
208
 
</para><variablelist role="params">
209
 
<varlistentry><term><parameter>alpha</parameter>&#160;:</term>
210
 
<listitem><simpara> a <link linkend="ClutterAlpha"><type>ClutterAlpha</type></link>
211
 
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>knots</parameter>&#160;:</term>
213
 
<listitem><simpara> an array of <link linkend="ClutterKnot"><type>ClutterKnot</type></link><!-- -->s
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>n_knots</parameter>&#160;:</term>
216
 
<listitem><simpara> number of entries in <parameter>knots</parameter>
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="ClutterBehaviour"><type>ClutterBehaviour</type></link>
219
 
 
220
 
</simpara></listitem></varlistentry>
221
 
</variablelist><para role="since">Since 1.0</para></refsect2>
222
 
<refsect2 id="clutter-behaviour-path-set-path" role="function" condition="since:1.0">
223
 
<title>clutter_behaviour_path_set_path ()</title>
224
 
<indexterm zone="clutter-behaviour-path-set-path" role="1.0"><primary sortas="behaviour_path_set_path">clutter_behaviour_path_set_path</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_behaviour_path_set_path     (<link linkend="ClutterBehaviourPath">ClutterBehaviourPath</link> *pathb,
225
 
                                                         <link linkend="ClutterPath">ClutterPath</link> *path);</programlisting>
226
 
<para>
227
 
Change the path that the actors will follow. This will take the
228
 
floating reference on the <link linkend="ClutterPath"><type>ClutterPath</type></link> so you do not need to unref
229
 
it.</para>
230
 
<para>
231
 
</para><variablelist role="params">
232
 
<varlistentry><term><parameter>pathb</parameter>&#160;:</term>
233
 
<listitem><simpara> the path behaviour
234
 
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
236
 
<listitem><simpara> the new path to follow
237
 
</simpara></listitem></varlistentry>
238
 
</variablelist><para role="since">Since 1.0</para></refsect2>
239
 
<refsect2 id="clutter-behaviour-path-get-path" role="function" condition="since:1.0">
240
 
<title>clutter_behaviour_path_get_path ()</title>
241
 
<indexterm zone="clutter-behaviour-path-get-path" role="1.0"><primary sortas="behaviour_path_get_path">clutter_behaviour_path_get_path</primary></indexterm><programlisting><link linkend="ClutterPath">ClutterPath</link> *       clutter_behaviour_path_get_path     (<link linkend="ClutterBehaviourPath">ClutterBehaviourPath</link> *pathb);</programlisting>
242
 
<para>
243
 
Get the current path of the behaviour</para>
244
 
<para>
245
 
</para><variablelist role="params">
246
 
<varlistentry><term><parameter>pathb</parameter>&#160;:</term>
247
 
<listitem><simpara> a <link linkend="ClutterBehaviourPath"><type>ClutterBehaviourPath</type></link> instance
248
 
</simpara></listitem></varlistentry>
249
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the path. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
250
 
</variablelist><para role="since">Since 1.0</para></refsect2>
251
 
<refsect2 id="ClutterKnot" role="struct" condition="since:0.2">
252
 
<title>ClutterKnot</title>
253
 
<indexterm zone="ClutterKnot" role="0.2"><primary sortas="Knot">ClutterKnot</primary></indexterm><programlisting>typedef struct {
254
 
  gint x;
255
 
  gint y;
256
 
} ClutterKnot;
257
 
</programlisting>
258
 
<para>
259
 
Point in a path behaviour.</para>
260
 
<para>
261
 
</para><variablelist role="struct">
262
 
<varlistentry>
263
 
<term><link linkend="gint">gint</link>&#160;<structfield>x</structfield>;</term>
264
 
<listitem><simpara> X coordinate of the knot
265
 
</simpara></listitem>
266
 
</varlistentry>
267
 
<varlistentry>
268
 
<term><link linkend="gint">gint</link>&#160;<structfield>y</structfield>;</term>
269
 
<listitem><simpara> Y coordinate of the knot
270
 
</simpara></listitem>
271
 
</varlistentry>
272
 
</variablelist><para role="since">Since 0.2</para></refsect2>
273
 
<refsect2 id="clutter-knot-copy" role="function" condition="since:0.2">
274
 
<title>clutter_knot_copy ()</title>
275
 
<indexterm zone="clutter-knot-copy" role="0.2"><primary sortas="knot_copy">clutter_knot_copy</primary></indexterm><programlisting><link linkend="ClutterKnot">ClutterKnot</link> *       clutter_knot_copy                   (const <link linkend="ClutterKnot">ClutterKnot</link> *knot);</programlisting>
276
 
<para>
277
 
Makes an allocated copy of a knot.</para>
278
 
<para>
279
 
</para><variablelist role="params">
280
 
<varlistentry><term><parameter>knot</parameter>&#160;:</term>
281
 
<listitem><simpara> a <link linkend="ClutterKnot"><type>ClutterKnot</type></link>
282
 
</simpara></listitem></varlistentry>
283
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the copied knot.
284
 
 
285
 
</simpara></listitem></varlistentry>
286
 
</variablelist><para role="since">Since 0.2</para></refsect2>
287
 
<refsect2 id="clutter-knot-free" role="function" condition="since:0.2">
288
 
<title>clutter_knot_free ()</title>
289
 
<indexterm zone="clutter-knot-free" role="0.2"><primary sortas="knot_free">clutter_knot_free</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_knot_free                   (<link linkend="ClutterKnot">ClutterKnot</link> *knot);</programlisting>
290
 
<para>
291
 
Frees the memory of an allocated knot.</para>
292
 
<para>
293
 
</para><variablelist role="params">
294
 
<varlistentry><term><parameter>knot</parameter>&#160;:</term>
295
 
<listitem><simpara> a <link linkend="ClutterKnot"><type>ClutterKnot</type></link>
296
 
</simpara></listitem></varlistentry>
297
 
</variablelist><para role="since">Since 0.2</para></refsect2>
298
 
<refsect2 id="clutter-knot-equal" role="function" condition="since:0.2">
299
 
<title>clutter_knot_equal ()</title>
300
 
<indexterm zone="clutter-knot-equal" role="0.2"><primary sortas="knot_equal">clutter_knot_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            clutter_knot_equal                  (const <link linkend="ClutterKnot">ClutterKnot</link> *knot_a,
301
 
                                                         const <link linkend="ClutterKnot">ClutterKnot</link> *knot_b);</programlisting>
302
 
<para>
303
 
Compares to knot and checks if the point to the same location.</para>
304
 
<para>
305
 
</para><variablelist role="params">
306
 
<varlistentry><term><parameter>knot_a</parameter>&#160;:</term>
307
 
<listitem><simpara> First knot
308
 
</simpara></listitem></varlistentry>
309
 
<varlistentry><term><parameter>knot_b</parameter>&#160;:</term>
310
 
<listitem><simpara> Second knot
311
 
</simpara></listitem></varlistentry>
312
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the knots point to the same location.
313
 
 
314
 
</simpara></listitem></varlistentry>
315
 
</variablelist><para role="since">Since 0.2</para></refsect2>
316
 
 
317
 
</refsect1>
318
 
<refsect1 id="ClutterBehaviourPath.property-details" role="property_details">
319
 
<title role="property_details.title">Property Details</title>
320
 
<refsect2 id="ClutterBehaviourPath--path" role="property"><title>The <literal>&quot;path&quot;</literal> property</title>
321
 
<indexterm zone="ClutterBehaviourPath--path"><primary sortas="BehaviourPath:path">ClutterBehaviourPath:path</primary></indexterm><programlisting>  &quot;path&quot;                     <link linkend="ClutterPath">ClutterPath</link>*          : Read / Write</programlisting>
322
 
<para>The ClutterPath object representing the path to animate along.</para></refsect2>
323
 
</refsect1>
324
 
 
325
 
<refsect1 id="ClutterBehaviourPath.signal-details" role="signals">
326
 
<title role="signals.title">Signal Details</title>
327
 
<refsect2 id="ClutterBehaviourPath-knot-reached" role="signal"><title>The <literal>&quot;knot-reached&quot;</literal> signal</title>
328
 
<indexterm zone="ClutterBehaviourPath-knot-reached" role="0.2"><primary sortas="BehaviourPath::knot-reached">ClutterBehaviourPath::knot-reached</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ClutterBehaviourPath">ClutterBehaviourPath</link> *pathb,
329
 
                                                        <link linkend="guint">guint</link>                 knot_num,
330
 
                                                        <link linkend="gpointer">gpointer</link>              user_data)      : Run Last</programlisting>
331
 
<para>
332
 
This signal is emitted each time a node defined inside the path
333
 
is reached.</para>
334
 
<para>
335
 
</para><variablelist role="params">
336
 
<varlistentry><term><parameter>pathb</parameter>&#160;:</term>
337
 
<listitem><simpara> the object which received the signal
338
 
</simpara></listitem></varlistentry>
339
 
<varlistentry><term><parameter>knot_num</parameter>&#160;:</term>
340
 
<listitem><simpara> the index of the <link linkend="ClutterPathKnot"><type>ClutterPathKnot</type></link> reached
341
 
</simpara></listitem></varlistentry>
342
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
343
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
344
 
</variablelist><para>Since 0.2</para></refsect2>
345
 
</refsect1>
346
 
 
347
 
 
348
 
 
349
 
</refentry>