aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_animator.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_animator.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_animator.html325
1 files changed, 325 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_animator.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_animator.html
new file mode 100644
index 0000000..cda9af4
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_scene_node_animator.html
@@ -0,0 +1,325 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::scene::ISceneNodeAnimator Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1scene_1_1_i_scene_node_animator.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> </div>
89 <div class="headertitle">
90<div class="title">irr::scene::ISceneNodeAnimator Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::scene::ISceneNodeAnimator" --><!-- doxytag: inherits="irr::io::IAttributeExchangingObject,irr::IEventReceiver" -->
94<p>Animates a scene node. Can animate position, rotation, material, and so on.
95 <a href="classirr_1_1scene_1_1_i_scene_node_animator.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_scene_node_animator_8h_source.html">ISceneNodeAnimator.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::scene::ISceneNodeAnimator:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1scene_1_1_i_scene_node_animator.png" usemap="#irr::scene::ISceneNodeAnimator_map" alt=""/>
105 <map id="irr::scene::ISceneNodeAnimator_map" name="irr::scene::ISceneNodeAnimator_map">
106<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" title="An object which is able to serialize and deserialize its attributes into an attributes object..." alt="irr::io::IAttributeExchangingObject" shape="rect" coords="151,56,444,80"/>
107<area href="classirr_1_1_i_event_receiver.html" title="Interface of an object which can receive events." alt="irr::IEventReceiver" shape="rect" coords="454,56,747,80"/>
108<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="151,0,444,24"/>
109<area href="classirr_1_1scene_1_1_i_scene_node_animator_camera_f_p_s.html" title="Special scene node animator for FPS cameras." alt="irr::scene::ISceneNodeAnimatorCameraFPS" shape="rect" coords="0,168,293,192"/>
110<area href="classirr_1_1scene_1_1_i_scene_node_animator_camera_maya.html" title="Special scene node animator for Maya-style cameras." alt="irr::scene::ISceneNodeAnimatorCameraMaya" shape="rect" coords="303,168,596,192"/>
111<area href="classirr_1_1scene_1_1_i_scene_node_animator_collision_response.html" title="Special scene node animator for doing automatic collision detection and response." alt="irr::scene::ISceneNodeAnimatorCollisionResponse" shape="rect" coords="606,168,899,192"/>
112</map>
113 </div></div>
114
115<p><a href="classirr_1_1scene_1_1_i_scene_node_animator-members.html">List of all members.</a></p>
116<h2><a name="pub-methods"></a>
117Public Member Functions</h2>
118<ul>
119<li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html#ab2170d133db16de148d0f6841c06bc84">animateNode</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *node, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> timeMs)=0
120<dl class="el"><dd class="mdescRight">Animates a scene node. <a href="#ab2170d133db16de148d0f6841c06bc84"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html">ISceneNodeAnimator</a> * <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html#a9cc261c12459fc7d3da6c2595d721c0d">createClone</a> (<a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *node, <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html">ISceneManager</a> *newManager=0)=0
121<dl class="el"><dd class="mdescRight">Creates a clone of this animator. <a href="#a9cc261c12459fc7d3da6c2595d721c0d"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1scene.html#a327a1e43872705cf8f3f3342fb307d19">ESCENE_NODE_ANIMATOR_TYPE</a> <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html#aeed52b1fb289dcf456867b3916076cac">getType</a> () const
122<dl class="el"><dd class="mdescRight">Returns type of the scene node animator. <a href="#aeed52b1fb289dcf456867b3916076cac"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html#a2ea0caa26a5d377fa438dc7c836731fd">hasFinished</a> (void) const
123<dl class="el"><dd class="mdescRight">Returns if the animator has finished. <a href="#a2ea0caa26a5d377fa438dc7c836731fd"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html#a75c9e4eb1fa1af868034678fdcdbe15b">isEventReceiverEnabled</a> () const
124<dl class="el"><dd class="mdescRight">Returns true if this animator receives events. <a href="#a75c9e4eb1fa1af868034678fdcdbe15b"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html#aca20b841bb586cd9654464b001a7b6aa">OnEvent</a> (const <a class="el" href="structirr_1_1_s_event.html">SEvent</a> &amp;event)
125<dl class="el"><dd class="mdescRight">Event receiver, override this function for camera controlling animators. <a href="#aca20b841bb586cd9654464b001a7b6aa"></a><br/></dl></ul>
126<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
127<div class="textblock"><p>Animates a scene node. Can animate position, rotation, material, and so on. </p>
128<p>A scene node animator is able to animate a scene node in a very simple way. It may change its position, rotation, scale and/or material. There are lots of animators to choose from. You can create scene node animators with the <a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html" title="The Scene Manager manages scene nodes, mesh recources, cameras and all the other stuff.">ISceneManager</a> interface. </p>
129
130<p>Definition at line <a class="el" href="_i_scene_node_animator_8h_source.html#l00030">30</a> of file <a class="el" href="_i_scene_node_animator_8h_source.html">ISceneNodeAnimator.h</a>.</p>
131</div><hr/><h2>Member Function Documentation</h2>
132<a class="anchor" id="ab2170d133db16de148d0f6841c06bc84"></a><!-- doxytag: member="irr::scene::ISceneNodeAnimator::animateNode" ref="ab2170d133db16de148d0f6841c06bc84" args="(ISceneNode *node, u32 timeMs)=0" -->
133<div class="memitem">
134<div class="memproto">
135 <table class="memname">
136 <tr>
137 <td class="memname">virtual void irr::scene::ISceneNodeAnimator::animateNode </td>
138 <td>(</td>
139 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *&#160;</td>
140 <td class="paramname"><em>node</em>, </td>
141 </tr>
142 <tr>
143 <td class="paramkey"></td>
144 <td></td>
145 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
146 <td class="paramname"><em>timeMs</em>&#160;</td>
147 </tr>
148 <tr>
149 <td></td>
150 <td>)</td>
151 <td></td><td><code> [pure virtual]</code></td>
152 </tr>
153 </table>
154</div>
155<div class="memdoc">
156
157<p>Animates a scene node. </p>
158<dl><dt><b>Parameters:</b></dt><dd>
159 <table class="params">
160 <tr><td class="paramname">node</td><td>Node to animate. </td></tr>
161 <tr><td class="paramname">timeMs</td><td>Current time in milli seconds. </td></tr>
162 </table>
163 </dd>
164</dl>
165
166<p>Referenced by <a class="el" href="_i_scene_node_8h_source.html#l00108">irr::scene::ISceneNode::OnAnimate()</a>.</p>
167
168</div>
169</div>
170<a class="anchor" id="a9cc261c12459fc7d3da6c2595d721c0d"></a><!-- doxytag: member="irr::scene::ISceneNodeAnimator::createClone" ref="a9cc261c12459fc7d3da6c2595d721c0d" args="(ISceneNode *node, ISceneManager *newManager=0)=0" -->
171<div class="memitem">
172<div class="memproto">
173 <table class="memname">
174 <tr>
175 <td class="memname">virtual <a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html">ISceneNodeAnimator</a>* irr::scene::ISceneNodeAnimator::createClone </td>
176 <td>(</td>
177 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_node.html">ISceneNode</a> *&#160;</td>
178 <td class="paramname"><em>node</em>, </td>
179 </tr>
180 <tr>
181 <td class="paramkey"></td>
182 <td></td>
183 <td class="paramtype"><a class="el" href="classirr_1_1scene_1_1_i_scene_manager.html">ISceneManager</a> *&#160;</td>
184 <td class="paramname"><em>newManager</em> = <code>0</code>&#160;</td>
185 </tr>
186 <tr>
187 <td></td>
188 <td>)</td>
189 <td></td><td><code> [pure virtual]</code></td>
190 </tr>
191 </table>
192</div>
193<div class="memdoc">
194
195<p>Creates a clone of this animator. </p>
196<p>Please note that you will have to drop (<a class="el" href="classirr_1_1_i_reference_counted.html#afb169a857e0d2cdb96b8821cb9bff17a" title="Drops the object. Decrements the reference counter by one.">IReferenceCounted::drop()</a>) the returned pointer after calling this. </p>
197
198<p>Referenced by <a class="el" href="_i_scene_node_8h_source.html#l00757">irr::scene::ISceneNode::cloneMembers()</a>.</p>
199
200</div>
201</div>
202<a class="anchor" id="aeed52b1fb289dcf456867b3916076cac"></a><!-- doxytag: member="irr::scene::ISceneNodeAnimator::getType" ref="aeed52b1fb289dcf456867b3916076cac" args="() const " -->
203<div class="memitem">
204<div class="memproto">
205 <table class="memname">
206 <tr>
207 <td class="memname">virtual <a class="el" href="namespaceirr_1_1scene.html#a327a1e43872705cf8f3f3342fb307d19">ESCENE_NODE_ANIMATOR_TYPE</a> irr::scene::ISceneNodeAnimator::getType </td>
208 <td>(</td>
209 <td class="paramname"></td><td>)</td>
210 <td> const<code> [inline, virtual]</code></td>
211 </tr>
212 </table>
213</div>
214<div class="memdoc">
215
216<p>Returns type of the scene node animator. </p>
217
218<p>Definition at line <a class="el" href="_i_scene_node_animator_8h_source.html#l00059">59</a> of file <a class="el" href="_i_scene_node_animator_8h_source.html">ISceneNodeAnimator.h</a>.</p>
219
220<p>References <a class="el" href="_e_scene_node_animator_types_8h_source.html#l00047">irr::scene::ESNAT_UNKNOWN</a>.</p>
221
222</div>
223</div>
224<a class="anchor" id="a2ea0caa26a5d377fa438dc7c836731fd"></a><!-- doxytag: member="irr::scene::ISceneNodeAnimator::hasFinished" ref="a2ea0caa26a5d377fa438dc7c836731fd" args="(void) const " -->
225<div class="memitem">
226<div class="memproto">
227 <table class="memname">
228 <tr>
229 <td class="memname">virtual bool irr::scene::ISceneNodeAnimator::hasFinished </td>
230 <td>(</td>
231 <td class="paramtype">void&#160;</td>
232 <td class="paramname"></td><td>)</td>
233 <td> const<code> [inline, virtual]</code></td>
234 </tr>
235 </table>
236</div>
237<div class="memdoc">
238
239<p>Returns if the animator has finished. </p>
240<p>This is only valid for non-looping animators with a discrete end state. </p>
241<dl class="return"><dt><b>Returns:</b></dt><dd>true if the animator has finished, false if it is still running. </dd></dl>
242
243<p>Definition at line <a class="el" href="_i_scene_node_animator_8h_source.html#l00067">67</a> of file <a class="el" href="_i_scene_node_animator_8h_source.html">ISceneNodeAnimator.h</a>.</p>
244
245</div>
246</div>
247<a class="anchor" id="a75c9e4eb1fa1af868034678fdcdbe15b"></a><!-- doxytag: member="irr::scene::ISceneNodeAnimator::isEventReceiverEnabled" ref="a75c9e4eb1fa1af868034678fdcdbe15b" args="() const " -->
248<div class="memitem">
249<div class="memproto">
250 <table class="memname">
251 <tr>
252 <td class="memname">virtual bool irr::scene::ISceneNodeAnimator::isEventReceiverEnabled </td>
253 <td>(</td>
254 <td class="paramname"></td><td>)</td>
255 <td> const<code> [inline, virtual]</code></td>
256 </tr>
257 </table>
258</div>
259<div class="memdoc">
260
261<p>Returns true if this animator receives events. </p>
262<p>When attached to an active camera, this animator will be able to respond to events such as mouse and keyboard events. </p>
263
264<p>Definition at line <a class="el" href="_i_scene_node_animator_8h_source.html#l00047">47</a> of file <a class="el" href="_i_scene_node_animator_8h_source.html">ISceneNodeAnimator.h</a>.</p>
265
266</div>
267</div>
268<a class="anchor" id="aca20b841bb586cd9654464b001a7b6aa"></a><!-- doxytag: member="irr::scene::ISceneNodeAnimator::OnEvent" ref="aca20b841bb586cd9654464b001a7b6aa" args="(const SEvent &amp;event)" -->
269<div class="memitem">
270<div class="memproto">
271 <table class="memname">
272 <tr>
273 <td class="memname">virtual bool irr::scene::ISceneNodeAnimator::OnEvent </td>
274 <td>(</td>
275 <td class="paramtype">const <a class="el" href="structirr_1_1_s_event.html">SEvent</a> &amp;&#160;</td>
276 <td class="paramname"><em>event</em></td><td>)</td>
277 <td><code> [inline, virtual]</code></td>
278 </tr>
279 </table>
280</div>
281<div class="memdoc">
282
283<p>Event receiver, override this function for camera controlling animators. </p>
284
285<p>Implements <a class="el" href="classirr_1_1_i_event_receiver.html#a571f744ceffc3b4fe8a81f529163eb97">irr::IEventReceiver</a>.</p>
286
287<p>Definition at line <a class="el" href="_i_scene_node_animator_8h_source.html#l00053">53</a> of file <a class="el" href="_i_scene_node_animator_8h_source.html">ISceneNodeAnimator.h</a>.</p>
288
289</div>
290</div>
291<hr/>The documentation for this class was generated from the following file:<ul>
292<li><a class="el" href="_i_scene_node_animator_8h_source.html">ISceneNodeAnimator.h</a></li>
293</ul>
294</div>
295</div>
296 <div id="nav-path" class="navpath">
297 <ul>
298 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
299 <li class="navelem"><a class="el" href="namespaceirr_1_1scene.html">scene</a> </li>
300 <li class="navelem"><a class="el" href="classirr_1_1scene_1_1_i_scene_node_animator.html">ISceneNodeAnimator</a> </li>
301<!-- window showing the filter options -->
302<div id="MSearchSelectWindow"
303 onmouseover="return searchBox.OnSearchSelectShow()"
304 onmouseout="return searchBox.OnSearchSelectHide()"
305 onkeydown="return searchBox.OnSearchSelectKey(event)">
306<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
307
308<!-- iframe showing the search results (closed by default) -->
309<div id="MSearchResultsWindow">
310<iframe src="javascript:void(0)" frameborder="0"
311 name="MSearchResults" id="MSearchResults">
312</iframe>
313</div>
314
315
316 <li class="footer">
317<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
318Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:47 for Irrlicht 3D Engine by
319<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
320 </ul>
321 </div>
322
323
324</body>
325</html>
generated by cgit v1.1 at 2024-05-15 20:22:25 +0000