A bone in a skeleton. More...

#include <OgreBone.h>

Inheritance diagram for Ogre::Bone:

Collaboration diagram for Ogre::Bone:

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
	Bone (unsigned short handle, Skeleton *creator)
	Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone) More...

	Bone (const String &name, unsigned short handle, Skeleton *creator)
	Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone) More...

	~Bone ()

const Quaternion &	_getBindingPoseInverseOrientation (void) const
	Gets the inverted binding pose orientation. More...

const Vector3 &	_getBindingPoseInversePosition (void) const
	Gets the inverted binding pose position. More...

const Vector3 &	_getBindingPoseInverseScale (void) const
	Gets the inverted binding pose scale. More...

virtual const Quaternion &	_getDerivedOrientation (void) const
	Gets the orientation of the node as derived from all parents. More...

virtual const Vector3 &	_getDerivedPosition (void) const
	Gets the position of the node as derived from all parents. More...

virtual const Vector3 &	_getDerivedScale (void) const
	Gets the scaling factor of the node as derived from all parents. More...

virtual const Matrix4 &	_getFullTransform (void) const
	Gets the full transformation matrix for this node. More...

void	_getOffsetTransform (Matrix4 &m) const
	Gets the transform which takes bone space to current from the binding pose. 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...

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

unsigned short	getHandle (void) const
	Gets the numeric handle for this bone (unique within the skeleton). 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...

bool	isManuallyControlled () const
	Getter for mManuallyControlled Flag. More...

void	needUpdate (bool forceParentUpdate=false)

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

void	reset (void)
	Resets the position and orientation of this Bone to the original binding position. 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...

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

void	setManuallyControlled (bool manuallyControlled)
	Sets whether or not this bone is manually controlled. 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...

Node *	createChildImpl (void)
	See Node. More...

Node *	createChildImpl (const String &name)
	See Node. 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
Quaternion	mBindDerivedInverseOrientation
	The inversed derived orientation of the bone in the binding pose. More...

Vector3	mBindDerivedInversePosition
	The inversed derived position of the bone in the binding pose. More...

Vector3	mBindDerivedInverseScale
	The inversed derived scale of the bone in the binding pose. More...

Matrix4	mCachedTransform
	Cached derived transform as a 4x4 matrix. More...

bool	mCachedTransformOutOfDate

ChildNodeMap	mChildren
	Collection of pointers to direct children; hashmap for efficiency. More...

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

Skeleton *	mCreator
	Pointer back to creator, for child creation (not smart ptr so child does not preserve parent) More...

DebugRenderable *	mDebug

Quaternion	mDerivedOrientation
	Cached combined orientation. More...

Vector3	mDerivedPosition
	Cached combined position. More...

Vector3	mDerivedScale
	Cached combined scale. More...

unsigned short	mHandle
	The numeric handle of this bone. 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...

bool	mManuallyControlled
	Bones set as manuallyControlled are not reseted in Skeleton::reset() 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

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

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

inherited

Definition at line 78 of file OgreNode.h.

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

protectedinherited

Definition at line 131 of file OgreNode.h.

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

inherited

Definition at line 80 of file OgreNode.h.

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

protectedinherited

Definition at line 231 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 69 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

inline

Gets the inverted binding pose orientation.

Definition at line 120 of file OgreBone.h.

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

inline

Gets the inverted binding pose position.

Definition at line 118 of file OgreBone.h.

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

inline

Gets the inverted binding pose scale.

Definition at line 116 of file OgreBone.h.

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

Gets the full transformation matrix for this node.

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

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 )

virtualinherited

Sets the final world orientation of the node directly.

Remarks: It's advisable to use the local setOrientation if possible, this simply does the conversion for you.

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

virtualinherited

Sets the final world position of the node directly.

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

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

virtualinherited

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, Ogre::PCZSceneNode, and Ogre::BspSceneNode.

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

protectedvirtualinherited

Triggers the node to update it's combined transforms.

: This method is called internally by Ogre to ask the node to update it's complete transformation based on it's parents derived transform.

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

virtualinherited

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

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

Parameters

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

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

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

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

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

virtualinherited

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

