/usr/share/gtk-doc/html/clutter/ClutterBehaviourPath.html is in libclutter-1.0-doc 1.24.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterBehaviourPath: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="deprecated.html" title="Part X. Deprecated Classes">
<link rel="prev" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">
<link rel="next" href="ClutterBehaviourRotate.html" title="ClutterBehaviourRotate">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterBehaviourPath.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterBehaviourPath.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterBehaviourPath.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterBehaviourPath.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#ClutterBehaviourPath.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="deprecated.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterBehaviourOpacity.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterBehaviourRotate.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterBehaviourPath"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterBehaviourPath.top_of_page"></a>ClutterBehaviourPath</span></h2>
<p>ClutterBehaviourPath — A behaviour for moving actors along a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterBehaviourPath.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-new" title="clutter_behaviour_path_new ()">clutter_behaviour_path_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-set-path" title="clutter_behaviour_path_set_path ()">clutter_behaviour_path_set_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterPath.html" title="ClutterPath"><span class="returnvalue">ClutterPath</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterBehaviourPath.html#clutter-behaviour-path-get-path" title="clutter_behaviour_path_get_path ()">clutter_behaviour_path_get_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath--path" title="The “path” property">path</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath-knot-reached" title="The “knot-reached” signal">knot-reached</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPath-struct" title="struct ClutterBehaviourPath">ClutterBehaviourPath</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="struct ClutterBehaviourPathClass">ClutterBehaviourPathClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
<span class="lineart">╰──</span> ClutterBehaviourPath
</pre>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterBehaviourPath implements
<a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> interpolates actors along a defined path.</p>
<p>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
straight line parts and bezier curves. If the path contains
<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
coordinates. This can be used make disjoint paths.</p>
<p>When creating a path behaviour in a <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>, you can specify
the path property directly as a string. For example:</p>
<div class="informalexample"><pre class="programlisting">
{
"id" : "spline-path",
"type" : "ClutterBehaviourPath",
"path" : "M 50 50 L 100 100",
"alpha" : {
"timeline" : "main-timeline",
"function" : "ramp
}
}
</pre></div>
<p></p>
<p>If the alpha function is a periodic function, i.e. it returns to
0.0 after reaching 1.0, then the actors will walk the path back to the
starting <a class="link" href="clutter-Base-geometric-types.html#ClutterKnot"><span class="type">ClutterKnot</span></a>.</p>
<p><a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> is available since Clutter 0.2</p>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-behaviour-path-new"></a><h3>clutter_behaviour_path_new ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_path_new</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Creates a new path behaviour. You can use this behaviour to drive
actors along the nodes of a path, described by <em class="parameter"><code>path</code></em>
.</p>
<p>This will claim the 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 if it.</p>
<p>If <em class="parameter"><code>alpha</code></em>
is not <code class="literal">NULL</code>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
of the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance. In the case when <em class="parameter"><code>alpha</code></em>
is <code class="literal">NULL</code>,
it can be set later with <a class="link" href="ClutterBehaviour.html#clutter-behaviour-set-alpha" title="clutter_behaviour_set_alpha ()"><code class="function">clutter_behaviour_set_alpha()</code></a>.</p>
<div class="refsect3">
<a name="id-1.11.9.10.2.9"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>alpha</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> or <code class="literal">NULL</code> for an empty path</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.11.9.10.2.10"></a><h4>Returns</h4>
<p> a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-path-new-with-description"></a><h3>clutter_behaviour_path_new_with_description ()</h3>
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
clutter_behaviour_path_new_with_description
(<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *desc</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_path_new_with_description</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Creates a new path behaviour using the path described by <em class="parameter"><code>desc</code></em>
. See
<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>
<p>If <em class="parameter"><code>alpha</code></em>
is not <code class="literal">NULL</code>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
of the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance. In the case when <em class="parameter"><code>alpha</code></em>
is <code class="literal">NULL</code>,
it can be set later with <a class="link" href="ClutterBehaviour.html#clutter-behaviour-set-alpha" title="clutter_behaviour_set_alpha ()"><code class="function">clutter_behaviour_set_alpha()</code></a>.</p>
<div class="refsect3">
<a name="id-1.11.9.10.3.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>alpha</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>desc</p></td>
<td class="parameter_description"><p>a string description of the path</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.11.9.10.3.9"></a><h4>Returns</h4>
<p> a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-path-new-with-knots"></a><h3>clutter_behaviour_path_new_with_knots ()</h3>
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
clutter_behaviour_path_new_with_knots (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Base-geometric-types.html#ClutterKnot"><span class="type">ClutterKnot</span></a> *knots</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_knots</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_path_new_with_knots</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Creates a new path behaviour that will make the actors visit all of
the given knots in order with straight lines in between.</p>
<p>A path will be created where the first knot is used in a
<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
<a class="link" href="ClutterPath.html#CLUTTER-PATH-LINE-TO:CAPS"><code class="literal">CLUTTER_PATH_LINE_TO</code></a>s.</p>
<p>If <em class="parameter"><code>alpha</code></em>
is not <code class="literal">NULL</code>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
of the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance. In the case when <em class="parameter"><code>alpha</code></em>
is <code class="literal">NULL</code>,
it can be set later with <a class="link" href="ClutterBehaviour.html#clutter-behaviour-set-alpha" title="clutter_behaviour_set_alpha ()"><code class="function">clutter_behaviour_set_alpha()</code></a>.</p>
<div class="refsect3">
<a name="id-1.11.9.10.4.9"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>alpha</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>knots</p></td>
<td class="parameter_description"><p> an array of <a class="link" href="clutter-Base-geometric-types.html#ClutterKnot"><span class="type">ClutterKnot</span></a>s. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_knots]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_knots</p></td>
<td class="parameter_description"><p>number of entries in <em class="parameter"><code>knots</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.11.9.10.4.10"></a><h4>Returns</h4>
<p> a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-path-set-path"></a><h3>clutter_behaviour_path_set_path ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *path</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_path_set_path</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Change the path that the actors will follow. This will take the
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
it.</p>
<div class="refsect3">
<a name="id-1.11.9.10.5.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pathb</p></td>
<td class="parameter_description"><p>the path behaviour</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>the new path to follow</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-path-get-path"></a><h3>clutter_behaviour_path_get_path ()</h3>
<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>
<div class="warning"><p><code class="literal">clutter_behaviour_path_get_path</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Get the current path of the behaviour</p>
<div class="refsect3">
<a name="id-1.11.9.10.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>pathb</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.11.9.10.6.8"></a><h4>Returns</h4>
<p> the path. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterBehaviourPath-struct"></a><h3>struct ClutterBehaviourPath</h3>
<pre class="programlisting">struct ClutterBehaviourPath;</pre>
<div class="warning">
<p><code class="literal">ClutterBehaviourPath</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>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>
instead.</p>
</div>
<p>The <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBehaviourPathClass"></a><h3>struct ClutterBehaviourPathClass</h3>
<pre class="programlisting">struct ClutterBehaviourPathClass {
void (*knot_reached) (ClutterBehaviourPath *pathb,
guint knot_num);
};
</pre>
<div class="warning"><p><code class="literal">ClutterBehaviourPathClass</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>The <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="struct ClutterBehaviourPathClass"><span class="type">ClutterBehaviourPathClass</span></a> struct contains only private data</p>
<div class="refsect3">
<a name="id-1.11.9.11.3.7"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterBehaviourPathClass.knot-reached"></a>knot_reached</code></em> ()</p></td>
<td class="struct_member_description"><p>signal class handler for the
ClutterBehaviourPath::knot_reached signal</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterBehaviourPath--path"></a><h3>The <code class="literal">“path”</code> property</h3>
<pre class="programlisting"> “path” <a class="link" href="ClutterPath.html" title="ClutterPath"><span class="type">ClutterPath</span></a> *</pre>
<p>The ClutterPath object representing the path to animate along.</p>
<p>Flags: Read / Write</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourPath.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterBehaviourPath-knot-reached"></a><h3>The <code class="literal">“knot-reached”</code> signal</h3>
<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,
<span class="type">guint</span> knot_num,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted each time a node defined inside the path
is reached.</p>
<div class="warning"><p><code class="literal">ClutterBehaviourPath::knot-reached</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<div class="refsect3">
<a name="id-1.11.9.13.2.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pathb</p></td>
<td class="parameter_description"><p>the object which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>knot_num</p></td>
<td class="parameter_description"><p>the index of the <a class="link" href="clutter-Base-geometric-types.html#ClutterKnot"><span class="type">ClutterKnot</span></a> reached</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|