doc/reference/clutter/html/ClutterBehaviourPath.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   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">
  13 </head>
  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">
  16 <tr valign="middle">
  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>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterBehaviourPath.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterBehaviourPath.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterBehaviourPath.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterBehaviourPath.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterBehaviourPath.properties" class="shortcut">Properties</a>
  33                    |
  34                   <a href="#ClutterBehaviourPath.signals" class="shortcut">Signals</a>
  35 </td></tr>
  36 </table>
  37 <div class="refentry">
  38 <a name="ClutterBehaviourPath"></a><div class="titlepage"></div>
  39 <div class="refnamediv"><table width="100%"><tr>
  40 <td valign="top">
  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>
  43 </td>
  44 <td valign="top" align="right"></td>
  45 </tr></table></div>
  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 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *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><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> 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>);
  62
  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 <a href="../glib/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>                  (<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>);
  68 </pre>
  69 </div>
  70 <div class="refsect1">
  71 <a name="ClutterBehaviourPath.object-hierarchy"></a><h2>Object Hierarchy</h2>
  72 <pre class="synopsis">
  73   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  74    +----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
  75          +----ClutterBehaviourPath
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="ClutterBehaviourPath.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  80 <p>
  81 ClutterBehaviourPath implements
  82  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
  83 </div>
  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
  88 </pre>
  89 </div>
  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>"                                   : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  94 </pre>
  95 </div>
  96 <div class="refsect1">
  97 <a name="ClutterBehaviourPath.description"></a><h2>Description</h2>
  98 <p>
  99 <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> interpolates actors along a defined path.
 100 </p>
 101 <p>
 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.
 106 </p>
 107 <p>
 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:
 110 </p>
 111 <p>
 112 </p>
 113 <div class="informalexample">
 114   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 115     <tbody>
 116       <tr>
 117         <td class="listing_lines" align="right"><pre>1
 118 2
 119 3
 120 4
 121 5
 122 6
 123 7
 124 8
 125 9</pre></td>
 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>
 135       </tr>
 136     </tbody>
 137   </table>
 138 </div>
 139
 140 <p>
 141 </p>
 142 <p>
 143 </p>
 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>
 148 <p>
 149 </p>
 150 <p>
 151 <a class="link" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath"><span class="type">ClutterBehaviourPath</span></a> is available since Clutter 0.2
 152 </p>
 153 </div>
 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>
 162   instead.</p>
 163 </div>
 164 <p>
 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
 167 </p>
 168 <p class="since">Since 0.2</p>
 169 </div>
 170 <hr>
 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,
 175                         guint                 knot_num);
 176 };
 177 </pre>
 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>
 181 </div>
 182 <p>
 183 The <a class="link" href="ClutterBehaviourPath.html#ClutterBehaviourPathClass" title="struct ClutterBehaviourPathClass"><span class="type">ClutterBehaviourPathClass</span></a> struct contains only private data
 184 </p>
 185 <div class="variablelist"><table border="0">
 186 <col align="left" valign="top">
 187 <tbody><tr>
 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>
 191 </tr></tbody>
 192 </table></div>
 193 <p class="since">Since 0.2</p>
 194 </div>
 195 <hr>
 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>
 203 </div>
 204 <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>.
 207 </p>
 208 <p>
 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.
 211 </p>
 212 <p>
 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>.
 216 </p>
 217 <div class="variablelist"><table border="0">
 218 <col align="left" valign="top">
 219 <tbody>
 220 <tr>
 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>
 223 </td>
 224 </tr>
 225 <tr>
 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>
 228 </tr>
 229 <tr>
 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>
 232 </td>
 233 </tr>
 234 </tbody>
 235 </table></div>
 236 <p class="since">Since 0.2</p>
 237 </div>
 238 <hr>
 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 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *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>
 247 </div>
 248 <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.
 251 </p>
 252 <p>
 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>.
 256 </p>
 257 <div class="variablelist"><table border="0">
 258 <col align="left" valign="top">
 259 <tbody>
 260 <tr>
 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>
 263 </td>
 264 </tr>
 265 <tr>
 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>
 268 </tr>
 269 <tr>
 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>
 272 </td>
 273 </tr>
 274 </tbody>
 275 </table></div>
 276 <p class="since">Since 1.0</p>
 277 </div>
 278 <hr>
 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><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> 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>
 288 </div>
 289 <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.
 292 </p>
 293 <p>
 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.
 297 </p>
 298 <p>
 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>.
 302 </p>
 303 <div class="variablelist"><table border="0">
 304 <col align="left" valign="top">
 305 <tbody>
 306 <tr>
 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>
 309 </td>
 310 </tr>
 311 <tr>
 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>
 314 </td>
 315 </tr>
 316 <tr>
 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>
 319 </td>
 320 </tr>
 321 <tr>
 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>
 324 </td>
 325 </tr>
 326 </tbody>
 327 </table></div>
 328 <p class="since">Since 1.0</p>
 329 </div>
 330 <hr>
 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>
 338 </div>
 339 <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
 342 it.
 343 </p>
 344 <div class="variablelist"><table border="0">
 345 <col align="left" valign="top">
 346 <tbody>
 347 <tr>
 348 <td><p><span class="term"><em class="parameter"><code>pathb</code></em> :</span></p></td>
 349 <td>the path behaviour</td>
 350 </tr>
 351 <tr>
 352 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
 353 <td>the new path to follow</td>
 354 </tr>
 355 </tbody>
 356 </table></div>
 357 <p class="since">Since 1.0</p>
 358 </div>
 359 <hr>
 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>
 366 </div>
 367 <p>
 368 Get the current path of the behaviour
 369 </p>
 370 <div class="variablelist"><table border="0">
 371 <col align="left" valign="top">
 372 <tbody>
 373 <tr>
 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>
 376 </tr>
 377 <tr>
 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>
 380 </td>
 381 </tr>
 382 </tbody>
 383 </table></div>
 384 <p class="since">Since 1.0</p>
 385 </div>
 386 <hr>
 387 <div class="refsect2">
 388 <a name="ClutterKnot"></a><h3>struct ClutterKnot</h3>
 389 <pre class="programlisting">struct ClutterKnot {
 390   gint x;
 391   gint y;
 392 };
 393 </pre>
 394 <p>
 395 Point in a path behaviour.
 396 </p>
 397 <div class="variablelist"><table border="0">
 398 <col align="left" valign="top">
 399 <tbody>
 400 <tr>
 401 <td><p><span class="term"><a href="../glib/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>
 402 <td>X coordinate of the knot</td>
 403 </tr>
 404 <tr>
 405 <td><p><span class="term"><a href="../glib/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>
 406 <td>Y coordinate of the knot</td>
 407 </tr>
 408 </tbody>
 409 </table></div>
 410 <p class="since">Since 0.2</p>
 411 </div>
 412 <hr>
 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>
 416 <p>
 417 Makes an allocated copy of a knot.
 418 </p>
 419 <div class="variablelist"><table border="0">
 420 <col align="left" valign="top">
 421 <tbody>
 422 <tr>
 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>
 425 </td>
 426 </tr>
 427 <tr>
 428 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 429 <td>the copied knot.</td>
 430 </tr>
 431 </tbody>
 432 </table></div>
 433 <p class="since">Since 0.2</p>
 434 </div>
 435 <hr>
 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>
 439 <p>
 440 Frees the memory of an allocated knot.
 441 </p>
 442 <div class="variablelist"><table border="0">
 443 <col align="left" valign="top">
 444 <tbody><tr>
 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>
 447 </td>
 448 </tr></tbody>
 449 </table></div>
 450 <p class="since">Since 0.2</p>
 451 </div>
 452 <hr>
 453 <div class="refsect2">
 454 <a name="clutter-knot-equal"></a><h3>clutter_knot_equal ()</h3>
 455 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>
 457 <p>
 458 Compares to knot and checks if the point to the same location.
 459 </p>
 460 <div class="variablelist"><table border="0">
 461 <col align="left" valign="top">
 462 <tbody>
 463 <tr>
 464 <td><p><span class="term"><em class="parameter"><code>knot_a</code></em> :</span></p></td>
 465 <td>First knot</td>
 466 </tr>
 467 <tr>
 468 <td><p><span class="term"><em class="parameter"><code>knot_b</code></em> :</span></p></td>
 469 <td>Second knot</td>
 470 </tr>
 471 <tr>
 472 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 473 <td>
 474 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the knots point to the same location.</td>
 475 </tr>
 476 </tbody>
 477 </table></div>
 478 <p class="since">Since 0.2</p>
 479 </div>
 480 </div>
 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>
 487 </div>
 488 </div>
 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                                                         <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 knot_num,
 495                                                         <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              user_data)      : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></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>
 499 </div>
 500 <p>
 501 This signal is emitted each time a node defined inside the path
 502 is reached.
 503 </p>
 504 <div class="variablelist"><table border="0">
 505 <col align="left" valign="top">
 506 <tbody>
 507 <tr>
 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>
 510 </tr>
 511 <tr>
 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>
 514 </tr>
 515 <tr>
 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>
 518 </tr>
 519 </tbody>
 520 </table></div>
 521 <p class="since">Since 0.2</p>
 522 </div>
 523 </div>
 524 </div>
 525 <div class="footer">
 526 <hr>
 527           Generated by GTK-Doc V1.18.1</div>
 528 </body>
 529 </html>