source: OGRE/trunk/ogrenew/Docs/api/html/OgreSceneNode_8h-source.html @ 657

Revision 657, 20.0 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreSceneNode.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>OgreSceneNode.h</h1><a href="OgreSceneNode_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">    (Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025 <span class="preprocessor">#ifndef _SceneNode_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define _SceneNode_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029
3900030 <span class="preprocessor">#include "<a class="code" href="OgreNode_8h.html">OgreNode.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreAxisAlignedBox_8h.html">OgreAxisAlignedBox.h</a>"</span>
4200033
4300034 <span class="keyword">namespace </span>Ogre {
4400035
45<a name="l00045"></a><a class="code" href="classOgre_1_1SceneNode.html">00045</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> SceneNode : <span class="keyword">public</span> <a class="code" href="classOgre_1_1Node.html">Node</a>
4600046     {
4700047     <span class="keyword">public</span>:
48<a name="l00048"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodew0">00048</a>         <span class="keyword">typedef</span> HashMap&lt;String, MovableObject*&gt; <a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodew0">ObjectMap</a>;
49<a name="l00049"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodew1">00049</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;ObjectMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">ObjectIterator</a>;
50<a name="l00050"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodew2">00050</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator&lt;ObjectMap&gt;</a> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstObjectIterator</a>;
5100051
5200052     <span class="keyword">protected</span>:
53<a name="l00053"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep0">00053</a>         <a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodew0">ObjectMap</a> mObjectsByName;
54<a name="l00054"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep1">00054</a>         <span class="keyword">mutable</span> <a class="code" href="namespaceOgre.html#a59">LightList</a> mLightList;
55<a name="l00055"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep2">00055</a>         <span class="keyword">mutable</span> <span class="keywordtype">bool</span> mLightListDirty;
5600056
57<a name="l00058"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep3">00058</a>         <a class="code" href="classOgre_1_1WireBoundingBox.html">WireBoundingBox</a> *mWireBoundingBox;
58<a name="l00060"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep4">00060</a>         <span class="keywordtype">bool</span> mShowBoundingBox;
5900061
60<a name="l00063"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep5">00063</a>         <a class="code" href="classOgre_1_1SceneManager.html">SceneManager</a>* mCreator;
6100064
62<a name="l00066"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep6">00066</a>         <a class="code" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a> mWorldAABB;
6300067
6400070         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _updateBounds(<span class="keywordtype">void</span>);
6500071
6600073         <a class="code" href="classOgre_1_1Node.html">Node</a>* createChildImpl(<span class="keywordtype">void</span>);
6700074
6800076         <a class="code" href="classOgre_1_1Node.html">Node</a>* createChildImpl(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
6900077
7000079         <span class="keywordtype">void</span> setParent(<a class="code" href="classOgre_1_1Node.html">Node</a>* parent);
7100080
7200084         <span class="keywordtype">void</span> setInSceneGraph(<span class="keywordtype">bool</span> inGraph);
7300085
74<a name="l00087"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep7">00087</a>         <span class="keywordtype">bool</span> mYawFixed;
75<a name="l00089"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep8">00089</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mYawFixedAxis;
7600090
77<a name="l00092"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep9">00092</a>         SceneNode* mAutoTrackTarget;
78<a name="l00094"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep10">00094</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mAutoTrackOffset;
79<a name="l00096"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep11">00096</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mAutoTrackLocalDirection;
80<a name="l00098"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodep12">00098</a>         <span class="keywordtype">bool</span> mIsInSceneGraph;
8100099     <span class="keyword">public</span>:
8200104         SceneNode(<a class="code" href="classOgre_1_1SceneManager.html">SceneManager</a>* creator);
8300109         SceneNode(<a class="code" href="classOgre_1_1SceneManager.html">SceneManager</a>* creator, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
8400110         ~SceneNode();
8500111
8600117         <span class="keyword">virtual</span> <span class="keywordtype">void</span> attachObject(<a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* obj);
8700118
8800121         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> numAttachedObjects(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8900122
9000127         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* getAttachedObject(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> index);
9100128
9200132         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* getAttachedObject(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
9300133
9400139         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* detachObject(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> index);
9500141         <span class="keyword">virtual</span> <span class="keywordtype">void</span> detachObject(<a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* obj);
9600142
9700144         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* detachObject(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
9800145
9900148         <span class="keyword">virtual</span> <span class="keywordtype">void</span> detachAllObjects(<span class="keywordtype">void</span>);
10000149
101<a name="l00153"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodea11">00153</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isInSceneGraph(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mIsInSceneGraph; }
10200154
103<a name="l00159"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodea12">00159</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _notifyRootNode(<span class="keywordtype">void</span>) { mIsInSceneGraph = <span class="keyword">true</span>; }
10400160             
10500161
10600174         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _update(<span class="keywordtype">bool</span> updateChildren, <span class="keywordtype">bool</span> parentHasChanged);
10700175
10800192         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _findVisibleObjects(<a class="code" href="classOgre_1_1Camera.html">Camera</a>* cam, <a class="code" href="classOgre_1_1RenderQueue.html">RenderQueue</a>* queue,
10900193             <span class="keywordtype">bool</span> includeChildren = <span class="keyword">true</span>, <span class="keywordtype">bool</span> displayNodes = <span class="keyword">false</span>, <span class="keywordtype">bool</span> onlyShadowCasters = <span class="keyword">false</span>);
11000194
11100200         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a> _getWorldAABB(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11200201
11300212         <span class="keyword">virtual</span> ObjectIterator getAttachedObjectIterator(<span class="keywordtype">void</span>);
11400223         <span class="keyword">virtual</span> ConstObjectIterator getAttachedObjectIterator(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11500224
11600230         <a class="code" href="classOgre_1_1SceneManager.html">SceneManager</a>* getCreator(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11700231
11800242         <span class="keyword">virtual</span> <span class="keywordtype">void</span> removeAndDestroyChild(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
11900243
12000254         <span class="keyword">virtual</span> <span class="keywordtype">void</span> removeAndDestroyChild(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> index);
12100255
12200262         <span class="keyword">virtual</span> <span class="keywordtype">void</span> removeAndDestroyAllChildren(<span class="keywordtype">void</span>);
12300263
12400268         <span class="keyword">virtual</span> <span class="keywordtype">void</span> showBoundingBox(<span class="keywordtype">bool</span> bShow);
12500269
12600272         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _addBoundingBoxToQueue(<a class="code" href="classOgre_1_1RenderQueue.html">RenderQueue</a>* queue);
12700273
12800281         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getShowBoundingBox() <span class="keyword">const</span>;
12900282
13000289         <span class="keyword">virtual</span> SceneNode* createChildSceneNode(
13100290             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; translate = Vector3::ZERO,
13200291             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Quaternion.html">Quaternion</a>&amp; rotate = Quaternion::IDENTITY );
13300292
13400302         <span class="keyword">virtual</span> SceneNode* createChildSceneNode(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; translate = Vector3::ZERO, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Quaternion.html">Quaternion</a>&amp; rotate = Quaternion::IDENTITY);
13500303
13600313         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a59">LightList</a>&amp; findLights(<a class="code" href="namespaceOgre.html#a420">Real</a> radius) <span class="keyword">const</span>;
13700314
13800329         <span class="keywordtype">void</span> setFixedYawAxis( <span class="keywordtype">bool</span> useFixed, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; fixedAxis = Vector3::UNIT_Y );
13900330
14000333         <span class="keyword">virtual</span> <span class="keywordtype">void</span> yaw(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Radian.html">Radian</a>&amp; angle, TransformSpace relativeTo = TS_LOCAL);
14100334 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
14200335 <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> yaw(<a class="code" href="namespaceOgre.html#a420">Real</a> degrees, TransformSpace relativeTo = TS_LOCAL) {
14300336             yaw ( <a class="code" href="classOgre_1_1Angle.html">Angle</a>(degrees), relativeTo );
14400337         }
14500338 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
14600339 <span class="preprocessor"></span>
14700349         <span class="keywordtype">void</span> setDirection(<a class="code" href="namespaceOgre.html#a420">Real</a> x, <a class="code" href="namespaceOgre.html#a420">Real</a> y, <a class="code" href="namespaceOgre.html#a420">Real</a> z,
14800350             TransformSpace relativeTo = TS_LOCAL,
14900351             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; localDirectionVector = Vector3::NEGATIVE_UNIT_Z);
15000352
15100363         <span class="keywordtype">void</span> setDirection(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; vec, TransformSpace relativeTo = TS_LOCAL,
15200364             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; localDirectionVector = Vector3::NEGATIVE_UNIT_Z);
15300371         <span class="keywordtype">void</span> lookAt( <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; targetPoint, TransformSpace relativeTo,
15400372             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; localDirectionVector = Vector3::NEGATIVE_UNIT_Z);
15500391         <span class="keywordtype">void</span> setAutoTracking(<span class="keywordtype">bool</span> enabled, SceneNode* target = 0,
15600392             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; localDirectionVector = Vector3::NEGATIVE_UNIT_Z,
15700393             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; offset = Vector3::ZERO);
158<a name="l00395"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodea34">00395</a>         SceneNode* getAutoTrackTarget(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mAutoTrackTarget; }
159<a name="l00397"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodea35">00397</a>         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getAutoTrackOffset(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mAutoTrackOffset; }
160<a name="l00399"></a><a class="code" href="classOgre_1_1SceneNode.html#Ogre_1_1SceneNodea36">00399</a>         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getAutoTrackLocalDirection(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mAutoTrackLocalDirection; }
16100401         <span class="keywordtype">void</span> _autoTrack(<span class="keywordtype">void</span>);
16200403         SceneNode* getParentSceneNode(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
16300412         <span class="keywordtype">void</span> setVisible(<span class="keywordtype">bool</span> visible, <span class="keywordtype">bool</span> cascade = <span class="keyword">true</span>);
16400420         <span class="keywordtype">void</span> flipVisibility(<span class="keywordtype">bool</span> cascade = <span class="keyword">true</span>);
16500421
16600422
16700423
16800424
16900425
17000426     };
17100427
17200428
17300429 }<span class="comment">// namespace</span>
17400430
17500431 <span class="preprocessor">#endif</span>
176</pre></div><hr>
177<p>
178Copyright &copy; 2000-2005 by The OGRE Team<br />
179<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
180This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
181                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
182                <Work rdf:about="">
183                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
184        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
185                </Work>
186                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
187
188Last modified Sun Feb 12 12:59:52 2006
189</p>
190</body>
191</html>
Note: See TracBrowser for help on using the repository browser.