Parameters

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`
	)

virtualinherited

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

Remarks: This creates a child node with a given name, which allows you to look the node up from the parent which holds this collection of nodes.

Parameters

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

Node* Ogre::Bone::createChildImpl ( void )

protectedvirtual

See Node.

Implements Ogre::Node.

Node* Ogre::Bone::createChildImpl ( const String & name )

protectedvirtual

See Node.

Implements Ogre::Node.

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

virtualinherited

Gets a pointer to a child node.

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

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

virtualinherited

Gets a pointer to a named child node.

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

virtualinherited

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

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

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

virtualinherited

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

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

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

virtualinherited

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

virtualinherited

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

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

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

virtualinherited

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

Remarks: See setInheritScale for more info.

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

virtualinherited

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

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

virtualinherited

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

Remarks: Also resets the cumulative animation weight used for blending.

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

virtualinherited

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

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

inlinevirtualinherited

Gets the current listener for this Node.

Definition at line 670 of file OgreNode.h.

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

virtualinherited

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

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

inherited

Returns the name of the node.

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

virtualinherited

Returns a quaternion representing the nodes orientation.

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

Gets the scaling factor of this node.

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

virtualinherited

Helper function, get the squared view depth.

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

inlinevirtualinherited

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 760 of file OgreNode.h.

UserObjectBindings& Ogre::Node::getUserObjectBindings ( )

inlineinherited

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

You can use it to associate one or more custom objects with this class instance.

See also: UserObjectBindings::setUserAny.

Definition at line 766 of file OgreNode.h.

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

inlineinherited

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.

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

virtualinherited

Reports the number of child nodes under this one.

template<class Alloc >

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

inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

virtualinherited

Rotate the node around the X-axis.

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

staticinherited

Process queued 'needUpdate' calls.

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

staticinherited

Queue a 'needUpdate' call to a node safely.

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

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

virtualinherited

Removes all child Nodes attached to this node.

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

Reimplemented in Ogre::OctreeNode.

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

virtualinherited

Drops the specified child from this node.

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

Reimplemented in Ogre::OctreeNode.

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

virtualinherited

Drops the specified child from this node.

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

Reimplemented in Ogre::OctreeNode.

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

virtualinherited

Drops the named child from this node.

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

Reimplemented in Ogre::OctreeNode.

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

virtualinherited

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

Parameters

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 )

virtualinherited

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

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

: Note that rotations are oriented around the node's origin.

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

virtualinherited

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

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

virtualinherited

Rotate the node around the Z-axis.

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

virtualinherited

Rotate the node around an arbitrary axis.

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

virtualinherited

Rotate the node around an aritrary axis using a Quarternion.

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

virtualinherited

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

Remarks: This method applies an extra scaling factor to the node's existing scale, (unlike setScale which overwrites it) combining it's current scale with the new one. E.g. calling this method twice with Vector3(2,2,2) would have the same effect as setScale(Vector3(4,4,4)) if the existing scale was 1.

: Note that like rotations, scalings are oriented around the node's origin.

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

virtualinherited

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

Remarks: This method applies an extra scaling factor to the node's existing scale, (unlike setScale which overwrites it) combining it's current scale with the new one. E.g. calling this method twice with Vector3(2,2,2) would have the same effect as setScale(Vector3(4,4,4)) if the existing scale was 1.

: Note that like rotations, scalings are oriented around the node's origin.

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 )

virtualinherited

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

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

Parameters

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 )

virtualinherited

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

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

Parameters

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 )

virtualinherited

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

Remarks: You never need to call this method unless you plan to animate this node. If you do plan to animate it, call this method once you've loaded the node with it's base state, ie the state on which all keyframes are based.

: If you never call this method, the initial state is the identity transform, ie do nothing.

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

inlinevirtualinherited

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.

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 ( const Quaternion & q )

virtualinherited

Sets the orientation of this node via a quaternion.

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

: Note that rotations are oriented around the node's origin.

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

virtualinherited

Sets the orientation of this node via quaternion parameters.

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

: Note that rotations are oriented around the node's origin.

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

protectedvirtualinherited

Only available internally - notification of parent.

Reimplemented in Ogre::SceneNode.

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

virtualinherited

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

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

virtualinherited

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

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

virtualinherited

Sets the scaling factor applied to this node.

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

: Note that like rotations, scalings are oriented around the node's origin.

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

virtualinherited

Sets the scaling factor applied to this node.

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

: Note that like rotations, scalings are oriented around the node's origin.

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

inlinevirtualinherited

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

Sets any kind of user value on this object.

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

Definition at line 755 of file OgreNode.h.

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

virtualinherited

Moves the node along the Cartesian axes.

: This method moves the node by the supplied vector along the world Cartesian axes, i.e. along world x,y,z

Parameters

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

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

virtualinherited

Moves the node along the Cartesian axes.

: This method moves the node by the supplied vector along the world Cartesian axes, i.e. along world x,y,z

Parameters

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.

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

virtualinherited

Moves the node along arbitrary axes.

Remarks: This method translates the node by a vector which is relative to a custom set of axes.

Parameters

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.

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

virtualinherited

Moves the node along arbitrary axes.

Remarks: This method translates the node by a vector which is relative to a custom set of axes.

Parameters

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.

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

protectedvirtualinherited

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

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

virtualinherited

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

mutableprotectedinherited

Cached derived transform as a 4x4 matrix.

Definition at line 225 of file OgreNode.h.

bool Ogre::Node::mCachedTransformOutOfDate

mutableprotectedinherited

Definition at line 226 of file OgreNode.h.

ChildNodeMap Ogre::Node::mChildren

protectedinherited

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 129 of file OgreNode.h.

ChildUpdateSet Ogre::Node::mChildrenToUpdate

mutableprotectedinherited

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

Definition at line 133 of file OgreNode.h.

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

protectedinherited

Definition at line 234 of file OgreNode.h.

Quaternion Ogre::Node::mDerivedOrientation

mutableprotectedinherited

Cached combined orientation.

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

Definition at line 174 of file OgreNode.h.

Vector3 Ogre::Node::mDerivedPosition

mutableprotectedinherited

Cached combined position.

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

Definition at line 183 of file OgreNode.h.

Vector3 Ogre::Node::mDerivedScale

mutableprotectedinherited

Cached combined scale.

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

Definition at line 192 of file OgreNode.h.

unsigned short Ogre::Bone::mHandle

protected

The numeric handle of this bone.

Definition at line 128 of file OgreBone.h.

bool Ogre::Node::mInheritOrientation

protectedinherited

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

Definition at line 159 of file OgreNode.h.

bool Ogre::Node::mInheritScale

protectedinherited

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

Definition at line 162 of file OgreNode.h.

Quaternion Ogre::Node::mInitialOrientation

protectedinherited

The orientation to use as a base for keyframe animation.

Definition at line 220 of file OgreNode.h.

Vector3 Ogre::Node::mInitialPosition

protectedinherited

The position to use as a base for keyframe animation.

Definition at line 218 of file OgreNode.h.

Vector3 Ogre::Node::mInitialScale

protectedinherited

The scale to use as a base for keyframe animation.

Definition at line 222 of file OgreNode.h.

Listener* Ogre::Node::mListener

protectedinherited

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

Definition at line 229 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

protectedinherited

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

Definition at line 144 of file OgreNode.h.

bool Ogre::Node::mNeedChildUpdate

mutableprotectedinherited

Flag indicating that all children need to be updated.

Definition at line 137 of file OgreNode.h.

bool Ogre::Node::mNeedParentUpdate

mutableprotectedinherited

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

Definition at line 135 of file OgreNode.h.

Quaternion Ogre::Node::mOrientation

protectedinherited

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

Definition at line 150 of file OgreNode.h.

Node* Ogre::Node::mParent

protectedinherited

Pointer to parent node.

Definition at line 127 of file OgreNode.h.

bool Ogre::Node::mParentNotified

mutableprotectedinherited

Flag indicating that parent has been notified about update request.

Definition at line 139 of file OgreNode.h.

Vector3 Ogre::Node::mPosition

protectedinherited

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

Definition at line 153 of file OgreNode.h.

bool Ogre::Node::mQueuedForUpdate

mutableprotectedinherited

Flag indicating that the node has been queued for update.

Definition at line 141 of file OgreNode.h.

Vector3 Ogre::Node::mScale

protectedinherited

Stores the scaling factor applied to this node.

Definition at line 156 of file OgreNode.h.

NameGenerator Ogre::Node::msNameGenerator

staticprotectedinherited

Incremented count for next name extension.

Definition at line 147 of file OgreNode.h.

QueuedUpdates Ogre::Node::msQueuedUpdates

staticprotectedinherited

Definition at line 232 of file OgreNode.h.

UserObjectBindings Ogre::Node::mUserObjectBindings

protectedinherited

User objects binding.

Definition at line 237 of file OgreNode.h.

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

OgreBone.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation