Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Ogre::SceneNode Class Reference

Class representing a node in the scene graph. More...

#include <OgreSceneNode.h>

Inheritance diagram for Ogre::SceneNode:
Inheritance graph
[legend]

Public Types

typedef MapIterator< ChildNodeMapChildNodeIterator
 
typedef HashMap< String, Node * > ChildNodeMap
 
typedef ConstMapIterator
< ChildNodeMap
ConstChildNodeIterator
 
typedef ConstMapIterator
< ObjectMap
ConstObjectIterator
 
typedef MapIterator< ObjectMapObjectIterator
 
typedef HashMap< String,
MovableObject * > 
ObjectMap
 
enum  TransformSpace { TS_LOCAL, TS_PARENT, TS_WORLD }
 Enumeration denoting the spaces which a transform can be relative to. More...
 

Public Member Functions

 SceneNode (SceneManager *creator)
 Constructor, only to be called by the creator SceneManager. More...
 
 SceneNode (SceneManager *creator, const String &name)
 Constructor, only to be called by the creator SceneManager. More...
 
 ~SceneNode ()
 
virtual void _addBoundingBoxToQueue (RenderQueue *queue)
 Add the bounding box to the rendering queue. More...
 
void _autoTrack (void)
 Internal method used by OGRE to update auto-tracking cameras. More...
 
virtual void _findVisibleObjects (Camera *cam, RenderQueue *queue, VisibleObjectsBoundsInfo *visibleBounds, bool includeChildren=true, bool displayNodes=false, bool onlyShadowCasters=false)
 Internal method which locates any visible objects attached to this node and adds them to the passed in queue. More...
 
virtual const Quaternion_getDerivedOrientation (void) const
 Gets the orientation of the node as derived from all parents. More...
 
virtual const Vector3_getDerivedPosition (void) const
 Gets the position of the node as derived from all parents. More...
 
virtual const Vector3_getDerivedScale (void) const
 Gets the scaling factor of the node as derived from all parents. More...
 
virtual const Matrix4_getFullTransform (void) const
 Gets the full transformation matrix for this node. More...
 
virtual const AxisAlignedBox_getWorldAABB (void) const
 Gets the axis-aligned bounding box of this node (and hence all subnodes). More...
 
virtual void _notifyRootNode (void)
 Notifies this SceneNode that it is the root scene node. More...
 
virtual void _setDerivedOrientation (const Quaternion &q)
 Sets the final world orientation of the node directly. More...
 
virtual void _setDerivedPosition (const Vector3 &pos)
 Sets the final world position of the node directly. More...
 
virtual void _update (bool updateChildren, bool parentHasChanged)
 Internal method to update the Node. More...
 
virtual void _updateBounds (void)
 Tells the SceneNode to update the world bound info it stores. More...
 
virtual void addChild (Node *child)
 Adds a (precreated) child scene node to this node. More...
 
virtual void attachObject (MovableObject *obj)
 Adds an instance of a scene object to this node. More...
 
virtual void cancelUpdate (Node *child)
 Called by children to notify their parent that they no longer need an update. More...
 
virtual Quaternion convertLocalToWorldOrientation (const Quaternion &localOrientation)
 Gets the world orientation of an orientation in the node local space useful for simple transforms that don't require a child node. More...
 
virtual Vector3 convertLocalToWorldPosition (const Vector3 &localPos)
 Gets the world position of a point in the node local space useful for simple transforms that don't require a child node. More...
 
virtual Quaternion convertWorldToLocalOrientation (const Quaternion &worldOrientation)
 Gets the local orientation, relative to this node, of the given world-space orientation. More...
 
virtual Vector3 convertWorldToLocalPosition (const Vector3 &worldPos)
 Gets the local position, relative to this node, of the given world-space position. More...
 
virtual NodecreateChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates an unnamed new Node as a child of this node. More...
 
virtual NodecreateChild (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates a new named Node as a child of this node. More...
 
virtual SceneNodecreateChildSceneNode (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates an unnamed new SceneNode as a child of this node. More...
 
virtual SceneNodecreateChildSceneNode (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates a new named SceneNode as a child of this node. More...
 
virtual void detachAllObjects (void)
 Detaches all objects attached to this node. More...
 
virtual MovableObjectdetachObject (unsigned short index)
 Detaches the indexed object from this scene node. More...
 
virtual void detachObject (MovableObject *obj)
 Detaches an object by pointer. More...
 
virtual MovableObjectdetachObject (const String &name)
 Detaches the named object from this node and returns a pointer to it. More...
 
virtual void findLights (LightList &destList, Real radius, uint32 lightMask=0xFFFFFFFF) const
 Allows retrieval of the nearest lights to the centre of this SceneNode. More...
 
virtual void flipVisibility (bool cascade=true)
 Inverts the visibility of all objects attached to this node. More...
 
virtual MovableObjectgetAttachedObject (unsigned short index)
 Retrieves a pointer to an attached object. More...
 
virtual MovableObjectgetAttachedObject (const String &name)
 Retrieves a pointer to an attached object. More...
 
virtual ObjectIterator getAttachedObjectIterator (void)
 Retrieves an iterator which can be used to efficiently step through the objects attached to this node. More...
 
virtual ConstObjectIterator getAttachedObjectIterator (void) const
 Retrieves an iterator which can be used to efficiently step through the objects attached to this node. More...
 
virtual const Vector3getAutoTrackLocalDirection (void)
 Get the auto tracking local direction for this node, if it is auto tracking. More...
 
virtual const Vector3getAutoTrackOffset (void)
 Get the auto tracking offset for this node, if the node is auto tracking. More...
 
virtual SceneNodegetAutoTrackTarget (void)
 Get the auto tracking target for this node, if any. More...
 
virtual NodegetChild (unsigned short index) const
 Gets a pointer to a child node. More...
 
virtual NodegetChild (const String &name) const
 Gets a pointer to a named child node. More...
 
virtual ChildNodeIterator getChildIterator (void)
 Retrieves an iterator for efficiently looping through all children of this node. More...
 
virtual ConstChildNodeIterator getChildIterator (void) const
 Retrieves an iterator for efficiently looping through all children of this node. More...
 
SceneManagergetCreator (void) const
 Gets the creator of this scene node. More...
 
virtual DebugRenderablegetDebugRenderable ()
 As Node::getDebugRenderable, except scaling is automatically determined. More...
 
virtual DebugRenderablegetDebugRenderable (Real scaling)
 Get a debug renderable for rendering the Node. More...
 
virtual bool getInheritOrientation (void) const
 Returns true if this node is affected by orientation applied to the parent node. More...
 
virtual bool getInheritScale (void) const
 Returns true if this node is affected by scaling factors applied to the parent node. More...
 
virtual const QuaterniongetInitialOrientation (void) const
 Gets the initial orientation of this node, see setInitialState for more info. More...
 
virtual const Vector3getInitialPosition (void) const
 Gets the initial position of this node, see setInitialState for more info. More...
 
virtual const Vector3getInitialScale (void) const
 Gets the initial position of this node, see setInitialState for more info. More...
 
virtual ListenergetListener (void) const
 Gets the current listener for this Node. More...
 
virtual Matrix3 getLocalAxes (void) const
 Gets a matrix whose columns are the local axes based on the nodes orientation relative to it's parent. More...
 
const StringgetName (void) const
 Returns the name of the node. More...
 
virtual const QuaterniongetOrientation () const
 Returns a quaternion representing the nodes orientation. More...
 
virtual NodegetParent (void) const
 Gets this node's parent (NULL if this is the root). More...
 
SceneNodegetParentSceneNode (void) const
 Gets the parent of this SceneNode. More...
 
virtual const Vector3getPosition (void) const
 Gets the position of the node relative to it's parent. More...
 
virtual const Vector3getScale (void) const
 Gets the scaling factor of this node. More...
 
virtual bool getShowBoundingBox () const
 This allows scene managers to determine if the node's bounding box should be added to the rendering queue. More...
 
virtual Real getSquaredViewDepth (const Camera *cam) const
 Helper function, get the squared view depth. More...
 
virtual OGRE_DEPRECATED const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
virtual void hideBoundingBox (bool bHide)
 Allows the overriding of the node's bounding box over the SceneManager's bounding box setting. More...
 
virtual bool isInSceneGraph (void) const
 Determines whether this node is in the scene graph, i.e. More...
 
virtual void lookAt (const Vector3 &targetPoint, TransformSpace relativeTo, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
 Points the local -Z direction of this node at a point in space. More...
 
virtual void needUpdate (bool forceParentUpdate=false)
 To be called in the event of transform changes to this node that require it's recalculation. More...
 
virtual unsigned short numAttachedObjects (void) const
 Reports the number of objects attached to this node. More...
 
virtual unsigned short numChildren (void) const
 Reports the number of child nodes under this one. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void pitch (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
 Rotate the node around the X-axis. More...
 
virtual void removeAllChildren (void)
 Removes all child Nodes attached to this node. More...
 
virtual void removeAndDestroyAllChildren (void)
 Removes and destroys all children of this node. More...
 
virtual void removeAndDestroyChild (const String &name)
 This method removes and destroys the named child and all of its children. More...
 
virtual void removeAndDestroyChild (unsigned short index)
 This method removes and destroys the child and all of its children. More...
 
virtual NoderemoveChild (unsigned short index)
 Drops the specified child from this node. More...
 
virtual NoderemoveChild (Node *child)
 Drops the specified child from this node. More...
 
virtual NoderemoveChild (const String &name)
 Drops the named child from this node. More...
 
virtual void requestUpdate (Node *child, bool forceParentUpdate=false)
 Called by children to notify their parent that they need an update. More...
 
virtual void resetOrientation (void)
 Resets the nodes orientation (local axes as world axes, no rotation). More...
 
virtual void resetToInitialState (void)
 Resets the position / orientation / scale of this node to it's initial state, see setInitialState for more info. More...
 
virtual void roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
 Rotate the node around the Z-axis. More...
 
virtual void rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
 Rotate the node around an arbitrary axis. More...
 
virtual void rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL)
 Rotate the node around an aritrary axis using a Quarternion. More...
 
virtual void scale (const Vector3 &scale)
 Scales the node, combining it's current scale with the passed in scaling factor. More...
 
virtual void scale (Real x, Real y, Real z)
 Scales the node, combining it's current scale with the passed in scaling factor. More...
 
virtual void setAutoTracking (bool enabled, SceneNode *const target=0, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z, const Vector3 &offset=Vector3::ZERO)
 Enables / disables automatic tracking of another SceneNode. More...
 
virtual void setDebugDisplayEnabled (bool enabled, bool cascade=true)
 Tells all objects attached to this node whether to display their debug information or not. More...
 
virtual void setDirection (Real x, Real y, Real z, TransformSpace relativeTo=TS_LOCAL, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
 Sets the node's direction vector ie it's local -z. More...
 
virtual void setDirection (const Vector3 &vec, TransformSpace relativeTo=TS_LOCAL, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
 Sets the node's direction vector ie it's local -z. More...
 
virtual void setFixedYawAxis (bool useFixed, const Vector3 &fixedAxis=Vector3::UNIT_Y)
 Tells the node whether to yaw around it's own local Y axis or a fixed axis of choice. More...
 
virtual void setInheritOrientation (bool inherit)
 Tells the node whether it should inherit orientation from it's parent node. More...
 
virtual void setInheritScale (bool inherit)
 Tells the node whether it should inherit scaling factors from it's parent node. More...
 
virtual void setInitialState (void)
 Sets the current transform of this node to be the 'initial state' ie that position / orientation / scale to be used as a basis for delta values used in keyframe animation. More...
 
virtual void setListener (Listener *listener)
 Sets a listener for this Node. More...
 
virtual void setOrientation (const Quaternion &q)
 Sets the orientation of this node via a quaternion. More...
 
virtual void setOrientation (Real w, Real x, Real y, Real z)
 Sets the orientation of this node via quaternion parameters. More...
 
virtual void setPosition (const Vector3 &pos)
 Sets the position of the node relative to it's parent. More...
 
virtual void setPosition (Real x, Real y, Real z)
 Sets the position of the node relative to it's parent. More...
 
virtual void setScale (const Vector3 &scale)
 Sets the scaling factor applied to this node. More...
 
virtual void setScale (Real x, Real y, Real z)
 Sets the scaling factor applied to this node. More...
 
virtual OGRE_DEPRECATED void setUserAny (const Any &anything)
 
virtual void setVisible (bool visible, bool cascade=true)
 Makes all objects attached to this node become visible / invisible. More...
 
virtual void showBoundingBox (bool bShow)
 Allows the showing of the node's bounding box. More...
 
virtual void translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT)
 Moves the node along the Cartesian axes. More...
 
virtual void translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
 Moves the node along the Cartesian axes. More...
 
virtual void translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT)
 Moves the node along arbitrary axes. More...
 
virtual void translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
 Moves the node along arbitrary axes. More...
 
virtual void yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
 Rotate the node around the Y-axis. More...
 

Static Public Member Functions

static void processQueuedUpdates (void)
 Process queued 'needUpdate' calls. More...
 
static void queueNeedUpdate (Node *n)
 Queue a 'needUpdate' call to a node safely. More...
 

Protected Types

typedef set< Node * >::type ChildUpdateSet
 
typedef vector< Node * >::type QueuedUpdates
 

Protected Member Functions

virtual void _updateFromParent (void) const
 Triggers the node to update it's combined transforms. More...
 
NodecreateChildImpl (void)
 See Node. More...
 
NodecreateChildImpl (const String &name)
 See Node. More...
 
virtual void setInSceneGraph (bool inGraph)
 Internal method for setting whether the node is in the scene graph. More...
 
void setParent (Node *parent)
 See Node. More...
 
void updateFromParentImpl (void) const
 

Protected Attributes

Vector3 mAutoTrackLocalDirection
 Local 'normal' direction vector. More...
 
Vector3 mAutoTrackOffset
 Tracking offset for fine tuning. More...
 
SceneNodemAutoTrackTarget
 Auto tracking target. More...
 
Matrix4 mCachedTransform
 Cached derived transform as a 4x4 matrix. More...
 
bool mCachedTransformOutOfDate
 
ChildNodeMap mChildren
 Collection of pointers to direct children; hashmap for efficiency. More...
 
ChildUpdateSet mChildrenToUpdate
 List of children which need updating, used if self is not out of date but children are. More...
 
SceneManagermCreator
 SceneManager which created this node. More...
 
DebugRenderablemDebug
 
Quaternion mDerivedOrientation
 Cached combined orientation. More...
 
Vector3 mDerivedPosition
 Cached combined position. More...
 
Vector3 mDerivedScale
 Cached combined scale. More...
 
bool mHideBoundingBox
 
bool mInheritOrientation
 Stores whether this node inherits orientation from it's parent. More...
 
bool mInheritScale
 Stores whether this node inherits scale from it's parent. More...
 
Quaternion mInitialOrientation
 The orientation to use as a base for keyframe animation. More...
 
Vector3 mInitialPosition
 The position to use as a base for keyframe animation. More...
 
Vector3 mInitialScale
 The scale to use as a base for keyframe animation. More...
 
bool mIsInSceneGraph
 Is this node a current part of the scene graph? More...
 
ListenermListener
 Node listener - only one allowed (no list) for size & performance reasons. More...
 
String mName
 Friendly name of this node, can be automatically generated if you don't care. More...
 
bool mNeedChildUpdate
 Flag indicating that all children need to be updated. More...
 
bool mNeedParentUpdate
 Flag to indicate own transform from parent is out of date. More...
 
ObjectMap mObjectsByName
 
Quaternion mOrientation
 Stores the orientation of the node relative to it's parent. More...
 
NodemParent
 Pointer to parent node. More...
 
bool mParentNotified
 Flag indicating that parent has been notified about update request. More...
 
Vector3 mPosition
 Stores the position/translation of the node relative to its parent. More...
 
bool mQueuedForUpdate
 Flag indicating that the node has been queued for update. More...
 
Vector3 mScale
 Stores the scaling factor applied to this node. More...
 
bool mShowBoundingBox
 Flag that determines if the bounding box of the node should be displayed. More...
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 
WireBoundingBoxmWireBoundingBox
 Pointer to a Wire Bounding Box for this Node. More...
 
AxisAlignedBox mWorldAABB
 World-Axis aligned bounding box, updated only through _update. More...
 
bool mYawFixed
 Whether to yaw around a fixed axis. More...
 
Vector3 mYawFixedAxis
 Fixed axis to yaw around. More...
 

Static Protected Attributes

static NameGenerator msNameGenerator
 Incremented count for next name extension. More...
 
static QueuedUpdates msQueuedUpdates
 

Detailed Description

Class representing a node in the scene graph.

Remarks
A SceneNode is a type of Node which is used to organise objects in a scene. It has the same hierarchical transformation properties of the generic Node class, but also adds the ability to attach world objects to the node, and stores hierarchical bounding volumes of the nodes in the tree. Child nodes are contained within the bounds of the parent, and so on down the tree, allowing for fast culling.

Definition at line 58 of file OgreSceneNode.h.

Member Typedef Documentation

Definition at line 79 of file OgreNode.h.

Definition at line 78 of file OgreNode.h.

typedef set<Node*>::type Ogre::Node::ChildUpdateSet
protectedinherited

Definition at line 131 of file OgreNode.h.

Definition at line 80 of file OgreNode.h.

Definition at line 63 of file OgreSceneNode.h.

Definition at line 62 of file OgreSceneNode.h.

Definition at line 61 of file OgreSceneNode.h.

typedef vector<Node*>::type Ogre::Node::QueuedUpdates
protectedinherited

Definition at line 231 of file OgreNode.h.

Member Enumeration Documentation

Enumeration denoting the spaces which a transform can be relative to.

Enumerator
TS_LOCAL 

Transform is relative to the local space.

TS_PARENT 

Transform is relative to the space of the parent node.

TS_WORLD 

Transform is relative to world space.

Definition at line 69 of file OgreNode.h.

Constructor & Destructor Documentation

Ogre::SceneNode::SceneNode ( SceneManager creator)

Constructor, only to be called by the creator SceneManager.

Remarks
Creates a node with a generated name.
Ogre::SceneNode::SceneNode ( SceneManager creator,
const String name 
)

Constructor, only to be called by the creator SceneManager.

Remarks
Creates a node with a specified name.
Ogre::SceneNode::~SceneNode ( )

Member Function Documentation

virtual void Ogre::SceneNode::_addBoundingBoxToQueue ( RenderQueue queue)
virtual

Add the bounding box to the rendering queue.

void Ogre::SceneNode::_autoTrack ( void  )

Internal method used by OGRE to update auto-tracking cameras.

virtual void Ogre::SceneNode::_findVisibleObjects ( Camera cam,
RenderQueue queue,
VisibleObjectsBoundsInfo visibleBounds,
bool  includeChildren = true,
bool  displayNodes = false,
bool  onlyShadowCasters = false 
)
virtual

Internal method which locates any visible objects attached to this node and adds them to the passed in queue.

Remarks
Should only be called by a SceneManager implementation, and only after the _updat method has been called to ensure transforms and world bounds are up to date. SceneManager implementations can choose to let the search cascade automatically, or choose to prevent this and select nodes themselves based on some other criteria.
Parameters
camThe active camera
queueThe SceneManager's rendering queue
visibleBoundsbounding information created on the fly containing all visible objects by the camera
includeChildrenIf true, the call is cascaded down to all child nodes automatically.
displayNodesIf true, the nodes themselves are rendered as a set of 3 axes as well as the objects being rendered. For debugging purposes.
virtual const Quaternion& Ogre::Node::_getDerivedOrientation ( void  ) const
virtualinherited

Gets the orientation of the node as derived from all parents.

virtual const Vector3& Ogre::Node::_getDerivedPosition ( void  ) const
virtualinherited

Gets the position of the node as derived from all parents.

virtual const Vector3& Ogre::Node::_getDerivedScale ( void  ) const
virtualinherited

Gets the scaling factor of the node as derived from all parents.

virtual const Matrix4& Ogre::Node::_getFullTransform ( void  ) const
virtualinherited

Gets the full transformation matrix for this node.

Remarks
This method returns the full transformation matrix for this node, including the effect of any parent node transformations, provided they have been updated using the Node::_update method. This should only be called by a SceneManager which knows the derived transforms have been updated before calling this method. Applications using Ogre should just use the relative transforms.
virtual const AxisAlignedBox& Ogre::SceneNode::_getWorldAABB ( void  ) const
virtual

Gets the axis-aligned bounding box of this node (and hence all subnodes).

Remarks
Recommended only if you are extending a SceneManager, because the bounding box returned from this method is only up to date after the SceneManager has called _update.
virtual void Ogre::SceneNode::_notifyRootNode ( void  )
virtual

Notifies this SceneNode that it is the root scene node.

Remarks
Only SceneManager should call this!

Definition at line 170 of file OgreSceneNode.h.

virtual void Ogre::Node::_setDerivedOrientation ( const Quaternion q)
virtualinherited

Sets the final world orientation of the node directly.

Remarks
It's advisable to use the local setOrientation if possible, this simply does the conversion for you.
virtual void Ogre::Node::_setDerivedPosition ( const Vector3 pos)
virtualinherited

Sets the final world position of the node directly.

Remarks
It's advisable to use the local setPosition if possible
virtual void Ogre::SceneNode::_update ( bool  updateChildren,
bool  parentHasChanged 
)
virtual

Internal method to update the Node.

Note
Updates this scene node and any relevant children to incorporate transforms etc. Don't call this yourself unless you are writing a SceneManager implementation.
Parameters
updateChildrenIf true, the update cascades down to all children. Specify false if you wish to update children separately, e.g. because of a more selective SceneManager implementation.
parentHasChangedThis flag indicates that the parent transform has changed, so the child should retrieve the parent's transform and combine it with its own even if it hasn't changed itself.

Reimplemented from Ogre::Node.

Reimplemented in Ogre::PCZSceneNode, and Ogre::BspSceneNode.

virtual void Ogre::SceneNode::_updateBounds ( void  )
virtual

Tells the SceneNode to update the world bound info it stores.

Reimplemented in Ogre::OctreeNode.

virtual void Ogre::Node::_updateFromParent ( void  ) const
protectedvirtualinherited

Triggers the node to update it's combined transforms.

This method is called internally by Ogre to ask the node to update it's complete transformation based on it's parents derived transform.
virtual void Ogre::Node::addChild ( Node child)
virtualinherited

Adds a (precreated) child scene node to this node.

If it is attached to another node, it must be detached first.

Parameters
childThe Node which is to become a child node of this one
virtual void Ogre::SceneNode::attachObject ( MovableObject obj)
virtual

Adds an instance of a scene object to this node.

Remarks
Scene objects can include Entity objects, Camera objects, Light objects, ParticleSystem objects etc. Anything that subclasses from MovableObject.
virtual void Ogre::Node::cancelUpdate ( Node child)
virtualinherited

Called by children to notify their parent that they no longer need an update.

virtual Quaternion Ogre::Node::convertLocalToWorldOrientation ( const Quaternion localOrientation)
virtualinherited

Gets the world orientation of an orientation in the node local space useful for simple transforms that don't require a child node.

virtual Vector3 Ogre::Node::convertLocalToWorldPosition ( const Vector3 localPos)
virtualinherited

Gets the world position of a point in the node local space useful for simple transforms that don't require a child node.

virtual Quaternion Ogre::Node::convertWorldToLocalOrientation ( const Quaternion worldOrientation)
virtualinherited

Gets the local orientation, relative to this node, of the given world-space orientation.

virtual Vector3 Ogre::Node::convertWorldToLocalPosition ( const Vector3 worldPos)
virtualinherited

Gets the local position, relative to this node, of the given world-space position.

virtual Node* Ogre::Node::createChild ( const Vector3 translate = Vector3::ZERO,
const Quaternion rotate = Quaternion::IDENTITY 
)
virtualinherited

Creates an unnamed new Node as a child of this node.

Parameters
translateInitial translation offset of child relative to parent
rotateInitial rotation relative to parent
virtual Node* Ogre::Node::createChild ( const String name,
const Vector3 translate = Vector3::ZERO,
const Quaternion rotate = Quaternion::IDENTITY 
)
virtualinherited

Creates a new named Node as a child of this node.

Remarks
This creates a child node with a given name, which allows you to look the node up from the parent which holds this collection of nodes.
Parameters
translateInitial translation offset of child relative to parent
rotateInitial rotation relative to parent
Node* Ogre::SceneNode::createChildImpl ( void  )
protectedvirtual

See Node.

Implements Ogre::Node.

Node* Ogre::SceneNode::createChildImpl ( const String name)
protectedvirtual

See Node.

Implements Ogre::Node.

virtual SceneNode* Ogre::SceneNode::createChildSceneNode ( const Vector3 translate = Vector3::ZERO,
const Quaternion rotate = Quaternion::IDENTITY 
)
virtual

Creates an unnamed new SceneNode as a child of this node.

Parameters
translateInitial translation offset of child relative to parent
rotateInitial rotation relative to parent

Reimplemented in Ogre::PCZSceneNode.

virtual SceneNode* Ogre::SceneNode::createChildSceneNode ( const String name,
const Vector3 translate = Vector3::ZERO,
const Quaternion rotate = Quaternion::IDENTITY 
)
virtual

Creates a new named SceneNode as a child of this node.

Remarks
This creates a child node with a given name, which allows you to look the node up from the parent which holds this collection of nodes.
Parameters
translateInitial translation offset of child relative to parent
rotateInitial rotation relative to parent

Reimplemented in Ogre::PCZSceneNode.

virtual void Ogre::SceneNode::detachAllObjects ( void  )
virtual

Detaches all objects attached to this node.

Reimplemented in Ogre::BspSceneNode.

virtual MovableObject* Ogre::SceneNode::detachObject ( unsigned short  index)
virtual

Detaches the indexed object from this scene node.

Remarks
Detaches by index, see the alternate version to detach by name. Object indexes may change as other objects are added / removed.

Reimplemented in Ogre::BspSceneNode.

virtual void Ogre::SceneNode::detachObject ( MovableObject obj)
virtual

Detaches an object by pointer.

virtual MovableObject* Ogre::SceneNode::detachObject ( const String name)
virtual

Detaches the named object from this node and returns a pointer to it.

Reimplemented in Ogre::BspSceneNode.

virtual void Ogre::SceneNode::findLights ( LightList destList,
Real  radius,
uint32  lightMask = 0xFFFFFFFF 
) const
virtual

Allows retrieval of the nearest lights to the centre of this SceneNode.

Remarks
This method allows a list of lights, ordered by proximity to the centre of this SceneNode, to be retrieved. Can be useful when implementing MovableObject::queryLights and Renderable::getLights.
Note that only lights could be affecting the frustum will take into account, which cached in scene manager.
See Also
SceneManager::_getLightsAffectingFrustum
SceneManager::_populateLightList
Parameters
destListList to be populated with ordered set of lights; will be cleared by this method before population.
radiusParameter to specify lights intersecting a given radius of this SceneNode's centre.
lightMaskThe mask with which to include / exclude lights
virtual void Ogre::SceneNode::flipVisibility ( bool  cascade = true)
virtual

Inverts the visibility of all objects attached to this node.

Remarks
This is a shortcut to calling setVisible(!isVisible()) on the objects attached to this node, and optionally to all objects attached to child nodes.
Parameters
cascadeIf true, this setting cascades into child nodes too.
virtual MovableObject* Ogre::SceneNode::getAttachedObject ( unsigned short  index)
virtual

Retrieves a pointer to an attached object.

Remarks
Retrieves by index, see alternate version to retrieve by name. The index of an object may change as other objects are added / removed.
virtual MovableObject* Ogre::SceneNode::getAttachedObject ( const String name)
virtual

Retrieves a pointer to an attached object.

Remarks
Retrieves by object name, see alternate version to retrieve by index.
virtual ObjectIterator Ogre::SceneNode::getAttachedObjectIterator ( void  )
virtual

Retrieves an iterator which can be used to efficiently step through the objects attached to this node.

Remarks
This is a much faster way to go through all the objects attached to the node than using getAttachedObject. But the iterator returned is only valid until a change is made to the collection (ie an addition or removal) so treat the returned iterator as transient, and don't add / remove items as you go through the iterator, save changes until the end, or retrieve a new iterator after making the change. Making changes to the object returned through the iterator is OK though.
virtual ConstObjectIterator Ogre::SceneNode::getAttachedObjectIterator ( void  ) const
virtual

Retrieves an iterator which can be used to efficiently step through the objects attached to this node.

Remarks
This is a much faster way to go through all the objects attached to the node than using getAttachedObject. But the iterator returned is only valid until a change is made to the collection (ie an addition or removal) so treat the returned iterator as transient, and don't add / remove items as you go through the iterator, save changes until the end, or retrieve a new iterator after making the change. Making changes to the object returned through the iterator is OK though.
virtual const Vector3& Ogre::SceneNode::getAutoTrackLocalDirection ( void  )
virtual

Get the auto tracking local direction for this node, if it is auto tracking.

Definition at line 426 of file OgreSceneNode.h.

virtual const Vector3& Ogre::SceneNode::getAutoTrackOffset ( void  )
virtual

Get the auto tracking offset for this node, if the node is auto tracking.

Definition at line 424 of file OgreSceneNode.h.

virtual SceneNode* Ogre::SceneNode::getAutoTrackTarget ( void  )
virtual

Get the auto tracking target for this node, if any.

Definition at line 422 of file OgreSceneNode.h.

virtual Node* Ogre::Node::getChild ( unsigned short  index) const
virtualinherited

Gets a pointer to a child node.

Remarks
There is an alternate getChild method which returns a named child.
virtual Node* Ogre::Node::getChild ( const String name) const
virtualinherited

Gets a pointer to a named child node.

virtual ChildNodeIterator Ogre::Node::getChildIterator ( void  )
virtualinherited

Retrieves an iterator for efficiently looping through all children of this node.

Remarks
Using this is faster than repeatedly calling getChild if you want to go through all (or most of) the children of this node. Note that the returned iterator is only valid whilst no children are added or removed from this node. Thus you should not store this returned iterator for later use, nor should you add / remove children whilst iterating through it; store up changes for later. Note that calling methods on returned items in the iterator IS allowed and does not invalidate the iterator.
virtual ConstChildNodeIterator Ogre::Node::getChildIterator ( void  ) const
virtualinherited

Retrieves an iterator for efficiently looping through all children of this node.

Remarks
Using this is faster than repeatedly calling getChild if you want to go through all (or most of) the children of this node. Note that the returned iterator is only valid whilst no children are added or removed from this node. Thus you should not store this returned iterator for later use, nor should you add / remove children whilst iterating through it; store up changes for later. Note that calling methods on returned items in the iterator IS allowed and does not invalidate the iterator.
SceneManager* Ogre::SceneNode::getCreator ( void  ) const

Gets the creator of this scene node.

Remarks
This method returns the SceneManager which created this node. This can be useful for destroying this node.

Definition at line 248 of file OgreSceneNode.h.

virtual DebugRenderable* Ogre::SceneNode::getDebugRenderable ( )
virtual

As Node::getDebugRenderable, except scaling is automatically determined.

virtual DebugRenderable* Ogre::Node::getDebugRenderable ( Real  scaling)
virtualinherited

Get a debug renderable for rendering the Node.

virtual bool Ogre::Node::getInheritOrientation ( void  ) const
virtualinherited

Returns true if this node is affected by orientation applied to the parent node.

Remarks
Orientations, unlike other transforms, are not always inherited by child nodes. Whether or not orientations affect the orientation of the child nodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative orientation based on the parent's orientation), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own orientation). The default is to inherit as with other transforms.
See setInheritOrientation for more info.
virtual bool Ogre::Node::getInheritScale ( void  ) const
virtualinherited

Returns true if this node is affected by scaling factors applied to the parent node.

Remarks
See setInheritScale for more info.
virtual const Quaternion& Ogre::Node::getInitialOrientation ( void  ) const
virtualinherited

Gets the initial orientation of this node, see setInitialState for more info.

virtual const Vector3& Ogre::Node::getInitialPosition ( void  ) const
virtualinherited

Gets the initial position of this node, see setInitialState for more info.

Remarks
Also resets the cumulative animation weight used for blending.
virtual const Vector3& Ogre::Node::getInitialScale ( void  ) const
virtualinherited

Gets the initial position of this node, see setInitialState for more info.

virtual Listener* Ogre::Node::getListener ( void  ) const
virtualinherited

Gets the current listener for this Node.

Definition at line 670 of file OgreNode.h.

virtual Matrix3 Ogre::Node::getLocalAxes ( void  ) const
virtualinherited

Gets a matrix whose columns are the local axes based on the nodes orientation relative to it's parent.

const String& Ogre::Node::getName ( void  ) const
inherited

Returns the name of the node.

virtual const Quaternion& Ogre::Node::getOrientation ( ) const
virtualinherited

Returns a quaternion representing the nodes orientation.

virtual Node* Ogre::Node::getParent ( void  ) const
virtualinherited

Gets this node's parent (NULL if this is the root).

SceneNode* Ogre::SceneNode::getParentSceneNode ( void  ) const

Gets the parent of this SceneNode.

virtual const Vector3& Ogre::Node::getPosition ( void  ) const
virtualinherited

Gets the position of the node relative to it's parent.

virtual const Vector3& Ogre::Node::getScale ( void  ) const
virtualinherited

Gets the scaling factor of this node.

virtual bool Ogre::SceneNode::getShowBoundingBox ( ) const
virtual

This allows scene managers to determine if the node's bounding box should be added to the rendering queue.

Remarks
Scene Managers that implement their own _findVisibleObjects will have to check this flag and then use _addBoundingBoxToQueue to add the bounding box wireframe.
virtual Real Ogre::Node::getSquaredViewDepth ( const Camera cam) const
virtualinherited

Helper function, get the squared view depth.

virtual OGRE_DEPRECATED const Any& Ogre::Node::getUserAny ( void  ) const
virtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 760 of file OgreNode.h.

UserObjectBindings& Ogre::Node::getUserObjectBindings ( )
inherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.
See Also
UserObjectBindings::setUserAny.

Definition at line 766 of file OgreNode.h.

const UserObjectBindings& Ogre::Node::getUserObjectBindings ( ) const
inherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.
See Also
UserObjectBindings::setUserAny.

Definition at line 772 of file OgreNode.h.

virtual void Ogre::SceneNode::hideBoundingBox ( bool  bHide)
virtual

Allows the overriding of the node's bounding box over the SceneManager's bounding box setting.

Remarks
Use this to override the bounding box setting of the node.
virtual bool Ogre::SceneNode::isInSceneGraph ( void  ) const
virtual

Determines whether this node is in the scene graph, i.e.

whether it's ultimate ancestor is the root scene node.

Definition at line 164 of file OgreSceneNode.h.

virtual void Ogre::SceneNode::lookAt ( const Vector3 targetPoint,
TransformSpace  relativeTo,
const Vector3 localDirectionVector = Vector3::NEGATIVE_UNIT_Z 
)
virtual

Points the local -Z direction of this node at a point in space.

Parameters
targetPointA vector specifying the look at point.
relativeToThe space in which the point resides
localDirectionVectorThe vector which normally describes the natural direction of the node, usually -Z
virtual void Ogre::Node::needUpdate ( bool  forceParentUpdate = false)
virtualinherited

To be called in the event of transform changes to this node that require it's recalculation.

Remarks
This not only tags the node state as being 'dirty', it also requests it's parent to know about it's dirtiness so it will get an update next time.
Parameters
forceParentUpdateEven if the node thinks it has already told it's parent, tell it anyway

Reimplemented in Ogre::Bone, and Ogre::TagPoint.

virtual unsigned short Ogre::SceneNode::numAttachedObjects ( void  ) const
virtual

Reports the number of objects attached to this node.

virtual unsigned short Ogre::Node::numChildren ( void  ) const
virtualinherited

Reports the number of child nodes under this one.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Node::pitch ( const Radian angle,
TransformSpace  relativeTo = TS_LOCAL 
)
virtualinherited

Rotate the node around the X-axis.

static void Ogre::Node::processQueuedUpdates ( void  )
staticinherited

Process queued 'needUpdate' calls.

static void Ogre::Node::queueNeedUpdate ( Node n)
staticinherited

Queue a 'needUpdate' call to a node safely.

Remarks
You can't call needUpdate() during the scene graph update, e.g. in response to a Node::Listener hook, because the graph is already being updated, and update flag changes cannot be made reliably in that context. Call this method if you need to queue a needUpdate call in this case.
virtual void Ogre::Node::removeAllChildren ( void  )
virtualinherited

Removes all child Nodes attached to this node.

Does not delete the nodes, just detaches them from this parent, potentially to be reattached elsewhere.

Reimplemented in Ogre::OctreeNode.

virtual void Ogre::SceneNode::removeAndDestroyAllChildren ( void  )
virtual

Removes and destroys all children of this node.

Remarks
Use this to destroy all child nodes of this node and remove them from the scene graph. Note that all objects attached to this node will be detached but will not be destroyed.
virtual void Ogre::SceneNode::removeAndDestroyChild ( const String name)
virtual

This method removes and destroys the named child and all of its children.

Remarks
Unlike removeChild, which removes a single named child from this node but does not destroy it, this method destroys the child and all of it's children.
Use this if you wish to recursively destroy a node as well as detaching it from it's parent. Note that any objects attached to the nodes will be detached but will not themselves be destroyed.
virtual void Ogre::SceneNode::removeAndDestroyChild ( unsigned short  index)
virtual

This method removes and destroys the child and all of its children.

Remarks
Unlike removeChild, which removes a single named child from this node but does not destroy it, this method destroys the child and all of it's children.
Use this if you wish to recursively destroy a node as well as detaching it from it's parent. Note that any objects attached to the nodes will be detached but will not themselves be destroyed.
virtual Node* Ogre::Node::removeChild ( unsigned short  index)
virtualinherited

Drops the specified child from this node.

Remarks
Does not delete the node, just detaches it from this parent, potentially to be reattached elsewhere. There is also an alternate version which drops a named child from this node.

Reimplemented in Ogre::OctreeNode.

virtual Node* Ogre::Node::removeChild ( Node child)
virtualinherited

Drops the specified child from this node.

Remarks
Does not delete the node, just detaches it from this parent, potentially to be reattached elsewhere. There is also an alternate version which drops a named child from this node.

Reimplemented in Ogre::OctreeNode.

virtual Node* Ogre::Node::removeChild ( const String name)
virtualinherited

Drops the named child from this node.

Remarks
Does not delete the node, just detaches it from this parent, potentially to be reattached elsewhere.

Reimplemented in Ogre::OctreeNode.

virtual void Ogre::Node::requestUpdate ( Node child,
bool  forceParentUpdate = false 
)
virtualinherited

Called by children to notify their parent that they need an update.

Parameters
forceParentUpdateEven if the node thinks it has already told it's parent, tell it anyway
virtual void Ogre::Node::resetOrientation ( void  )
virtualinherited

Resets the nodes orientation (local axes as world axes, no rotation).

Remarks
Orientations, unlike other transforms, are not always inherited by child nodes. Whether or not orientations affect the orientation of the child nodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative orientation based on the parent's orientation), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own orientation). The default is to inherit as with other transforms.
Note that rotations are oriented around the node's origin.
virtual void Ogre::Node::resetToInitialState ( void  )
virtualinherited

Resets the position / orientation / scale of this node to it's initial state, see setInitialState for more info.

virtual void Ogre::Node::roll ( const Radian angle,
TransformSpace  relativeTo = TS_LOCAL 
)
virtualinherited

Rotate the node around the Z-axis.

virtual void Ogre::Node::rotate ( const Vector3 axis,
const Radian angle,
TransformSpace  relativeTo = TS_LOCAL 
)
virtualinherited

Rotate the node around an arbitrary axis.

virtual void Ogre::Node::rotate ( const Quaternion q,
TransformSpace  relativeTo = TS_LOCAL 
)
virtualinherited

Rotate the node around an aritrary axis using a Quarternion.

virtual void Ogre::Node::scale ( const Vector3 scale)
virtualinherited

Scales the node, combining it's current scale with the passed in scaling factor.

Remarks
This method applies an extra scaling factor to the node's existing scale, (unlike setScale which overwrites it) combining it's current scale with the new one. E.g. calling this method twice with Vector3(2,2,2) would have the same effect as setScale(Vector3(4,4,4)) if the existing scale was 1.
Note that like rotations, scalings are oriented around the node's origin.
virtual void Ogre::Node::scale ( Real  x,
Real  y,
Real  z 
)
virtualinherited

Scales the node, combining it's current scale with the passed in scaling factor.

Remarks
This method applies an extra scaling factor to the node's existing scale, (unlike setScale which overwrites it) combining it's current scale with the new one. E.g. calling this method twice with Vector3(2,2,2) would have the same effect as setScale(Vector3(4,4,4)) if the existing scale was 1.
Note that like rotations, scalings are oriented around the node's origin.
virtual void Ogre::SceneNode::setAutoTracking ( bool  enabled,
SceneNode *const  target = 0,
const Vector3 localDirectionVector = Vector3::NEGATIVE_UNIT_Z,
const Vector3 offset = Vector3::ZERO 
)
virtual

Enables / disables automatic tracking of another SceneNode.

Remarks
If you enable auto-tracking, this SceneNode will automatically rotate to point it's -Z at the target SceneNode every frame, no matter how it or the other SceneNode move. Note that by default the -Z points at the origin of the target SceneNode, if you want to tweak this, provide a vector in the 'offset' parameter and the target point will be adjusted.
Parameters
enabledIf true, tracking will be enabled and the next parameter cannot be null. If false tracking will be disabled and the current orientation will be maintained.
targetPointer to the SceneNode to track. Make sure you don't delete this SceneNode before turning off tracking (e.g. SceneManager::clearScene will delete it so be careful of this). Can be null if and only if the enabled param is false.
localDirectionVectorThe local vector considered to be the usual 'direction' of the node; normally the local -Z but can be another direction.
offsetIf supplied, this is the target point in local space of the target node instead of the origin of the target node. Good for fine tuning the look at point.
virtual void Ogre::SceneNode::setDebugDisplayEnabled ( bool  enabled,
bool  cascade = true 
)
virtual

Tells all objects attached to this node whether to display their debug information or not.

Remarks
This is a shortcut to calling setDebugDisplayEnabled() on the objects attached to this node, and optionally to all objects attached to child nodes.
Parameters
enabledWhether the objects are to display debug info or not
cascadeIf true, this setting cascades into child nodes too.
virtual void Ogre::SceneNode::setDirection ( Real  x,
Real  y,
Real  z,
TransformSpace  relativeTo = TS_LOCAL,
const Vector3 localDirectionVector = Vector3::NEGATIVE_UNIT_Z 
)
virtual

Sets the node's direction vector ie it's local -z.

Remarks
Note that the 'up' vector for the orientation will automatically be recalculated based on the current 'up' vector (i.e. the roll will remain the same). If you need more control, use setOrientation.
Parameters
x,y,zThe components of the direction vector
relativeToThe space in which this direction vector is expressed
localDirectionVectorThe vector which normally describes the natural direction of the node, usually -Z
virtual void Ogre::SceneNode::setDirection ( const Vector3 vec,
TransformSpace  relativeTo = TS_LOCAL,
const Vector3 localDirectionVector = Vector3::NEGATIVE_UNIT_Z 
)
virtual

Sets the node's direction vector ie it's local -z.

Remarks
Note that the 'up' vector for the orientation will automatically be recalculated based on the current 'up' vector (i.e. the roll will remain the same). If you need more control, use setOrientation.
Parameters
vecThe direction vector
relativeToThe space in which this direction vector is expressed
localDirectionVectorThe vector which normally describes the natural direction of the node, usually -Z
virtual void Ogre::SceneNode::setFixedYawAxis ( bool  useFixed,
const Vector3 fixedAxis = Vector3::UNIT_Y 
)
virtual

Tells the node whether to yaw around it's own local Y axis or a fixed axis of choice.

Remarks
This method allows you to change the yaw behaviour of the node - by default, it yaws around it's own local Y axis when told to yaw with TS_LOCAL, this makes it yaw around a fixed axis. You only really need this when you're using auto tracking (see setAutoTracking, because when you're manually rotating a node you can specify the TransformSpace in which you wish to work anyway.
Parameters
useFixedIf true, the axis passed in the second parameter will always be the yaw axis no matter what the node orientation. If false, the node returns to it's default behaviour.
fixedAxisThe axis to use if the first parameter is true.
virtual void Ogre::Node::setInheritOrientation ( bool  inherit)
virtualinherited

Tells the node whether it should inherit orientation from it's parent node.

Remarks
Orientations, unlike other transforms, are not always inherited by child nodes. Whether or not orientations affect the orientation of the child nodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative orientation based on the parent's orientation), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own orientation). The default is to inherit as with other transforms.
Parameters
inheritIf true, this node's orientation will be affected by its parent's orientation. If false, it will not be affected.
virtual void Ogre::Node::setInheritScale ( bool  inherit)
virtualinherited

Tells the node whether it should inherit scaling factors from it's parent node.

Remarks
Scaling factors, unlike other transforms, are not always inherited by child nodes. Whether or not scalings affect the size of the child nodes depends on the setInheritScale option of the child. In some cases you want a scaling factor of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative size based on the parent's size), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own size). The default is to inherit as with other transforms.
Parameters
inheritIf true, this node's scale will be affected by its parent's scale. If false, it will not be affected.
virtual void Ogre::Node::setInitialState ( void  )
virtualinherited

Sets the current transform of this node to be the 'initial state' ie that position / orientation / scale to be used as a basis for delta values used in keyframe animation.

Remarks
You never need to call this method unless you plan to animate this node. If you do plan to animate it, call this method once you've loaded the node with it's base state, ie the state on which all keyframes are based.
If you never call this method, the initial state is the identity transform, ie do nothing.
virtual void Ogre::SceneNode::setInSceneGraph ( bool  inGraph)
protectedvirtual

Internal method for setting whether the node is in the scene graph.

Reimplemented in Ogre::BspSceneNode.

virtual void Ogre::Node::setListener ( Listener listener)
virtualinherited

Sets a listener for this Node.

Remarks
Note for size and performance reasons only one listener per node is allowed.

Definition at line 666 of file OgreNode.h.

virtual void Ogre::Node::setOrientation ( const Quaternion q)
virtualinherited

Sets the orientation of this node via a quaternion.

Remarks
Orientations, unlike other transforms, are not always inherited by child nodes. Whether or not orientations affect the orientation of the child nodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative orientation based on the parent's orientation), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own orientation). The default is to inherit as with other transforms.
Note that rotations are oriented around the node's origin.
virtual void Ogre::Node::setOrientation ( Real  w,
Real  x,
Real  y,
Real  z 
)
virtualinherited

Sets the orientation of this node via quaternion parameters.

Remarks
Orientations, unlike other transforms, are not always inherited by child nodes. Whether or not orientations affect the orientation of the child nodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative orientation based on the parent's orientation), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own orientation). The default is to inherit as with other transforms.
Note that rotations are oriented around the node's origin.
void Ogre::SceneNode::setParent ( Node parent)
protectedvirtual

See Node.

Reimplemented from Ogre::Node.

virtual void Ogre::Node::setPosition ( const Vector3 pos)
virtualinherited

Sets the position of the node relative to it's parent.

virtual void Ogre::Node::setPosition ( Real  x,
Real  y,
Real  z 
)
virtualinherited

Sets the position of the node relative to it's parent.

virtual void Ogre::Node::setScale ( const Vector3 scale)
virtualinherited

Sets the scaling factor applied to this node.

Remarks
Scaling factors, unlike other transforms, are not always inherited by child nodes. Whether or not scalings affect the size of the child nodes depends on the setInheritScale option of the child. In some cases you want a scaling factor of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative size based on the parent's size), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own size). The default is to inherit as with other transforms.
Note that like rotations, scalings are oriented around the node's origin.
virtual void Ogre::Node::setScale ( Real  x,
Real  y,
Real  z 
)
virtualinherited

Sets the scaling factor applied to this node.

Remarks
Scaling factors, unlike other transforms, are not always inherited by child nodes. Whether or not scalings affect the size of the child nodes depends on the setInheritScale option of the child. In some cases you want a scaling factor of a parent node to apply to a child node (e.g. where the child node is a part of the same object, so you want it to be the same relative size based on the parent's size), but not in other cases (e.g. where the child node is just for positioning another object, you want it to maintain it's own size). The default is to inherit as with other transforms.
Note that like rotations, scalings are oriented around the node's origin.
virtual OGRE_DEPRECATED void Ogre::Node::setUserAny ( const Any anything)
virtualinherited
Deprecated:
use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

Remarks
This method allows you to associate any user value you like with this Node. This can be a pointer back to one of your own classes for instance.

Definition at line 755 of file OgreNode.h.

virtual void Ogre::SceneNode::setVisible ( bool  visible,
bool  cascade = true 
)
virtual

Makes all objects attached to this node become visible / invisible.

Remarks
This is a shortcut to calling setVisible() on the objects attached to this node, and optionally to all objects attached to child nodes.
Parameters
visibleWhether the objects are to be made visible or invisible
cascadeIf true, this setting cascades into child nodes too.
virtual void Ogre::SceneNode::showBoundingBox ( bool  bShow)
virtual

Allows the showing of the node's bounding box.

Remarks
Use this to show or hide the bounding box of the node.
virtual void Ogre::Node::translate ( const Vector3 d,
TransformSpace  relativeTo = TS_PARENT 
)
virtualinherited

Moves the node along the Cartesian axes.

This method moves the node by the supplied vector along the world Cartesian axes, i.e. along world x,y,z
Parameters
dVector with x,y,z values representing the translation.
relativeToThe space which this transform is relative to.
virtual void Ogre::Node::translate ( Real  x,
Real  y,
Real  z,
TransformSpace  relativeTo = TS_PARENT 
)
virtualinherited

Moves the node along the Cartesian axes.

This method moves the node by the supplied vector along the world Cartesian axes, i.e. along world x,y,z
Parameters
xReal x value representing the translation.
yReal y value representing the translation.
zReal z value representing the translation.
relativeToThe space which this transform is relative to.
virtual void Ogre::Node::translate ( const Matrix3 axes,
const Vector3 move,
TransformSpace  relativeTo = TS_PARENT 
)
virtualinherited

Moves the node along arbitrary axes.

Remarks
This method translates the node by a vector which is relative to a custom set of axes.
Parameters
axesA 3x3 Matrix containing 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as:
    1 0 0
    0 1 0
    0 0 1
    
i.e. the identity matrix.
moveVector relative to the axes above.
relativeToThe space which this transform is relative to.
virtual void Ogre::Node::translate ( const Matrix3 axes,
Real  x,
Real  y,
Real  z,
TransformSpace  relativeTo = TS_PARENT 
)
virtualinherited

Moves the node along arbitrary axes.

Remarks
This method translates the node by a vector which is relative to a custom set of axes.
Parameters
axesA 3x3 Matrix containing 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as
    1 0 0
    0 1 0
    0 0 1
    
i.e. the identity matrix.
xThe x translation component relative to the axes above.
yThe y translation component relative to the axes above.
zThe z translation component relative to the axes above.
relativeToThe space which this transform is relative to.
void Ogre::SceneNode::updateFromParentImpl ( void  ) const
protectedvirtual

Reimplemented from Ogre::Node.

Reimplemented in Ogre::PCZSceneNode.

virtual void Ogre::SceneNode::yaw ( const Radian angle,
TransformSpace  relativeTo = TS_LOCAL 
)
virtual

Rotate the node around the Y-axis.

Reimplemented from Ogre::Node.

Member Data Documentation

Vector3 Ogre::SceneNode::mAutoTrackLocalDirection
protected

Local 'normal' direction vector.

Definition at line 107 of file OgreSceneNode.h.

Vector3 Ogre::SceneNode::mAutoTrackOffset
protected

Tracking offset for fine tuning.

Definition at line 105 of file OgreSceneNode.h.

SceneNode* Ogre::SceneNode::mAutoTrackTarget
protected

Auto tracking target.

Definition at line 103 of file OgreSceneNode.h.

Matrix4 Ogre::Node::mCachedTransform
mutableprotectedinherited

Cached derived transform as a 4x4 matrix.

Definition at line 225 of file OgreNode.h.

bool Ogre::Node::mCachedTransformOutOfDate
mutableprotectedinherited

Definition at line 226 of file OgreNode.h.

ChildNodeMap Ogre::Node::mChildren
protectedinherited

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 129 of file OgreNode.h.

ChildUpdateSet Ogre::Node::mChildrenToUpdate
mutableprotectedinherited

List of children which need updating, used if self is not out of date but children are.

Definition at line 133 of file OgreNode.h.

SceneManager* Ogre::SceneNode::mCreator
protected

SceneManager which created this node.

Definition at line 75 of file OgreSceneNode.h.

DebugRenderable* Ogre::Node::mDebug
protectedinherited

Definition at line 234 of file OgreNode.h.

Quaternion Ogre::Node::mDerivedOrientation
mutableprotectedinherited

Cached combined orientation.

This member is the orientation derived by combining the local transformations and those of it's parents. This is updated when _updateFromParent is called by the SceneManager or the nodes parent.

Definition at line 174 of file OgreNode.h.

Vector3 Ogre::Node::mDerivedPosition
mutableprotectedinherited

Cached combined position.

This member is the position derived by combining the local transformations and those of it's parents. This is updated when _updateFromParent is called by the SceneManager or the nodes parent.

Definition at line 183 of file OgreNode.h.

Vector3 Ogre::Node::mDerivedScale
mutableprotectedinherited

Cached combined scale.

This member is the position derived by combining the local transformations and those of it's parents. This is updated when _updateFromParent is called by the SceneManager or the nodes parent.

Definition at line 192 of file OgreNode.h.

bool Ogre::SceneNode::mHideBoundingBox
protected

Definition at line 72 of file OgreSceneNode.h.

bool Ogre::Node::mInheritOrientation
protectedinherited

Stores whether this node inherits orientation from it's parent.

Definition at line 159 of file OgreNode.h.

bool Ogre::Node::mInheritScale
protectedinherited

Stores whether this node inherits scale from it's parent.

Definition at line 162 of file OgreNode.h.

Quaternion Ogre::Node::mInitialOrientation
protectedinherited

The orientation to use as a base for keyframe animation.

Definition at line 220 of file OgreNode.h.

Vector3 Ogre::Node::mInitialPosition
protectedinherited

The position to use as a base for keyframe animation.

Definition at line 218 of file OgreNode.h.

Vector3 Ogre::Node::mInitialScale
protectedinherited

The scale to use as a base for keyframe animation.

Definition at line 222 of file OgreNode.h.

bool Ogre::SceneNode::mIsInSceneGraph
protected

Is this node a current part of the scene graph?

Definition at line 109 of file OgreSceneNode.h.

Listener* Ogre::Node::mListener
protectedinherited

Node listener - only one allowed (no list) for size & performance reasons.

Definition at line 229 of file OgreNode.h.

String Ogre::Node::mName
protectedinherited

Friendly name of this node, can be automatically generated if you don't care.

Definition at line 144 of file OgreNode.h.

bool Ogre::Node::mNeedChildUpdate
mutableprotectedinherited

Flag indicating that all children need to be updated.

Definition at line 137 of file OgreNode.h.

bool Ogre::Node::mNeedParentUpdate
mutableprotectedinherited

Flag to indicate own transform from parent is out of date.

Definition at line 135 of file OgreNode.h.

ObjectMap Ogre::SceneNode::mObjectsByName
protected

Definition at line 66 of file OgreSceneNode.h.

Quaternion Ogre::Node::mOrientation
protectedinherited

Stores the orientation of the node relative to it's parent.

Definition at line 150 of file OgreNode.h.

Node* Ogre::Node::mParent
protectedinherited

Pointer to parent node.

Definition at line 127 of file OgreNode.h.

bool Ogre::Node::mParentNotified
mutableprotectedinherited

Flag indicating that parent has been notified about update request.

Definition at line 139 of file OgreNode.h.

Vector3 Ogre::Node::mPosition
protectedinherited

Stores the position/translation of the node relative to its parent.

Definition at line 153 of file OgreNode.h.

bool Ogre::Node::mQueuedForUpdate
mutableprotectedinherited

Flag indicating that the node has been queued for update.

Definition at line 141 of file OgreNode.h.

Vector3 Ogre::Node::mScale
protectedinherited

Stores the scaling factor applied to this node.

Definition at line 156 of file OgreNode.h.

bool Ogre::SceneNode::mShowBoundingBox
protected

Flag that determines if the bounding box of the node should be displayed.

Definition at line 71 of file OgreSceneNode.h.

NameGenerator Ogre::Node::msNameGenerator
staticprotectedinherited

Incremented count for next name extension.

Definition at line 147 of file OgreNode.h.

QueuedUpdates Ogre::Node::msQueuedUpdates
staticprotectedinherited

Definition at line 232 of file OgreNode.h.

UserObjectBindings Ogre::Node::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 237 of file OgreNode.h.

WireBoundingBox* Ogre::SceneNode::mWireBoundingBox
protected

Pointer to a Wire Bounding Box for this Node.

Definition at line 69 of file OgreSceneNode.h.

AxisAlignedBox Ogre::SceneNode::mWorldAABB
protected

World-Axis aligned bounding box, updated only through _update.

Definition at line 78 of file OgreSceneNode.h.

bool Ogre::SceneNode::mYawFixed
protected

Whether to yaw around a fixed axis.

Definition at line 98 of file OgreSceneNode.h.

Vector3 Ogre::SceneNode::mYawFixedAxis
protected

Fixed axis to yaw around.

Definition at line 100 of file OgreSceneNode.h.


The documentation for this class was generated from the following file:

Copyright © 2013 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sat Dec 14 2013 14:36:42