# Ogre::Bone Class Reference
Animation

A bone in a skeleton. More...

`#include <OgreBone.h>`

Inheritance diagram for Ogre::Bone:
[legend]

List of all members.

## Public Types

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

## Public Member Functions

| Bone (unsigned short handle, Skeleton *creator)
| Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone)
| Bone (const String &name, unsigned short handle, Skeleton *creator)
| Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone)
| ~Bone ()
Bone * | createChild (unsigned short handle, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
| Creates a new Bone as a child of this bone.
unsigned short | getHandle (void) const
| Gets the numeric handle for this bone (unique within the skeleton).
void | setBindingPose (void)
| Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh.
void | reset (void)
| Resets the position and orientation of this Bone to the original binding position.
void | setManuallyControlled (bool manuallyControlled)
| Sets whether or not this bone is manually controlled.
bool | isManuallyControlled () const
| Getter for mManuallyControlled Flag.
void | _getOffsetTransform (Matrix4 &m) const
| Gets the transform which takes bone space to current from the binding pose.
const Vector3 & | _getBindingPoseInverseScale (void) const
| Gets the inverted binding pose scale.
const Vector3 & | _getBindingPoseInversePosition (void) const
| Gets the inverted binding pose position.
const Quaternion & | _getBindingPoseInverseOrientation (void) const
| Gets the inverted binding pose orientation.
void | needUpdate (bool forceParentUpdate=false)
const String & | getName (void) const
| Returns the name of the node.
virtual Node * | getParent (void) const
| Gets this node's parent (NULL if this is the root).
virtual const Quaternion & | getOrientation () const
| Returns a quaternion representing the nodes orientation.
virtual void | setOrientation (const Quaternion &q)
| Sets the orientation of this node via a quaternion.
virtual void | setOrientation (Real w, Real x, Real y, Real z)
| Sets the orientation of this node via quaternion parameters.
virtual void | resetOrientation (void)
| Resets the nodes orientation (local axes as world axes, no rotation).
virtual void | setPosition (const Vector3 &pos)
| Sets the position of the node relative to it's parent.
virtual void | setPosition (Real x, Real y, Real z)
| Sets the position of the node relative to it's parent.
virtual const Vector3 & | getPosition (void) const
| Gets the position of the node relative to it's parent.
virtual void | setScale (const Vector3 &scale)
| Sets the scaling factor applied to this node.
virtual void | setScale (Real x, Real y, Real z)
| Sets the scaling factor applied to this node.
virtual const Vector3 & | getScale (void) const
| Gets the scaling factor of this node.
virtual void | setInheritOrientation (bool inherit)
| Tells the node whether it should inherit orientation from it's parent node.
virtual bool | getInheritOrientation (void) const
| Returns true if this node is affected by orientation applied to the parent node.
virtual void | setInheritScale (bool inherit)
| Tells the node whether it should inherit scaling factors from it's parent node.
virtual bool | getInheritScale (void) const
| Returns true if this node is affected by scaling factors applied to the parent node.
virtual void | scale (const Vector3 &scale)
| Scales the node, combining it's current scale with the passed in scaling factor.
virtual void | scale (Real x, Real y, Real z)
| Scales the node, combining it's current scale with the passed in scaling factor.
virtual void | translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT)
| Moves the node along the Cartesian axes.
virtual void | translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
| Moves the node along the Cartesian axes.
virtual void | translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT)
| Moves the node along arbitrary axes.
virtual void | translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
| Moves the node along arbitrary axes.
virtual void | roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around the Z-axis.
virtual void | pitch (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around the X-axis.
virtual void | yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around the Y-axis.
virtual void | rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around an arbitrary axis.
virtual void | rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around an aritrary axis using a Quarternion.
virtual Matrix3 | getLocalAxes (void) const
| Gets a matrix whose columns are the local axes based on the nodes orientation relative to it's parent.
virtual Node * | createChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
| Creates an unnamed new Node as a child of this node.
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.
virtual void | addChild (Node *child)
| Adds a (precreated) child scene node to this node.
virtual unsigned short | numChildren (void) const
| Reports the number of child nodes under this one.
virtual Node * | getChild (unsigned short index) const
| Gets a pointer to a child node.
virtual Node * | getChild (const String &name) const
| Gets a pointer to a named child node.
virtual ChildNodeIterator | getChildIterator (void)
| Retrieves an iterator for efficiently looping through all children of this node.
virtual ConstChildNodeIterator | getChildIterator (void) const
| Retrieves an iterator for efficiently looping through all children of this node.
virtual Node * | removeChild (unsigned short index)
| Drops the specified child from this node.
virtual Node * | removeChild (Node *child)
| Drops the specified child from this node.
virtual Node * | removeChild (const String &name)
| Drops the named child from this node.
virtual void | removeAllChildren (void)
| Removes all child Nodes attached to this node.
virtual void | _setDerivedPosition (const Vector3 &pos)
| Sets the final world position of the node directly.
virtual void | _setDerivedOrientation (const Quaternion &q)
| Sets the final world orientation of the node directly.
virtual const Quaternion & | _getDerivedOrientation (void) const
| Gets the orientation of the node as derived from all parents.
virtual const Vector3 & | _getDerivedPosition (void) const
| Gets the position of the node as derived from all parents.
virtual const Vector3 & | _getDerivedScale (void) const
| Gets the scaling factor of the node as derived from all parents.
virtual const Matrix4 & | _getFullTransform (void) const
| Gets the full transformation matrix for this node.
virtual void | _update (bool updateChildren, bool parentHasChanged)
| Internal method to update the Node.
virtual void | setListener (Listener *listener)
| Sets a listener for this Node.
virtual Listener * | getListener (void) const
| Gets the current listener for this Node.
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.
virtual void | resetToInitialState (void)
| Resets the position / orientation / scale of this node to it's initial state, see setInitialState for more info.
virtual const Vector3 & | getInitialPosition (void) const
| Gets the initial position of this node, see setInitialState for more info.
virtual Vector3 | convertWorldToLocalPosition (const Vector3 &worldPos)
| Gets the local position, relative to this node, of the given world-space position.
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.
virtual Quaternion | convertWorldToLocalOrientation (const Quaternion &worldOrientation)
| Gets the local orientation, relative to this node, of the given world-space orientation.
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.
virtual const Quaternion & | getInitialOrientation (void) const
| Gets the initial orientation of this node, see setInitialState for more info.
virtual const Vector3 & | getInitialScale (void) const
| Gets the initial position of this node, see setInitialState for more info.
Real | getSquaredViewDepth (const Camera *cam) const
| Helper function, get the squared view depth.
virtual void | requestUpdate (Node *child, bool forceParentUpdate=false)
| Called by children to notify their parent that they need an update.
virtual void | cancelUpdate (Node *child)
| Called by children to notify their parent that they no longer need an update.
virtual DebugRenderable * | getDebugRenderable (Real scaling)
| Get a debug renderable for rendering the Node.
virtual void | setUserAny (const Any &anything)
virtual const Any & | getUserAny (void) const
UserObjectBindings & | getUserObjectBindings ()
| Return an instance of user objects binding associated with this class.
const UserObjectBindings & | getUserObjectBindings () const
| Return an instance of user objects binding associated with this class.
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
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 *)

