Ogre::Node Class Referenceabstract
Core » Scene

Class representing a general-purpose node an articulated scene graph. More...

`#include <OgreNode.h>`

Inheritance diagram for Ogre::Node:
[legend]

## Classes

class | DebugRenderable
| Inner class for displaying debug renderable for Node. More...
class | Listener
| Listener which gets called back on Node events. More...

## Public Types

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

## Public Member Functions

| Node ()
| Constructor, should only be called by parent, not directly. More...
| Node (const String &name)
| Constructor, should only be called by parent, not directly. More...
virtual | ~Node ()
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 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 | addChild (Node *child)
| Adds a (precreated) child scene node 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 Node * | createChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
| Creates an unnamed new Node as a child of this node. More...
virtual Node * | createChild (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 Node * | getChild (unsigned short index) const
| Gets a pointer to a child node. More...
virtual Node * | getChild (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...
virtual DebugRenderable * | getDebugRenderable (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 Quaternion & | getInitialOrientation (void) const
| Gets the initial orientation of this node, see setInitialState for more info. More...
virtual const Vector3 & | getInitialPosition (void) const
| Gets the initial position of this node, see setInitialState for more info. More...
virtual const Vector3 & | getInitialScale (void) const
| Gets the initial position of this node, see setInitialState for more info. More...
virtual Listener * | getListener (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 String & | getName (void) const
| Returns the name of the node. More...
virtual const Quaternion & | getOrientation () const
| Returns a quaternion representing the nodes orientation. More...
virtual Node * | getParent (void) const
| Gets this node's parent (NULL if this is the root). More...
virtual const Vector3 & | getPosition (void) const
| Gets the position of the node relative to it's parent. More...
virtual const Vector3 & | getScale (void) const
| Gets the scaling factor of this node. More...
virtual Real | getSquaredViewDepth (const Camera *cam) const
| Helper function, get the squared view depth. More...
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const
UserObjectBindings & | getUserObjectBindings ()
| Return an instance of user objects binding associated with this class. More...
const UserObjectBindings & | getUserObjectBindings () const
| Return an instance of user objects binding associated with this class. 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 | 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 Node * | removeChild (unsigned short index)
| Drops the specified child from this node. More...
virtual Node * | removeChild (Node *child)
| Drops the specified child from this node. More...
virtual Node * | removeChild (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 | 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 | 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...
virtual Node * | createChildImpl (void)=0
| Internal method for creating a new child node - must be overridden per subclass. More...
virtual Node * | createChildImpl (const String &name)=0
| Internal method for creating a new child node - must be overridden per subclass. More...
virtual void | setParent (Node *parent)
| Only available internally - notification of parent. More...
virtual void | updateFromParentImpl (void) const
| Class-specific implementation of _updateFromParent. More...

## Protected Attributes

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...
DebugRenderable * | mDebug
Quaternion | mDerivedOrientation
| Cached combined orientation. More...
Vector3 | mDerivedPosition
| Cached combined position. More...
Vector3 | mDerivedScale
| Cached combined scale. More...
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...
Listener * | mListener
| 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...
Quaternion | mOrientation
| Stores the orientation of the node relative to it's parent. More...
Node * | mParent
| 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...
UserObjectBindings | mUserObjectBindings
| User objects binding. More...

## Static Protected Attributes

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

## Detailed Description

Class representing a general-purpose node an articulated scene graph.

Remarks
  A node in the scene graph is a node in a structured tree. A node contains information about the transformation which will apply to it and all of it's children. Child nodes can have transforms of their own, which are combined with their parent's transformations.

  This is an abstract class - concrete classes are based on this for specific purposes, e.g. SceneNode, Bone

Definition at line 64 of file OgreNode.h.

## Member Typedef Documentation

## ChildNodeIterator

typedef MapIterator<ChildNodeMap> Ogre::Node::ChildNodeIterator

Definition at line 79 of file OgreNode.h.

## ChildNodeMap

typedef HashMap<String, Node*> Ogre::Node::ChildNodeMap

Definition at line 78 of file OgreNode.h.

## ChildUpdateSet

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

protected

Definition at line 131 of file OgreNode.h.

## ConstChildNodeIterator

typedef ConstMapIterator<ChildNodeMap> Ogre::Node::ConstChildNodeIterator

Definition at line 80 of file OgreNode.h.

## QueuedUpdates

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

protected

Definition at line 231 of file OgreNode.h.

## Member Enumeration Documentation

## TransformSpace

enum Ogre::Node::TransformSpace

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

## Node() [1/2]

Ogre::Node::Node | ( |  | ) |

Constructor, should only be called by parent, not directly.

Remarks
  Generates a name.

## Node() [2/2]

Ogre::Node::Node | ( | const String & | name | ) |

Constructor, should only be called by parent, not directly.

Remarks
  Assigned a name.

## ~Node()

virtual Ogre::Node::~Node | ( |  | ) |

virtual

## Member Function Documentation

## _getDerivedOrientation()

virtual const Quaternion& Ogre::Node::_getDerivedOrientation | ( | void |  | ) | const

virtual

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

## _getDerivedPosition()

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

virtual

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

## _getDerivedScale()

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

virtual

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

## _getFullTransform()

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

virtual

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.

## _setDerivedOrientation()

virtual void Ogre::Node::_setDerivedOrientation | ( | const Quaternion & | q | ) |

virtual

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.

## _setDerivedPosition()

virtual void Ogre::Node::_setDerivedPosition | ( | const Vector3 & | pos | ) |

virtual

Sets the final world position of the node directly.

Remarks
  It's advisable to use the local setPosition if possible

## _update()

virtual void Ogre::Node::_update | ( | bool | updateChildren,
|  | bool | parentHasChanged
| ) |  |

virtual

Internal method to update the Node.

Note
  Updates this node and any relevant children to incorporate transforms etc. Don't call this yourself unless you are writing a SceneManager implementation.

Parameters

  updateChildren | If `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.
  parentHasChanged | This 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 in Ogre::SceneNode.

## _updateFromParent()

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

protected virtual

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.

## addChild()

virtual void Ogre::Node::addChild | ( | Node * | child | ) |

virtual

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

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

Parameters

  child | The Node which is to become a child node of this one

## cancelUpdate()

virtual void Ogre::Node::cancelUpdate | ( | Node * | child | ) |

virtual

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

## convertLocalToWorldOrientation()

virtual Quaternion Ogre::Node::convertLocalToWorldOrientation | ( | const Quaternion & | localOrientation | ) |

virtual

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

## convertLocalToWorldPosition()

virtual Vector3 Ogre::Node::convertLocalToWorldPosition | ( | const Vector3 & | localPos | ) |

virtual

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

## convertWorldToLocalOrientation()

virtual Quaternion Ogre::Node::convertWorldToLocalOrientation | ( | const Quaternion & | worldOrientation | ) |

virtual

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

## convertWorldToLocalPosition()

virtual Vector3 Ogre::Node::convertWorldToLocalPosition | ( | const Vector3 & | worldPos | ) |

virtual

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

## createChild() [1/2]

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

virtual

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

Parameters

  translate | Initial translation offset of child relative to parent
  rotate | Initial rotation relative to parent

## createChild() [2/2]

virtual Node* Ogre::Node::createChild | ( | const String & | name,
|  | const Vector3 & | translate = `Vector3::ZERO`,
|  | const Quaternion & | rotate = `Quaternion::IDENTITY`
| ) |  |

virtual

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

  translate | Initial translation offset of child relative to parent
  rotate | Initial rotation relative to parent

## createChildImpl() [1/2]

virtual Node* Ogre::Node::createChildImpl | ( | void |  | ) |

protected pure virtual

Internal method for creating a new child node - must be overridden per subclass.

Implemented in Ogre::Bone, and Ogre::SceneNode.

## createChildImpl() [2/2]

virtual Node* Ogre::Node::createChildImpl | ( | const String & | name | ) |

protected pure virtual

Internal method for creating a new child node - must be overridden per subclass.

Implemented in Ogre::Bone, and Ogre::SceneNode.

## getChild() [1/2]

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

virtual

Gets a pointer to a child node.

Remarks
  There is an alternate getChild method which returns a named child.

## getChild() [2/2]

virtual Node* Ogre::Node::getChild | ( | const String & | name | ) | const

virtual

Gets a pointer to a named child node.

## getChildIterator() [1/2]

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

virtual

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.

## getChildIterator() [2/2]

virtual ConstChildNodeIterator Ogre::Node::getChildIterator | ( | void |  | ) | const

virtual

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.

## getDebugRenderable()

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

virtual

Get a debug renderable for rendering the Node.

## getInheritOrientation()

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

virtual

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.

## getInheritScale()

virtual bool Ogre::Node::getInheritScale | ( | void |  | ) | const

virtual

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

Remarks
  See setInheritScale for more info.

## getInitialOrientation()

virtual const Quaternion& Ogre::Node::getInitialOrientation | ( | void |  | ) | const

virtual

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

## getInitialPosition()

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

virtual

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

Remarks
  Also resets the cumulative animation weight used for blending.

## getInitialScale()

virtual const Vector3& Ogre::Node::getInitialScale | ( | void |  | ) | const

virtual

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

## getListener()

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

virtual

Gets the current listener for this Node.

Definition at line 670 of file OgreNode.h.

## getLocalAxes()

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

virtual

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

## getName()

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

Returns the name of the node.

## getOrientation()

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

virtual

Returns a quaternion representing the nodes orientation.

## getParent()

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

virtual

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

## getPosition()

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

virtual

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

## getScale()

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

virtual

Gets the scaling factor of this node.

## getSquaredViewDepth()

virtual Real Ogre::Node::getSquaredViewDepth | ( | const Camera * | cam | ) | const

virtual

Helper function, get the squared view depth.

## getUserAny()

virtual OGRE_DEPRECATED const Any& Ogre::Node::getUserAny | ( | void |  | ) | const

virtual

Deprecated:
  use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 760 of file OgreNode.h.

## getUserObjectBindings() [1/2]

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

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.

## getUserObjectBindings() [2/2]

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

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.

## needUpdate()

virtual void Ogre::Node::needUpdate | ( | bool | forceParentUpdate = `false` | ) |

virtual

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

  forceParentUpdate | Even if the node thinks it has already told it's parent, tell it anyway

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

## numChildren()

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

virtual

Reports the number of child nodes under this one.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

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.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

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.

## operator new() [1/3]

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.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

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.

## operator new[]() [1/2]

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.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## pitch()

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

virtual

Rotate the node around the X-axis.

## processQueuedUpdates()

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

static

Process queued 'needUpdate' calls.

## queueNeedUpdate()

static void Ogre::Node::queueNeedUpdate | ( | Node * | n | ) |

static

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.

## removeAllChildren()

virtual void Ogre::Node::removeAllChildren | ( | void |  | ) |

virtual

Removes all child Nodes attached to this node.

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

## removeChild() [1/3]

virtual Node* Ogre::Node::removeChild | ( | unsigned short | index | ) |

virtual

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.

## removeChild() [2/3]

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

virtual

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.

## removeChild() [3/3]

virtual Node* Ogre::Node::removeChild | ( | const String & | name | ) |

virtual

Drops the named child from this node.

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

## requestUpdate()

virtual void Ogre::Node::requestUpdate | ( | Node * | child,
|  | bool | forceParentUpdate = `false`
| ) |  |

virtual

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

Parameters

  forceParentUpdate | Even if the node thinks it has already told it's parent, tell it anyway

## resetOrientation()

virtual void Ogre::Node::resetOrientation | ( | void |  | ) |

virtual

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.

## resetToInitialState()

virtual void Ogre::Node::resetToInitialState | ( | void |  | ) |

virtual

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

## roll()

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

virtual

Rotate the node around the Z-axis.

## rotate() [1/2]

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

virtual

Rotate the node around an arbitrary axis.

## rotate() [2/2]

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

virtual

Rotate the node around an aritrary axis using a Quarternion.

## scale() [1/2]

virtual void Ogre::Node::scale | ( | const Vector3 & | scale | ) |

virtual

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.

## scale() [2/2]

virtual void Ogre::Node::scale | ( | Real | x,
|  | Real | y,
|  | Real | z
| ) |  |

virtual

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.

## setInheritOrientation()

virtual void Ogre::Node::setInheritOrientation | ( | bool | inherit | ) |

virtual

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

  inherit | If true, this node's orientation will be affected by its parent's orientation. If false, it will not be affected.

## setInheritScale()

virtual void Ogre::Node::setInheritScale | ( | bool | inherit | ) |

virtual

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

  inherit | If true, this node's scale will be affected by its parent's scale. If false, it will not be affected.

## setInitialState()

virtual void Ogre::Node::setInitialState | ( | void |  | ) |

virtual

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.

## setListener()

virtual void Ogre::Node::setListener | ( | Listener * | listener | ) |

virtual

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.

## setOrientation() [1/2]

virtual void Ogre::Node::setOrientation | ( | const Quaternion & | q | ) |

virtual

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.

## setOrientation() [2/2]

virtual void Ogre::Node::setOrientation | ( | Real | w,
|  | Real | x,
|  | Real | y,
|  | Real | z
| ) |  |

virtual

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.

## setParent()

virtual void Ogre::Node::setParent | ( | Node * | parent | ) |

protected virtual

Only available internally - notification of parent.

Reimplemented in Ogre::SceneNode.

## setPosition() [1/2]

virtual void Ogre::Node::setPosition | ( | const Vector3 & | pos | ) |

virtual

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

## setPosition() [2/2]

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

virtual

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

## setScale() [1/2]

virtual void Ogre::Node::setScale | ( | const Vector3 & | scale | ) |

virtual

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.

## setScale() [2/2]

virtual void Ogre::Node::setScale | ( | Real | x,
|  | Real | y,
|  | Real | z
| ) |  |

virtual

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.

## setUserAny()

virtual OGRE_DEPRECATED void Ogre::Node::setUserAny | ( | const Any & | anything | ) |

virtual

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.

## translate() [1/4]

virtual void Ogre::Node::translate | ( | const Vector3 & | d,
|  | TransformSpace | relativeTo = `TS_PARENT`
| ) |  |

virtual

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

  d | Vector with x,y,z values representing the translation.
  relativeTo | The space which this transform is relative to.

## translate() [2/4]

virtual void Ogre::Node::translate | ( | Real | x,
|  | Real | y,
|  | Real | z,
|  | TransformSpace | relativeTo = `TS_PARENT`
| ) |  |

virtual

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

  x | Real `x` value representing the translation.
  y | Real `y` value representing the translation.
  z | Real `z` value representing the translation.
  relativeTo | The space which this transform is relative to.

## translate() [3/4]

virtual void Ogre::Node::translate | ( | const Matrix3 & | axes,
|  | const Vector3 & | move,
|  | TransformSpace | relativeTo = `TS_PARENT`
| ) |  |

virtual

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

  axes

  A 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.

  move | Vector relative to the axes above.
  relativeTo | The space which this transform is relative to.

## translate() [4/4]

virtual void Ogre::Node::translate | ( | const Matrix3 & | axes,
|  | Real | x,
|  | Real | y,
|  | Real | z,
|  | TransformSpace | relativeTo = `TS_PARENT`
| ) |  |

virtual

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

  axes

  A 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.

  x | The `x` translation component relative to the axes above.
  y | The `y` translation component relative to the axes above.
  z | The `z` translation component relative to the axes above.
  relativeTo | The space which this transform is relative to.

## updateFromParentImpl()

virtual void Ogre::Node::updateFromParentImpl | ( | void |  | ) | const

protected virtual

Class-specific implementation of _updateFromParent.

Remarks
  Splitting the implementation of the update away from the update call itself allows the detail to be overridden without disrupting the general sequence of updateFromParent (e.g. raising events)

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

## yaw()

virtual void Ogre::Node::yaw | ( | const Radian & | angle,
|  | TransformSpace | relativeTo = `TS_LOCAL`
| ) |  |

virtual

Rotate the node around the Y-axis.

Reimplemented in Ogre::SceneNode.

## Member Data Documentation

## mCachedTransform

Matrix4 Ogre::Node::mCachedTransform

mutable protected

Cached derived transform as a 4x4 matrix.

Definition at line 225 of file OgreNode.h.

## mCachedTransformOutOfDate

bool Ogre::Node::mCachedTransformOutOfDate

mutable protected

Definition at line 226 of file OgreNode.h.

## mChildren

ChildNodeMap Ogre::Node::mChildren

protected

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 129 of file OgreNode.h.

## mChildrenToUpdate

ChildUpdateSet Ogre::Node::mChildrenToUpdate

mutable protected

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.

## mDebug

DebugRenderable* Ogre::Node::mDebug

protected

Definition at line 234 of file OgreNode.h.

## mDerivedOrientation

Quaternion Ogre::Node::mDerivedOrientation

mutable protected

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.

## mDerivedPosition

Vector3 Ogre::Node::mDerivedPosition

mutable protected

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.

## mDerivedScale

Vector3 Ogre::Node::mDerivedScale

mutable protected

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.

## mInheritOrientation

bool Ogre::Node::mInheritOrientation

protected

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

Definition at line 159 of file OgreNode.h.

## mInheritScale

bool Ogre::Node::mInheritScale

protected

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

Definition at line 162 of file OgreNode.h.

## mInitialOrientation

Quaternion Ogre::Node::mInitialOrientation

protected

The orientation to use as a base for keyframe animation.

Definition at line 220 of file OgreNode.h.

## mInitialPosition

Vector3 Ogre::Node::mInitialPosition

protected

The position to use as a base for keyframe animation.

Definition at line 218 of file OgreNode.h.

## mInitialScale

Vector3 Ogre::Node::mInitialScale

protected

The scale to use as a base for keyframe animation.

Definition at line 222 of file OgreNode.h.

## mListener

Listener* Ogre::Node::mListener

protected

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

Definition at line 229 of file OgreNode.h.

## mName

String Ogre::Node::mName

protected

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

Definition at line 144 of file OgreNode.h.

## mNeedChildUpdate

bool Ogre::Node::mNeedChildUpdate

mutable protected

Flag indicating that all children need to be updated.

Definition at line 137 of file OgreNode.h.

## mNeedParentUpdate

bool Ogre::Node::mNeedParentUpdate

mutable protected

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

Definition at line 135 of file OgreNode.h.

## mOrientation

Quaternion Ogre::Node::mOrientation

protected

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

Definition at line 150 of file OgreNode.h.

## mParent

Node* Ogre::Node::mParent

protected

Pointer to parent node.

Definition at line 127 of file OgreNode.h.

## mParentNotified

bool Ogre::Node::mParentNotified

mutable protected

Flag indicating that parent has been notified about update request.

Definition at line 139 of file OgreNode.h.

## mPosition

Vector3 Ogre::Node::mPosition

protected

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

Definition at line 153 of file OgreNode.h.

## mQueuedForUpdate

bool Ogre::Node::mQueuedForUpdate

mutable protected

Flag indicating that the node has been queued for update.

Definition at line 141 of file OgreNode.h.

## mScale

Vector3 Ogre::Node::mScale

protected

Stores the scaling factor applied to this node.

Definition at line 156 of file OgreNode.h.

## msNameGenerator

NameGenerator Ogre::Node::msNameGenerator

static protected

Incremented count for next name extension.

Definition at line 147 of file OgreNode.h.

## msQueuedUpdates

QueuedUpdates Ogre::Node::msQueuedUpdates

static protected

Definition at line 232 of file OgreNode.h.

## mUserObjectBindings

UserObjectBindings Ogre::Node::mUserObjectBindings

protected

User objects binding.

Definition at line 237 of file OgreNode.h.

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

- OgreNode.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.