Ogre::v1::OldNode Class Reference

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

#include <OgreOldNode.h>

Inheritance diagram for Ogre::v1::OldNode:

Classes
class	Listener
	Listener which gets called back on OldNode events. More...

Public Types
typedef MapIterator< ChildOldNodeMap >	ChildOldNodeIterator
typedef unordered_map< String, OldNode * >::type	ChildOldNodeMap
typedef ConstMapIterator< ChildOldNodeMap >	ConstChildOldNodeIterator
enum	TransformSpace { TS_LOCAL , TS_PARENT , TS_WORLD }
	Enumeration denoting the spaces which a transform can be relative to. More...

Public Member Functions
	OldNode ()
	Constructor, should only be called by parent, not directly.
	OldNode (const String &name)
	Constructor, should only be called by parent, not directly.
virtual	~OldNode ()
virtual const Quaternion &	_getDerivedOrientation (void) const
	Gets the orientation of the OldNode as derived from all parents.
virtual const Vector3 &	_getDerivedPosition (void) const
	Gets the position of the OldNode as derived from all parents.
virtual const Vector3 &	_getDerivedScale (void) const
	Gets the scaling factor of the OldNode as derived from all parents.
virtual const Matrix4 &	_getFullTransform (void) const
	Gets the full transformation matrix for this OldNode.
virtual void	_setDerivedOrientation (const Quaternion &q)
	Sets the final world orientation of the OldNode directly.
virtual void	_setDerivedPosition (const Vector3 &pos)
	Sets the final world position of the OldNode directly.
virtual void	_update (bool updateChildren, bool parentHasChanged)
	Internal method to update the OldNode.
virtual void	addChild (OldNode *child)
	Adds a (precreated) child scene OldNode to this OldNode.
virtual void	cancelUpdate (OldNode *child)
	Called by children to notify their parent that they no longer need an update.
virtual Quaternion	convertLocalToWorldOrientation (const Quaternion &localOrientation)
	Gets the world orientation of an orientation in the OldNode local space useful for simple transforms that don't require a child OldNode.
virtual Vector3	convertLocalToWorldPosition (const Vector3 &localPos)
	Gets the world position of a point in the OldNode local space useful for simple transforms that don't require a child OldNode.
virtual Quaternion	convertWorldToLocalOrientation (const Quaternion &worldOrientation)
	Gets the local orientation, relative to this OldNode, of the given world-space orientation.
virtual Vector3	convertWorldToLocalPosition (const Vector3 &worldPos)
	Gets the local position, relative to this OldNode, of the given world-space position.
virtual OldNode *	createChild (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
	Creates a new named OldNode as a child of this OldNode.
virtual OldNode *	createChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
	Creates an unnamed new OldNode as a child of this OldNode.
virtual OldNode *	getChild (const String &name) const
	Gets a pointer to a named child OldNode.
virtual OldNode *	getChild (unsigned short index) const
	Gets a pointer to a child OldNode.
virtual ChildOldNodeIterator	getChildIterator (void)
	Retrieves an iterator for efficiently looping through all children of this OldNode.
virtual ConstChildOldNodeIterator	getChildIterator (void) const
	Retrieves an iterator for efficiently looping through all children of this OldNode.
virtual bool	getInheritOrientation (void) const
	Returns true if this OldNode is affected by orientation applied to the parent OldNode.
virtual bool	getInheritScale (void) const
	Returns true if this OldNode is affected by scaling factors applied to the parent OldNode.
virtual const Quaternion &	getInitialOrientation (void) const
	Gets the initial orientation of this OldNode, see setInitialState for more info.
virtual const Vector3 &	getInitialPosition (void) const
	Gets the initial position of this OldNode, see setInitialState for more info.
virtual const Vector3 &	getInitialScale (void) const
	Gets the initial position of this OldNode, see setInitialState for more info.
virtual Listener *	getListener (void) const
	Gets the current listener for this OldNode.
virtual Matrix3	getLocalAxes (void) const
	Gets a matrix whose columns are the local axes based on the OldNodes orientation relative to it's parent.
const String &	getName (void) const
	Returns the name of the OldNode.
virtual const Quaternion &	getOrientation () const
	Returns a quaternion representing the OldNodes orientation.
virtual OldNode *	getParent (void) const
	Gets this OldNode's parent (NULL if this is the root).
virtual const Vector3 &	getPosition (void) const
	Gets the position of the OldNode relative to it's parent.
virtual const Vector3 &	getScale (void) const
	Gets the scaling factor of this OldNode.
virtual Real	getSquaredViewDepth (const Camera *cam) const
	Helper function, get the squared view depth.
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.
virtual void	needUpdate (bool forceParentUpdate=false)
	To be called in the event of transform changes to this OldNode that require it's recalculation.
virtual unsigned short	numChildren (void) const
	Reports the number of child OldNodes under this one.
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
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 *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
virtual void	pitch (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the OldNode around the X-axis.
virtual void	removeAllChildren (void)
	Removes all child OldNodes attached to this OldNode.
virtual OldNode *	removeChild (const String &name)
	Drops the named child from this OldNode.
virtual OldNode *	removeChild (OldNode *child)
	Drops the specified child from this OldNode.
virtual OldNode *	removeChild (unsigned short index)
	Drops the specified child from this OldNode.
virtual void	requestUpdate (OldNode *child, bool forceParentUpdate=false)
	Called by children to notify their parent that they need an update.
virtual void	resetOrientation (void)
	Resets the OldNodes orientation (local axes as world axes, no rotation).
virtual void	resetToInitialState (void)
	Resets the position / orientation / scale of this OldNode to it's initial state, see setInitialState for more info.
virtual void	roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the OldNode around the Z-axis.
virtual void	rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL)
	Rotate the OldNode around an aritrary axis using a Quarternion.
virtual void	rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the OldNode around an arbitrary axis.
virtual void	scale (const Vector3 &scale)
	Scales the OldNode, combining it's current scale with the passed in scaling factor.
virtual void	scale (Real x, Real y, Real z)
	Scales the OldNode, combining it's current scale with the passed in scaling factor.
virtual void	setInheritOrientation (bool inherit)
	Tells the OldNode whether it should inherit orientation from it's parent OldNode.
virtual void	setInheritScale (bool inherit)
	Tells the OldNode whether it should inherit scaling factors from it's parent OldNode.
virtual void	setInitialState (void)
	Sets the current transform of this OldNode 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	setListener (Listener *listener)
	Sets a listener for this OldNode.
virtual void	setOrientation (const Quaternion &q)
	Sets the orientation of this OldNode via a quaternion.
virtual void	setOrientation (Real w, Real x, Real y, Real z)
	Sets the orientation of this OldNode via quaternion parameters.
virtual void	setPosition (const Vector3 &pos)
	Sets the position of the OldNode relative to it's parent.
virtual void	setPosition (Real x, Real y, Real z)
	Sets the position of the OldNode relative to it's parent.
virtual void	setScale (const Vector3 &scale)
	Sets the scaling factor applied to this OldNode.
virtual void	setScale (Real x, Real y, Real z)
	Sets the scaling factor applied to this OldNode.
virtual void	setUserAny (const Any &anything)
virtual void	translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT)
	Moves the OldNode along arbitrary axes.
virtual void	translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
	Moves the OldNode along arbitrary axes.
virtual void	translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT)
	Moves the OldNode along the Cartesian axes.
virtual void	translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
	Moves the OldNode along the Cartesian axes.
virtual void	yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the OldNode around the Y-axis.

Static Public Member Functions
static void	processQueuedUpdates (void)
	Process queued 'needUpdate' calls.
static void	queueNeedUpdate (OldNode *n)
	Queue a 'needUpdate' call to a OldNode safely.

Detailed Description

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

Remarks

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

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

Member Typedef Documentation

ChildOldNodeIterator

typedef MapIterator<ChildOldNodeMap> Ogre::v1::OldNode::ChildOldNodeIterator

ChildOldNodeMap

typedef unordered_map<String,OldNode*>::type Ogre::v1::OldNode::ChildOldNodeMap

ConstChildOldNodeIterator

typedef ConstMapIterator<ChildOldNodeMap> Ogre::v1::OldNode::ConstChildOldNodeIterator

Member Enumeration Documentation

TransformSpace

enum Ogre::v1::OldNode::TransformSpace

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

Enumerator
TS_LOCAL	Transform is relative to the local space.
TS_PARENT	Transform is relative to the space of the parent OldNode.
TS_WORLD	Transform is relative to world space.

Constructor & Destructor Documentation

OldNode() [1/2]

Ogre::v1::OldNode::OldNode

(

)

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

Remarks

Generates a name.

OldNode() [2/2]

Ogre::v1::OldNode::OldNode

(

const String &

name

)

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

Remarks

Assigned a name.

~OldNode()

virtual Ogre::v1::OldNode::~OldNode ( )

virtual

Member Function Documentation

_getDerivedOrientation()

virtual const Quaternion & Ogre::v1::OldNode::_getDerivedOrientation ( void  ) const

virtual

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

_getDerivedPosition()

virtual const Vector3 & Ogre::v1::OldNode::_getDerivedPosition ( void  ) const

virtual

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

_getDerivedScale()

virtual const Vector3 & Ogre::v1::OldNode::_getDerivedScale ( void  ) const

virtual

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

_getFullTransform()

virtual const Matrix4 & Ogre::v1::OldNode::_getFullTransform ( void  ) const

virtual

Gets the full transformation matrix for this OldNode.

Remarks

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

_setDerivedOrientation()

virtual void Ogre::v1::OldNode::_setDerivedOrientation ( const Quaternion &  q )

virtual

Sets the final world orientation of the OldNode directly.

Remarks

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

_setDerivedPosition()

virtual void Ogre::v1::OldNode::_setDerivedPosition ( const Vector3 &  pos )

virtual

Sets the final world position of the OldNode directly.

Remarks

It's advisable to use the local setPosition if possible

_update()

virtual void Ogre::v1::OldNode::_update ( bool  updateChildren, bool  parentHasChanged  )

virtual

Internal method to update the OldNode.

Note

Updates this OldNode 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.

addChild()

virtual void Ogre::v1::OldNode::addChild ( OldNode *  child )

virtual

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

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

Parameters

child

The OldNode which is to become a child OldNode of this one

cancelUpdate()

virtual void Ogre::v1::OldNode::cancelUpdate ( OldNode *  child )

virtual

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

convertLocalToWorldOrientation()

virtual Quaternion Ogre::v1::OldNode::convertLocalToWorldOrientation ( const Quaternion &  localOrientation )

virtual

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

convertLocalToWorldPosition()

virtual Vector3 Ogre::v1::OldNode::convertLocalToWorldPosition ( const Vector3 &  localPos )

virtual

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

convertWorldToLocalOrientation()

virtual Quaternion Ogre::v1::OldNode::convertWorldToLocalOrientation ( const Quaternion &  worldOrientation )

virtual

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

convertWorldToLocalPosition()

virtual Vector3 Ogre::v1::OldNode::convertWorldToLocalPosition ( const Vector3 &  worldPos )

virtual

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

createChild() [1/2]

virtual OldNode * Ogre::v1::OldNode::createChild ( const String &  name, const Vector3 &  translate = Vector3::ZERO, const Quaternion &  rotate = Quaternion::IDENTITY  )

virtual

Creates a new named OldNode as a child of this OldNode.

Remarks

This creates a child OldNode with a given name, which allows you to look the OldNode up from the parent which holds this collection of OldNodes.

Parameters

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

createChild() [2/2]

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

virtual

Creates an unnamed new OldNode as a child of this OldNode.

Parameters

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

getChild() [1/2]

virtual OldNode * Ogre::v1::OldNode::getChild ( const String &  name ) const

virtual

Gets a pointer to a named child OldNode.

getChild() [2/2]

virtual OldNode * Ogre::v1::OldNode::getChild ( unsigned short  index ) const

virtual

Gets a pointer to a child OldNode.

Remarks

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

getChildIterator() [1/2]

virtual ChildOldNodeIterator Ogre::v1::OldNode::getChildIterator ( void  )

virtual

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

Remarks

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

getChildIterator() [2/2]

virtual ConstChildOldNodeIterator Ogre::v1::OldNode::getChildIterator ( void  ) const

virtual

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

Remarks

Using this is faster than repeatedly calling getChild if you want to go through all (or most of) the children of this OldNode. Note that the returned iterator is only valid whilst no children are added or removed from this OldNode. 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.

getInheritOrientation()

virtual bool Ogre::v1::OldNode::getInheritOrientation ( void  ) const

virtual

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

Remarks

Orientations, unlike other transforms, are not always inherited by child OldNodes. Whether or not orientations affect the orientation of the child OldNodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode is just for positioning another object, you want it to maintain it's own orientation). The default is to inherit as with other transforms.

See setInheritOrientation for more info.

getInheritScale()

virtual bool Ogre::v1::OldNode::getInheritScale ( void  ) const

virtual

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

Remarks

See setInheritScale for more info.

getInitialOrientation()

virtual const Quaternion & Ogre::v1::OldNode::getInitialOrientation ( void  ) const

virtual

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

getInitialPosition()

virtual const Vector3 & Ogre::v1::OldNode::getInitialPosition ( void  ) const

virtual

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

Remarks

Also resets the cumulative animation weight used for blending.

getInitialScale()

virtual const Vector3 & Ogre::v1::OldNode::getInitialScale ( void  ) const

virtual

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

getListener()

virtual Listener * Ogre::v1::OldNode::getListener ( void  ) const

inlinevirtual

Gets the current listener for this OldNode.

getLocalAxes()

virtual Matrix3 Ogre::v1::OldNode::getLocalAxes ( void  ) const

virtual

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

getName()

const String & Ogre::v1::OldNode::getName

(

void

)

const

Returns the name of the OldNode.

getOrientation()

virtual const Quaternion & Ogre::v1::OldNode::getOrientation ( ) const

virtual

Returns a quaternion representing the OldNodes orientation.

getParent()

virtual OldNode * Ogre::v1::OldNode::getParent ( void  ) const

virtual

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

getPosition()

virtual const Vector3 & Ogre::v1::OldNode::getPosition ( void  ) const

virtual

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

getScale()

virtual const Vector3 & Ogre::v1::OldNode::getScale ( void  ) const

virtual

Gets the scaling factor of this OldNode.

getSquaredViewDepth()

virtual Real Ogre::v1::OldNode::getSquaredViewDepth ( const Camera *  cam ) const

virtual

Helper function, get the squared view depth.

getUserAny()

virtual const Any & Ogre::v1::OldNode::getUserAny ( void  ) const

inlinevirtual

Deprecated:

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

getUserObjectBindings() [1/2]

UserObjectBindings & Ogre::v1::OldNode::getUserObjectBindings ( )

inline

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.

getUserObjectBindings() [2/2]

const UserObjectBindings & Ogre::v1::OldNode::getUserObjectBindings ( ) const

inline

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.

needUpdate()

virtual void Ogre::v1::OldNode::needUpdate ( bool  forceParentUpdate = false )

virtual

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

Remarks

This not only tags the OldNode state as being 'dirty', it also requests it's parent to know about it's dirtiness so it will get an update next time.

Parameters

forceParentUpdate

Even if the OldNode thinks it has already told it's parent, tell it anyway

Reimplemented in Ogre::v1::OldBone, and Ogre::v1::TagPoint.

numChildren()

virtual unsigned short Ogre::v1::OldNode::numChildren ( void  ) const

virtual

Reports the number of child OldNodes under this one.

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

pitch()

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

virtual

Rotate the OldNode around the X-axis.

processQueuedUpdates()

static void Ogre::v1::OldNode::processQueuedUpdates ( void  )

static

Process queued 'needUpdate' calls.

queueNeedUpdate()

static void Ogre::v1::OldNode::queueNeedUpdate ( OldNode *  n )

static

Queue a 'needUpdate' call to a OldNode safely.

Remarks

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

removeAllChildren()

virtual void Ogre::v1::OldNode::removeAllChildren ( void  )

virtual

Removes all child OldNodes attached to this OldNode.

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

removeChild() [1/3]

virtual OldNode * Ogre::v1::OldNode::removeChild ( const String &  name )

virtual

Drops the named child from this OldNode.

Remarks

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

removeChild() [2/3]

virtual OldNode * Ogre::v1::OldNode::removeChild ( OldNode *  child )

virtual

Drops the specified child from this OldNode.

Remarks

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

removeChild() [3/3]

virtual OldNode * Ogre::v1::OldNode::removeChild ( unsigned short  index )

virtual

Drops the specified child from this OldNode.

Remarks

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

requestUpdate()

virtual void Ogre::v1::OldNode::requestUpdate ( OldNode *  child, bool  forceParentUpdate = false  )

virtual

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

Parameters

forceParentUpdate

Even if the OldNode thinks it has already told it's parent, tell it anyway

resetOrientation()

virtual void Ogre::v1::OldNode::resetOrientation ( void  )

virtual

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

Remarks

Orientations, unlike other transforms, are not always inherited by child OldNodes. Whether or not orientations affect the orientation of the child OldNodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode 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 OldNode's origin.

resetToInitialState()

virtual void Ogre::v1::OldNode::resetToInitialState ( void  )

virtual

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

roll()

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

virtual

Rotate the OldNode around the Z-axis.

rotate() [1/2]

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

virtual

Rotate the OldNode around an aritrary axis using a Quarternion.

rotate() [2/2]

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

virtual

Rotate the OldNode around an arbitrary axis.

scale() [1/2]

virtual void Ogre::v1::OldNode::scale ( const Vector3 &  scale )

virtual

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

Remarks

This method applies an extra scaling factor to the OldNode'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 OldNode's origin.

scale() [2/2]

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

virtual

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

Remarks

This method applies an extra scaling factor to the OldNode'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 OldNode's origin.

setInheritOrientation()

virtual void Ogre::v1::OldNode::setInheritOrientation ( bool  inherit )

virtual

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

Remarks

Orientations, unlike other transforms, are not always inherited by child OldNodes. Whether or not orientations affect the orientation of the child OldNodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode 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 OldNode's orientation will be affected by its parent's orientation. If false, it will not be affected.

setInheritScale()

virtual void Ogre::v1::OldNode::setInheritScale ( bool  inherit )

virtual

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

Remarks

Scaling factors, unlike other transforms, are not always inherited by child OldNodes. Whether or not scalings affect the size of the child OldNodes depends on the setInheritScale option of the child. In some cases you want a scaling factor of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode 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 OldNode's scale will be affected by its parent's scale. If false, it will not be affected.

setInitialState()

virtual void Ogre::v1::OldNode::setInitialState ( void  )

virtual

Sets the current transform of this OldNode 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 OldNode. If you do plan to animate it, call this method once you've loaded the OldNode with it's base state, ie the state on which all keyframes are based.

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

setListener()

virtual void Ogre::v1::OldNode::setListener ( Listener *  listener )

inlinevirtual

Sets a listener for this OldNode.

Remarks

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

setOrientation() [1/2]

virtual void Ogre::v1::OldNode::setOrientation ( const Quaternion &  q )

virtual

Sets the orientation of this OldNode via a quaternion.

Remarks

Orientations, unlike other transforms, are not always inherited by child OldNodes. Whether or not orientations affect the orientation of the child OldNodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode 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 OldNode's origin.

setOrientation() [2/2]

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

virtual

Sets the orientation of this OldNode via quaternion parameters.

Remarks

Orientations, unlike other transforms, are not always inherited by child OldNodes. Whether or not orientations affect the orientation of the child OldNodes depends on the setInheritOrientation option of the child. In some cases you want a orientating of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode 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 OldNode's origin.

setPosition() [1/2]

virtual void Ogre::v1::OldNode::setPosition ( const Vector3 &  pos )

virtual

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

setPosition() [2/2]

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

virtual

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

setScale() [1/2]

virtual void Ogre::v1::OldNode::setScale ( const Vector3 &  scale )

virtual

Sets the scaling factor applied to this OldNode.

Remarks

Scaling factors, unlike other transforms, are not always inherited by child OldNodes. Whether or not scalings affect the size of the child OldNodes depends on the setInheritScale option of the child. In some cases you want a scaling factor of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode 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 OldNode's origin.

setScale() [2/2]

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

virtual

Sets the scaling factor applied to this OldNode.

Remarks

Scaling factors, unlike other transforms, are not always inherited by child OldNodes. Whether or not scalings affect the size of the child OldNodes depends on the setInheritScale option of the child. In some cases you want a scaling factor of a parent OldNode to apply to a child OldNode (e.g. where the child OldNode 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 OldNode 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 OldNode's origin.

setUserAny()

virtual void Ogre::v1::OldNode::setUserAny ( const Any &  anything )

inlinevirtual

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 OldNode. This can be a pointer back to one of your own classes for instance.

translate() [1/4]

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

virtual

Moves the OldNode along arbitrary axes.

Remarks

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

Parameters

axes	A 3x3 Matrix containing 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as: 1 0 0 0 1 0 0 0 1 i.e. the identity matrix.
move	Vector relative to the axes above.
relativeTo	The space which this transform is relative to.

translate() [2/4]

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

virtual

Moves the OldNode along arbitrary axes.

Remarks

This method translates the OldNode 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.

translate() [3/4]

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

virtual

Moves the OldNode along the Cartesian axes.

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

Parameters

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

translate() [4/4]

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

virtual

Moves the OldNode along the Cartesian axes.

This method moves the OldNode 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.

yaw()

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

virtual

Rotate the OldNode around the Y-axis.

---

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

• OgreOldNode.h