## Static Public Member Functions

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

## Protected Types

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

## Protected Member Functions

Node * | createChildImpl (void)
| See Node.
Node * | createChildImpl (const String &name)
| See Node.
virtual void | setParent (Node *parent)
| Only available internally - notification of parent.
virtual void | _updateFromParent (void) const
| Triggers the node to update it's combined transforms.
virtual void | updateFromParentImpl (void) const
| Class-specific implementation of _updateFromParent.

## Protected Attributes

unsigned short | mHandle
| The numeric handle of this bone.
bool | mManuallyControlled
| Bones set as manuallyControlled are not reseted in Skeleton::reset()
Skeleton * | mCreator
| Pointer back to creator, for child creation (not smart ptr so child does not preserve parent)
Vector3 | mBindDerivedInverseScale
| The inversed derived scale of the bone in the binding pose.
Quaternion | mBindDerivedInverseOrientation
| The inversed derived orientation of the bone in the binding pose.
Vector3 | mBindDerivedInversePosition
| The inversed derived position of the bone in the binding pose.
Node * | mParent
| Pointer to parent node.
ChildNodeMap | mChildren
| Collection of pointers to direct children; hashmap for efficiency.
ChildUpdateSet | mChildrenToUpdate
| List of children which need updating, used if self is not out of date but children are.
bool | mNeedParentUpdate
| Flag to indicate own transform from parent is out of date.
bool | mNeedChildUpdate
| Flag indicating that all children need to be updated.
bool | mParentNotified
| Flag indicating that parent has been notified about update request.
bool | mQueuedForUpdate
| Flag indicating that the node has been queued for update.
String | mName
| Friendly name of this node, can be automatically generated if you don't care.
Quaternion | mOrientation
| Stores the orientation of the node relative to it's parent.
Vector3 | mPosition
| Stores the position/translation of the node relative to its parent.
Vector3 | mScale
| Stores the scaling factor applied to this node.
bool | mInheritOrientation
| Stores whether this node inherits orientation from it's parent.
bool | mInheritScale
| Stores whether this node inherits scale from it's parent.
Quaternion | mDerivedOrientation
| Cached combined orientation.
Vector3 | mDerivedPosition
| Cached combined position.
Vector3 | mDerivedScale
| Cached combined scale.
Vector3 | mInitialPosition
| The position to use as a base for keyframe animation.
Quaternion | mInitialOrientation
| The orientation to use as a base for keyframe animation.
Vector3 | mInitialScale
| The scale to use as a base for keyframe animation.
Matrix4 | mCachedTransform
| Cached derived transform as a 4x4 matrix.
bool | mCachedTransformOutOfDate
Listener * | mListener
| Node listener - only one allowed (no list) for size & performance reasons.
DebugRenderable * | mDebug
UserObjectBindings | mUserObjectBindings
| User objects binding.

## Static Protected Attributes

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

## Detailed Description

A bone in a skeleton.

Remarks:
  See Skeleton for more information about the principles behind skeletal animation. This class is a node in the joint hierarchy. Mesh vertices also have assignments to bones to define how they move in relation to the skeleton.

Definition at line 51 of file OgreBone.h.

## Member Typedef Documentation

typedef MapIterator<ChildNodeMap> Ogre::Node::ChildNodeIterator`[inherited]`

Definition at line 77 of file OgreNode.h.

typedef HashMap<String, Node*> Ogre::Node::ChildNodeMap`[inherited]`

Definition at line 76 of file OgreNode.h.

typedef set<Node*>::type Ogre::Node::ChildUpdateSet`[protected, inherited]`

Definition at line 129 of file OgreNode.h.

typedef ConstMapIterator<ChildNodeMap> Ogre::Node::ConstChildNodeIterator`[inherited]`

Definition at line 78 of file OgreNode.h.

typedef vector<Node*>::type Ogre::Node::QueuedUpdates`[protected, inherited]`

Definition at line 229 of file OgreNode.h.

## Member Enumeration Documentation

enum Ogre::Node::TransformSpace`[inherited]`

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 67 of file OgreNode.h.

## Constructor & Destructor Documentation

Ogre::Bone::Bone | ( | unsigned short | handle,
|  | Skeleton * | creator
| ) |  |

Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone)

Ogre::Bone::Bone | ( | const String & | name,
|  | unsigned short | handle,
|  | Skeleton * | creator
| ) |  |

Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone)

Ogre::Bone::~Bone | ( |  | ) |

## Member Function Documentation

const Quaternion& Ogre::Bone::_getBindingPoseInverseOrientation | ( | void |  | ) | const

Gets the inverted binding pose orientation.

Definition at line 120 of file OgreBone.h.

const Vector3& Ogre::Bone::_getBindingPoseInversePosition | ( | void |  | ) | const

Gets the inverted binding pose position.

Definition at line 118 of file OgreBone.h.

const Vector3& Ogre::Bone::_getBindingPoseInverseScale | ( | void |  | ) | const

Gets the inverted binding pose scale.

Definition at line 116 of file OgreBone.h.

virtual const Quaternion& Ogre::Node::_getDerivedOrientation | ( | void |  | ) | const`[virtual, inherited]`

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

virtual const Vector3& Ogre::Node::_getDerivedPosition | ( | void |  | ) | const`[virtual, inherited]`

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

virtual const Vector3& Ogre::Node::_getDerivedScale | ( | void |  | ) | const`[virtual, inherited]`

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

virtual const Matrix4& Ogre::Node::_getFullTransform | ( | void |  | ) | const`[virtual, inherited]`

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.

void Ogre::Bone::_getOffsetTransform | ( | Matrix4 & | m | ) | const

Gets the transform which takes bone space to current from the binding pose.

Remarks:
  Internal use only.

virtual void Ogre::Node::_setDerivedOrientation | ( | const Quaternion & | q | ) | `[virtual, inherited]`

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 | ) | `[virtual, inherited]`

Sets the final world position of the node directly.

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

virtual void Ogre::Node::_update | ( | bool | updateChildren,
|  | bool | parentHasChanged
| ) |  | `[virtual, inherited]`

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 xform has changed, so the child should retrieve the parent's xform and combine it with its own even if it hasn't changed itself.

Reimplemented in Ogre::SceneNode.

virtual void Ogre::Node::_updateFromParent | ( | void |  | ) | const`[protected, virtual, inherited]`

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 | ) | `[virtual, inherited]`

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

virtual void Ogre::Node::cancelUpdate | ( | Node * | child | ) | `[virtual, inherited]`

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

virtual Quaternion Ogre::Node::convertLocalToWorldOrientation | ( | const Quaternion & | localOrientation | ) | `[virtual, inherited]`

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 | ) | `[virtual, inherited]`

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 | ) | `[virtual, inherited]`

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

virtual Vector3 Ogre::Node::convertWorldToLocalPosition | ( | const Vector3 & | worldPos | ) | `[virtual, inherited]`

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`
| ) |  | `[virtual, inherited]`

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

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

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

Bone* Ogre::Bone::createChild | ( | unsigned short | handle,
|  | const Vector3 & | translate = `Vector3::ZERO`,
|  | const Quaternion & | rotate = `Quaternion::IDENTITY`
| ) |  |

Creates a new Bone as a child of this bone.

Remarks:
  This method creates a new bone which will inherit the transforms of this bone, with the handle specified.

Parameters:

  handle | The numeric handle to give the new bone; must be unique within the Skeleton.
  translate | Initial translation offset of child relative to parent
  rotate | Initial rotation relative to parent

Node* Ogre::Bone::createChildImpl | ( | void |  | ) | `[protected, virtual]`

See Node.

Implements Ogre::Node.

Node* Ogre::Bone::createChildImpl | ( | const String & | name | ) | `[protected, virtual]`

See Node.

Implements Ogre::Node.

virtual Node* Ogre::Node::getChild | ( | unsigned short | index | ) | const`[virtual, inherited]`

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`[virtual, inherited]`

Gets a pointer to a named child node.

virtual ChildNodeIterator Ogre::Node::getChildIterator | ( | void |  | ) | `[virtual, inherited]`

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`[virtual, inherited]`

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 DebugRenderable* Ogre::Node::getDebugRenderable | ( | Real | scaling | ) | `[virtual, inherited]`

Get a debug renderable for rendering the Node.

unsigned short Ogre::Bone::getHandle | ( | void |  | ) | const

Gets the numeric handle for this bone (unique within the skeleton).

virtual bool Ogre::Node::getInheritOrientation | ( | void |  | ) | const`[virtual, inherited]`

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`[virtual, inherited]`

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`[virtual, inherited]`

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

virtual const Vector3& Ogre::Node::getInitialPosition | ( | void |  | ) | const`[virtual, inherited]`

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`[virtual, inherited]`

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

virtual Listener* Ogre::Node::getListener | ( | void |  | ) | const`[virtual, inherited]`

Gets the current listener for this Node.

Definition at line 664 of file OgreNode.h.

virtual Matrix3 Ogre::Node::getLocalAxes | ( | void |  | ) | const`[virtual, inherited]`

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`[virtual, inherited]`

Returns a quaternion representing the nodes orientation.

virtual Node* Ogre::Node::getParent | ( | void |  | ) | const`[virtual, inherited]`

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

virtual const Vector3& Ogre::Node::getPosition | ( | void |  | ) | const`[virtual, inherited]`

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

virtual const Vector3& Ogre::Node::getScale | ( | void |  | ) | const`[virtual, inherited]`

Gets the scaling factor of this node.

Real Ogre::Node::getSquaredViewDepth | ( | const Camera * | cam | ) | const`[inherited]`

Helper function, get the squared view depth.

virtual const Any& Ogre::Node::getUserAny | ( | void |  | ) | const`[virtual, inherited]`

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

Retrieves the custom user value associated with this object.

Definition at line 754 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 760 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 766 of file OgreNode.h.

bool Ogre::Bone::isManuallyControlled | ( |  | ) | const

Getter for mManuallyControlled Flag.

void Ogre::Bone::needUpdate | ( | bool | forceParentUpdate = `false` | ) | `[virtual]`

See also:
  Node::needUpdate

Reimplemented from Ogre::Node.

Reimplemented in Ogre::TagPoint.

virtual unsigned short Ogre::Node::numChildren | ( | void |  | ) | const`[virtual, inherited]`

Reports the number of child nodes under this one.

template<class Alloc >

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 118 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 78 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 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 72 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 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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

Rotate the node around the X-axis.

static void Ogre::Node::processQueuedUpdates | ( | void |  | ) | `[static, inherited]`

Process queued 'needUpdate' calls.

static void Ogre::Node::queueNeedUpdate | ( | Node * | n | ) | `[static, inherited]`

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 |  | ) | `[virtual, inherited]`

Removes all child Nodes attached to this node.

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

virtual Node* Ogre::Node::removeChild | ( | unsigned short | index | ) | `[virtual, inherited]`

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.

virtual Node* Ogre::Node::removeChild | ( | Node * | child | ) | `[virtual, inherited]`

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.

virtual Node* Ogre::Node::removeChild | ( | const String & | name | ) | `[virtual, inherited]`

Drops the named child from this node.

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

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

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

void Ogre::Bone::reset | ( | void |  | ) |

Resets the position and orientation of this Bone to the original binding position.

Remarks:
  Bones are bound to the mesh in a binding pose. They are then modified from this position during animation. This method returns the bone to it's original position and orientation.

virtual void Ogre::Node::resetOrientation | ( | void |  | ) | `[virtual, inherited]`

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 |  | ) | `[virtual, inherited]`

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`
| ) |  | `[virtual, inherited]`

Rotate the node around the Z-axis.

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

Rotate the node around an arbitrary axis.

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

Rotate the node around an aritrary axis using a Quarternion.

virtual void Ogre::Node::scale | ( | Real | x,
|  | Real | y,
|  | Real | z
| ) |  | `[virtual, inherited]`

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 | ( | const Vector3 & | scale | ) | `[virtual, inherited]`

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.

void Ogre::Bone::setBindingPose | ( | void |  | ) |

Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh.

virtual void Ogre::Node::setInheritOrientation | ( | bool | inherit | ) | `[virtual, inherited]`

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.

virtual void Ogre::Node::setInheritScale | ( | bool | inherit | ) | `[virtual, inherited]`

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.

virtual void Ogre::Node::setInitialState | ( | void |  | ) | `[virtual, inherited]`

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::Node::setListener | ( | Listener * | listener | ) | `[virtual, inherited]`

Sets a listener for this Node.

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

Definition at line 660 of file OgreNode.h.

void Ogre::Bone::setManuallyControlled | ( | bool | manuallyControlled | ) |

Sets whether or not this bone is manually controlled.

Remarks:
  Manually controlled bones can be altered by the application at runtime, and their positions will not be reset by the animation routines. Note that you should also make sure that there are no AnimationTrack objects referencing this bone, or if there are, you should disable them using pAnimation->destroyTrack(pBone->getHandle());

  You can also use AnimationState::setBlendMask to mask out animation from chosen tracks if you want to prevent application of a scripted animation to a bone without altering the Animation definition.

virtual void Ogre::Node::setOrientation | ( | Real | w,
|  | Real | x,
|  | Real | y,
|  | Real | z
| ) |  | `[virtual, inherited]`

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.

virtual void Ogre::Node::setOrientation | ( | const Quaternion & | q | ) | `[virtual, inherited]`

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::setParent | ( | Node * | parent | ) | `[protected, virtual, inherited]`

Only available internally - notification of parent.

Reimplemented in Ogre::SceneNode.

virtual void Ogre::Node::setPosition | ( | const Vector3 & | pos | ) | `[virtual, inherited]`

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

virtual void Ogre::Node::setPosition | ( | Real | x,
|  | Real | y,
|  | Real | z
| ) |  | `[virtual, inherited]`

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

virtual void Ogre::Node::setScale | ( | Real | x,
|  | Real | y,
|  | Real | z
| ) |  | `[virtual, inherited]`

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 | ( | const Vector3 & | scale | ) | `[virtual, inherited]`

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::setUserAny | ( | const Any & | anything | ) | `[virtual, inherited]`

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 749 of file OgreNode.h.

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

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

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

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.

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

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 containg 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,y,z | Translation components relative to the axes above.
  relativeTo | The space which this transform is relative to.

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

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 |
  y |
  z | Real x, y and z values representing the translation.
  relativeTo | The space which this transform is relative to.

virtual void Ogre::Node::updateFromParentImpl | ( | void |  | ) | const`[protected, virtual, inherited]`

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::SceneNode, and Ogre::TagPoint.

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

Rotate the node around the Y-axis.

Reimplemented in Ogre::SceneNode.

## Member Data Documentation

Quaternion Ogre::Bone::mBindDerivedInverseOrientation`[protected]`

The inversed derived orientation of the bone in the binding pose.

Definition at line 144 of file OgreBone.h.

Vector3 Ogre::Bone::mBindDerivedInversePosition`[protected]`

The inversed derived position of the bone in the binding pose.

Definition at line 146 of file OgreBone.h.

Vector3 Ogre::Bone::mBindDerivedInverseScale`[protected]`

The inversed derived scale of the bone in the binding pose.

Definition at line 142 of file OgreBone.h.

Matrix4 Ogre::Node::mCachedTransform`[mutable, protected, inherited]`

Cached derived transform as a 4x4 matrix.

Definition at line 223 of file OgreNode.h.

bool Ogre::Node::mCachedTransformOutOfDate`[mutable, protected, inherited]`

Definition at line 224 of file OgreNode.h.

ChildNodeMap Ogre::Node::mChildren`[protected, inherited]`

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 127 of file OgreNode.h.

ChildUpdateSet Ogre::Node::mChildrenToUpdate`[mutable, protected, inherited]`

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

Definition at line 131 of file OgreNode.h.

Skeleton* Ogre::Bone::mCreator`[protected]`

Pointer back to creator, for child creation (not smart ptr so child does not preserve parent)

Definition at line 139 of file OgreBone.h.

DebugRenderable* Ogre::Node::mDebug`[protected, inherited]`

Definition at line 232 of file OgreNode.h.

Quaternion Ogre::Node::mDerivedOrientation`[mutable, protected, inherited]`

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 172 of file OgreNode.h.

Vector3 Ogre::Node::mDerivedPosition`[mutable, protected, inherited]`

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 181 of file OgreNode.h.

Vector3 Ogre::Node::mDerivedScale`[mutable, protected, inherited]`

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 190 of file OgreNode.h.

unsigned short Ogre::Bone::mHandle`[protected]`

The numeric handle of this bone.

Definition at line 128 of file OgreBone.h.

bool Ogre::Node::mInheritOrientation`[protected, inherited]`

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

Definition at line 157 of file OgreNode.h.

bool Ogre::Node::mInheritScale`[protected, inherited]`

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

Definition at line 160 of file OgreNode.h.

Quaternion Ogre::Node::mInitialOrientation`[protected, inherited]`

The orientation to use as a base for keyframe animation.

Definition at line 218 of file OgreNode.h.

Vector3 Ogre::Node::mInitialPosition`[protected, inherited]`

The position to use as a base for keyframe animation.

Definition at line 216 of file OgreNode.h.

Vector3 Ogre::Node::mInitialScale`[protected, inherited]`

The scale to use as a base for keyframe animation.

Definition at line 220 of file OgreNode.h.

Listener* Ogre::Node::mListener`[protected, inherited]`

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

Definition at line 227 of file OgreNode.h.

bool Ogre::Bone::mManuallyControlled`[protected]`

Bones set as manuallyControlled are not reseted in Skeleton::reset()

Definition at line 131 of file OgreBone.h.

String Ogre::Node::mName`[protected, inherited]`

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

Definition at line 142 of file OgreNode.h.

bool Ogre::Node::mNeedChildUpdate`[mutable, protected, inherited]`

Flag indicating that all children need to be updated.

Definition at line 135 of file OgreNode.h.

bool Ogre::Node::mNeedParentUpdate`[mutable, protected, inherited]`

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

Definition at line 133 of file OgreNode.h.

Quaternion Ogre::Node::mOrientation`[protected, inherited]`

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

Definition at line 148 of file OgreNode.h.

Node* Ogre::Node::mParent`[protected, inherited]`

Pointer to parent node.

Definition at line 125 of file OgreNode.h.

bool Ogre::Node::mParentNotified`[mutable, protected, inherited]`

Flag indicating that parent has been notified about update request.

Definition at line 137 of file OgreNode.h.

Vector3 Ogre::Node::mPosition`[protected, inherited]`

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

Definition at line 151 of file OgreNode.h.

bool Ogre::Node::mQueuedForUpdate`[mutable, protected, inherited]`

Flag indicating that the node has been queued for update.

Definition at line 139 of file OgreNode.h.

Vector3 Ogre::Node::mScale`[protected, inherited]`

Stores the scaling factor applied to this node.

Definition at line 154 of file OgreNode.h.

NameGenerator Ogre::Node::msNameGenerator`[static, protected, inherited]`

Incremented count for next name extension.

Definition at line 145 of file OgreNode.h.

QueuedUpdates Ogre::Node::msQueuedUpdates`[static, protected, inherited]`

Definition at line 230 of file OgreNode.h.

UserObjectBindings Ogre::Node::mUserObjectBindings`[protected, inherited]`

User objects binding.

Definition at line 235 of file OgreNode.h.

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

- OgreBone.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun May 8 2011 20:28:10