📄 classvtanimpathengine.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>vtlib library: vtAnimPathEngine Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.4.5 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li id="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><h1>vtAnimPathEngine Class Reference<br><small>[<a class="el" href="group__nav.html">Navigation</a>]</small></h1><!-- doxytag: class="vtAnimPathEngine" --><!-- doxytag: inherits="vtEngine" -->Inheritance diagram for vtAnimPathEngine:<p><center><img src="classvtAnimPathEngine__inherit__graph.png" border="0" usemap="#vtAnimPathEngine__inherit__map" alt="Inheritance graph"></center><map name="vtAnimPathEngine__inherit__map"><area href="classvtEngine.html" shape="rect" coords="36,81,111,108" alt=""><area href="classvtEnabledBase.html" shape="rect" coords="18,7,130,33" alt=""></map><center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classvtAnimPathEngine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>This class connects a path (<a class="el" href="classvtAnimPath.html">vtAnimPath</a>) to any number of targets. The targets can be any transform (such as scene graph object or camera) which will be moved along the path based on time.<p>Speed is relative. For example, calling SetSpeed(2.0) means that an animation path with control points from 0 to 10 seconds will be played in 5 seconds. Default speed is 1.0.<p>Other aspects of playback you can control include continuous play (SetContinuous) and position only (SetPosOnly) which is useful if you want to move a camera along a path but allow the user to freely look around. <p><table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab2814d604f302812ac604dab194c9b6"></a><!-- doxytag: member="vtAnimPathEngine::SetAnimationPath" ref="ab2814d604f302812ac604dab194c9b6" args="(vtAnimPath *path)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#ab2814d604f302812ac604dab194c9b6">SetAnimationPath</a> (<a class="el" href="classvtAnimPath.html">vtAnimPath</a> *path)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the animation path for this engine to use. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d559bc612421d577ad9a2d54c188ab7"></a><!-- doxytag: member="vtAnimPathEngine::GetAnimationPath" ref="3d559bc612421d577ad9a2d54c188ab7" args="()" --><a class="el" href="classvtAnimPath.html">vtAnimPath</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#3d559bc612421d577ad9a2d54c188ab7">GetAnimationPath</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the animation path associated with this engine. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0dff7193abb5a7df2efbd494e9bdd444"></a><!-- doxytag: member="vtAnimPathEngine::GetAnimationPath" ref="0dff7193abb5a7df2efbd494e9bdd444" args="() const " -->const <a class="el" href="classvtAnimPath.html">vtAnimPath</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#0dff7193abb5a7df2efbd494e9bdd444">GetAnimationPath</a> () const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the animation path associated with this engine. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#723c2e35b3e2fa578261be72c871f300">Reset</a> ()</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="95ea521accb562c1d379cf11d6497dd9"></a><!-- doxytag: member="vtAnimPathEngine::SetSpeed" ref="95ea521accb562c1d379cf11d6497dd9" args="(float fSpeed)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#95ea521accb562c1d379cf11d6497dd9">SetSpeed</a> (float fSpeed)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Set the play speed, in time units per second. Default is 1.0. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14ef3b5111ee94fb71785ff93a7dcdca"></a><!-- doxytag: member="vtAnimPathEngine::GetSpeed" ref="14ef3b5111ee94fb71785ff93a7dcdca" args="() const " -->float </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#14ef3b5111ee94fb71785ff93a7dcdca">GetSpeed</a> () const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Get the play speed. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#bf4b495163af7524abd61aa969e8d6bd">SetContinuous</a> (bool bFlag)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ace39f0c590d6812756b0f895d35aebd"></a><!-- doxytag: member="vtAnimPathEngine::GetContinuous" ref="ace39f0c590d6812756b0f895d35aebd" args="() const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#ace39f0c590d6812756b0f895d35aebd">GetContinuous</a> () const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if set for continuous play. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#cd0420566d1007f384c3ab29f14293f5">SetPosOnly</a> (bool bFlag)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="721eb2aafe610a8eb40a2f49698f5c3e"></a><!-- doxytag: member="vtAnimPathEngine::GetPosOnly" ref="721eb2aafe610a8eb40a2f49698f5c3e" args="() const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#721eb2aafe610a8eb40a2f49698f5c3e">GetPosOnly</a> () const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if set to use position only. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11732384f35d882f068fe5920d53099d"></a><!-- doxytag: member="vtAnimPathEngine::Eval" ref="11732384f35d882f068fe5920d53099d" args="()" -->virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#11732384f35d882f068fe5920d53099d">Eval</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual handler, will be called every frame to do the work of the engine. <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#a9b8f1d127c5b64d6b0076164d1f23c7">SetTime</a> (float fTime)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classvtAnimPathEngine.html#e9dda391e2c3dedde6558ffcc4071026">GetTime</a> ()</td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="e9dda391e2c3dedde6558ffcc4071026"></a><!-- doxytag: member="vtAnimPathEngine::GetTime" ref="e9dda391e2c3dedde6558ffcc4071026" args="()" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">float vtAnimPathEngine::GetTime </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Set the play time, which will be in the range of 0.0 to the length of the animation path. </td> </tr></table><a class="anchor" name="723c2e35b3e2fa578261be72c871f300"></a><!-- doxytag: member="vtAnimPathEngine::Reset" ref="723c2e35b3e2fa578261be72c871f300" args="()" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void vtAnimPathEngine::Reset </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Set the engine back to the beginning of its path (time = 0). This will affect the targets the next time <a class="el" href="classvtAnimPathEngine.html#11732384f35d882f068fe5920d53099d">Eval()</a> or UpdateTargets() is called. </td> </tr></table><a class="anchor" name="bf4b495163af7524abd61aa969e8d6bd"></a><!-- doxytag: member="vtAnimPathEngine::SetContinuous" ref="bf4b495163af7524abd61aa969e8d6bd" args="(bool bFlag)" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void vtAnimPathEngine::SetContinuous </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">bool </td> <td class="mdname1" valign="top" nowrap> <em>bFlag</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Set to true for continuous play, meaning that each time it reaches the end of the animation path, it continues from the beginning without stopping. </td> </tr></table><a class="anchor" name="cd0420566d1007f384c3ab29f14293f5"></a><!-- doxytag: member="vtAnimPathEngine::SetPosOnly" ref="cd0420566d1007f384c3ab29f14293f5" args="(bool bFlag)" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void vtAnimPathEngine::SetPosOnly </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">bool </td> <td class="mdname1" valign="top" nowrap> <em>bFlag</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Set to true for play to ignore the orientation of the animation path, so that only the position of the targets is affected. </td> </tr></table><a class="anchor" name="a9b8f1d127c5b64d6b0076164d1f23c7"></a><!-- doxytag: member="vtAnimPathEngine::SetTime" ref="a9b8f1d127c5b64d6b0076164d1f23c7" args="(float fTime)" --><p><table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void vtAnimPathEngine::SetTime </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">float </td> <td class="mdname1" valign="top" nowrap> <em>fTime</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr></table><table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td><p>Set the play time, which should be in the range of 0.0 to the length of the animation path. This will affect the targets the next time <a class="el" href="classvtAnimPathEngine.html#11732384f35d882f068fe5920d53099d">Eval()</a> or UpdateTargets() is called. </td> </tr></table><hr size="1"><address style="align: right;"><small>Generated on Mon Jan 14 14:41:00 2008 for vtlib library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -