Ignore:
Timestamp:
May 31, 2017, 3:54:26 PM (4 years ago)
Author:
Sanahuja Guillaume
Message:

doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/Flair/classflair_1_1filter_1_1_trajectory_generator2_d_circle.html

    r47 r50  
    141141<tr class="memdesc:ae669ea580ced854d4156ad4ecb7107de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ae669ea580ced854d4156ad4ecb7107de">More...</a><br /></td></tr>
    142142<tr class="separator:ae669ea580ced854d4156ad4ecb7107de"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143 <tr class="memitem:a5789f6cf4829447a33fc672261ab16ae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a5789f6cf4829447a33fc672261ab16ae">StartTraj</a> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;start_pos, float nb_lap=-1)</td></tr>
    144 <tr class="memdesc:a5789f6cf4829447a33fc672261ab16ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start trajectory.  <a href="#a5789f6cf4829447a33fc672261ab16ae">More...</a><br /></td></tr>
    145 <tr class="separator:a5789f6cf4829447a33fc672261ab16ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
     143<tr class="memitem:a637ce1ebabfb653a493314f707fa3ae4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a637ce1ebabfb653a493314f707fa3ae4">StartTraj</a> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;start_pos, float nb_lap=-1)</td></tr>
     144<tr class="memdesc:a637ce1ebabfb653a493314f707fa3ae4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start trajectory.  <a href="#a637ce1ebabfb653a493314f707fa3ae4">More...</a><br /></td></tr>
     145<tr class="separator:a637ce1ebabfb653a493314f707fa3ae4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    146146<tr class="memitem:afa7fb1b5ce2b0036b2eae7c1f3f27fb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#afa7fb1b5ce2b0036b2eae7c1f3f27fb1">StopTraj</a> (void)</td></tr>
    147147<tr class="memdesc:afa7fb1b5ce2b0036b2eae7c1f3f27fb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop trajectory.  <a href="#afa7fb1b5ce2b0036b2eae7c1f3f27fb1">More...</a><br /></td></tr>
     
    150150<tr class="memdesc:acad5ff3e2079054372a276e34c08fc2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish trajectory.  <a href="#acad5ff3e2079054372a276e34c08fc2a">More...</a><br /></td></tr>
    151151<tr class="separator:acad5ff3e2079054372a276e34c08fc2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    152 <tr class="memitem:a741d8a2f31ae41217e6a7aadcf2c1004"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a741d8a2f31ae41217e6a7aadcf2c1004">SetCenter</a> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;value)</td></tr>
    153 <tr class="memdesc:a741d8a2f31ae41217e6a7aadcf2c1004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set center position.  <a href="#a741d8a2f31ae41217e6a7aadcf2c1004">More...</a><br /></td></tr>
    154 <tr class="separator:a741d8a2f31ae41217e6a7aadcf2c1004"><td class="memSeparator" colspan="2">&#160;</td></tr>
    155 <tr class="memitem:ab834073fc2802bacf5e1ba38abce5c8b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#ab834073fc2802bacf5e1ba38abce5c8b">SetCenterSpeed</a> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;value)</td></tr>
    156 <tr class="memdesc:ab834073fc2802bacf5e1ba38abce5c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set center speed.  <a href="#ab834073fc2802bacf5e1ba38abce5c8b">More...</a><br /></td></tr>
    157 <tr class="separator:ab834073fc2802bacf5e1ba38abce5c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
     152<tr class="memitem:a3e99a6f66622cbf661c46e2bf65b70dc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a3e99a6f66622cbf661c46e2bf65b70dc">SetCenter</a> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;value)</td></tr>
     153<tr class="memdesc:a3e99a6f66622cbf661c46e2bf65b70dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set center position.  <a href="#a3e99a6f66622cbf661c46e2bf65b70dc">More...</a><br /></td></tr>
     154<tr class="separator:a3e99a6f66622cbf661c46e2bf65b70dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
     155<tr class="memitem:add30dea61dd67cf2cb2457d28fbad35c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#add30dea61dd67cf2cb2457d28fbad35c">SetCenterSpeed</a> (const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;value)</td></tr>
     156<tr class="memdesc:add30dea61dd67cf2cb2457d28fbad35c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set center speed.  <a href="#add30dea61dd67cf2cb2457d28fbad35c">More...</a><br /></td></tr>
     157<tr class="separator:add30dea61dd67cf2cb2457d28fbad35c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    158158<tr class="memitem:ab4c33fe719831488ce56b833c31dd426"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#ab4c33fe719831488ce56b833c31dd426">Update</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">core::Time</a> time)</td></tr>
    159159<tr class="memdesc:ab4c33fe719831488ce56b833c31dd426"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update using provided datas.  <a href="#ab4c33fe719831488ce56b833c31dd426">More...</a><br /></td></tr>
    160160<tr class="separator:ab4c33fe719831488ce56b833c31dd426"><td class="memSeparator" colspan="2">&#160;</td></tr>
    161 <tr class="memitem:aea95d0146447117762229550a11ad415"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#aea95d0146447117762229550a11ad415">GetPosition</a> (<a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;point) const </td></tr>
    162 <tr class="memdesc:aea95d0146447117762229550a11ad415"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position.  <a href="#aea95d0146447117762229550a11ad415">More...</a><br /></td></tr>
    163 <tr class="separator:aea95d0146447117762229550a11ad415"><td class="memSeparator" colspan="2">&#160;</td></tr>
    164 <tr class="memitem:ac95915bd0d1e21f744195d9e0543896e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#ac95915bd0d1e21f744195d9e0543896e">GetSpeed</a> (<a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;point) const </td></tr>
    165 <tr class="memdesc:ac95915bd0d1e21f744195d9e0543896e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Speed.  <a href="#ac95915bd0d1e21f744195d9e0543896e">More...</a><br /></td></tr>
    166 <tr class="separator:ac95915bd0d1e21f744195d9e0543896e"><td class="memSeparator" colspan="2">&#160;</td></tr>
     161<tr class="memitem:ae39218d67b655176c2d9b6679702c9c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#ae39218d67b655176c2d9b6679702c9c7">GetPosition</a> (<a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;point) const </td></tr>
     162<tr class="memdesc:ae39218d67b655176c2d9b6679702c9c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position.  <a href="#ae39218d67b655176c2d9b6679702c9c7">More...</a><br /></td></tr>
     163<tr class="separator:ae39218d67b655176c2d9b6679702c9c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
     164<tr class="memitem:a928d70f190300eb5a545940d2f5417be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a928d70f190300eb5a545940d2f5417be">GetSpeed</a> (<a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;point) const </td></tr>
     165<tr class="memdesc:a928d70f190300eb5a545940d2f5417be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Speed.  <a href="#a928d70f190300eb5a545940d2f5417be">More...</a><br /></td></tr>
     166<tr class="separator:a928d70f190300eb5a545940d2f5417be"><td class="memSeparator" colspan="2">&#160;</td></tr>
    167167<tr class="memitem:a2c4cd945efca8086a38a298407de1e56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a2c4cd945efca8086a38a298407de1e56">Matrix</a> (void) const </td></tr>
    168168<tr class="memdesc:a2c4cd945efca8086a38a298407de1e56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output matrix.  <a href="#a2c4cd945efca8086a38a298407de1e56">More...</a><br /></td></tr>
     
    187187<tr class="memdesc:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send the output to a shared memory.  <a href="#a12d811c6926fb86da6b47f889109da66">More...</a><br /></td></tr>
    188188<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     189<tr class="memitem:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#aee7828ae2eece2bace8e476dacc2bc12">IsReady</a> (void) const </td></tr>
     190<tr class="memdesc:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">is device ready  <a href="#aee7828ae2eece2bace8e476dacc2bc12">More...</a><br /></td></tr>
     191<tr class="separator:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    189192<tr class="memitem:a75e82ca2ae2fb7c39d973dd3d16bc698 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75e82ca2ae2fb7c39d973dd3d16bc698"></a>
    190193virtual <a class="el" href="classflair_1_1core_1_1_data_type.html">DataType</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetInputDataType</b> () const </td></tr>
     
    241244<tr class="memdesc:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process the childs of type <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>, and log if needed.  <a href="#a3df9057ae23eb34f1b1dae8e7a4a9efc">More...</a><br /></td></tr>
    242245<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     246<tr class="memitem:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a120fdcc3d50f6f076084cb6943fdf412">SetIsReady</a> (bool status)</td></tr>
     247<tr class="memdesc:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">set is ready  <a href="#a120fdcc3d50f6f076084cb6943fdf412">More...</a><br /></td></tr>
     248<tr class="separator:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    243249</table>
    244250<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
     
    247253 When trajectory is started (StartTraj), position and velocity will increase at the given acceleration untill maximum velocity is reached. <br />
    248254 When trajectory is asked to be finished (see <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#acad5ff3e2079054372a276e34c08fc2a" title="Finish trajectory. ">FinishTraj()</a>), position and velocity will decrease at the given acceleration untill null velocity is reached. <br />
    249  Position and velocity of the center of the circle can be manually changed through <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a741d8a2f31ae41217e6a7aadcf2c1004" title="Set center position. ">SetCenter()</a> and <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#ab834073fc2802bacf5e1ba38abce5c8b" title="Set center speed. ">SetCenterSpeed()</a>. </p>
     255 Position and velocity of the center of the circle can be manually changed through <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a3e99a6f66622cbf661c46e2bf65b70dc" title="Set center position. ">SetCenter()</a> and <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#add30dea61dd67cf2cb2457d28fbad35c" title="Set center speed. ">SetCenterSpeed()</a>. </p>
    250256</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    251257<a class="anchor" id="a103a8785df6c651962d71e5dfa937550"></a>
     
    304310</div>
    305311<h2 class="groupheader">Member Function Documentation</h2>
    306 <a class="anchor" id="a5789f6cf4829447a33fc672261ab16ae"></a>
     312<a class="anchor" id="a637ce1ebabfb653a493314f707fa3ae4"></a>
    307313<div class="memitem">
    308314<div class="memproto">
     
    311317          <td class="memname">void flair::filter::TrajectoryGenerator2DCircle::StartTraj </td>
    312318          <td>(</td>
    313           <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;&#160;</td>
     319          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;&#160;</td>
    314320          <td class="paramname"><em>start_pos</em>, </td>
    315321        </tr>
     
    377383</div>
    378384</div>
    379 <a class="anchor" id="a741d8a2f31ae41217e6a7aadcf2c1004"></a>
     385<a class="anchor" id="a3e99a6f66622cbf661c46e2bf65b70dc"></a>
    380386<div class="memitem">
    381387<div class="memproto">
     
    384390          <td class="memname">void flair::filter::TrajectoryGenerator2DCircle::SetCenter </td>
    385391          <td>(</td>
    386           <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;&#160;</td>
     392          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;&#160;</td>
    387393          <td class="paramname"><em>value</em></td><td>)</td>
    388394          <td></td>
     
    401407</div>
    402408</div>
    403 <a class="anchor" id="ab834073fc2802bacf5e1ba38abce5c8b"></a>
     409<a class="anchor" id="add30dea61dd67cf2cb2457d28fbad35c"></a>
    404410<div class="memitem">
    405411<div class="memproto">
     
    408414          <td class="memname">void flair::filter::TrajectoryGenerator2DCircle::SetCenterSpeed </td>
    409415          <td>(</td>
    410           <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;&#160;</td>
     416          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;&#160;</td>
    411417          <td class="paramname"><em>value</em></td><td>)</td>
    412418          <td></td>
     
    440446
    441447<p>Update using provided datas. </p>
    442 <p>Uses values specified by <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a5789f6cf4829447a33fc672261ab16ae" title="Start trajectory. ">StartTraj()</a>, <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a741d8a2f31ae41217e6a7aadcf2c1004" title="Set center position. ">SetCenter()</a> and <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#ab834073fc2802bacf5e1ba38abce5c8b" title="Set center speed. ">SetCenterSpeed()</a>.</p>
     448<p>Uses values specified by <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a637ce1ebabfb653a493314f707fa3ae4" title="Start trajectory. ">StartTraj()</a>, <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#a3e99a6f66622cbf661c46e2bf65b70dc" title="Set center position. ">SetCenter()</a> and <a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html#add30dea61dd67cf2cb2457d28fbad35c" title="Set center speed. ">SetCenterSpeed()</a>.</p>
    443449<dl class="params"><dt>Parameters</dt><dd>
    444450  <table class="params">
     
    450456</div>
    451457</div>
    452 <a class="anchor" id="aea95d0146447117762229550a11ad415"></a>
     458<a class="anchor" id="ae39218d67b655176c2d9b6679702c9c7"></a>
    453459<div class="memitem">
    454460<div class="memproto">
     
    457463          <td class="memname">void flair::filter::TrajectoryGenerator2DCircle::GetPosition </td>
    458464          <td>(</td>
    459           <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;&#160;</td>
     465          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;&#160;</td>
    460466          <td class="paramname"><em>point</em></td><td>)</td>
    461467          <td> const</td>
     
    474480</div>
    475481</div>
    476 <a class="anchor" id="ac95915bd0d1e21f744195d9e0543896e"></a>
     482<a class="anchor" id="a928d70f190300eb5a545940d2f5417be"></a>
    477483<div class="memitem">
    478484<div class="memproto">
     
    481487          <td class="memname">void flair::filter::TrajectoryGenerator2DCircle::GetSpeed </td>
    482488          <td>(</td>
    483           <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2D</a> &amp;&#160;</td>
     489          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_vector2_d.html">core::Vector2Df</a> &amp;&#160;</td>
    484490          <td class="paramname"><em>point</em></td><td>)</td>
    485491          <td> const</td>
     
    542548  <ul>
    543549    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1filter.html">filter</a></li><li class="navelem"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator2_d_circle.html">TrajectoryGenerator2DCircle</a></li>
    544     <li class="footer">Generated on Tue Jan 17 2017 09:52:31 for Flair by
     550    <li class="footer">Generated on Wed May 31 2017 13:50:37 for Flair by
    545551    <a href="http://www.doxygen.org/index.html">
    546552    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.