OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::OldNode Class Referenceabstract

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

#include <OgreOldNode.h>

+ Inheritance diagram for Ogre::OldNode:
+ Collaboration diagram for Ogre::OldNode:

Classes

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

Public Types

typedef MapIterator
< ChildOldNodeMap
ChildOldNodeIterator
 
typedef HashMap< String,
OldNode * > 
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. More...
 
 OldNode (const String &name)
 Constructor, should only be called by parent, not directly. More...
 
virtual ~OldNode ()
 
virtual const Quaternion_getDerivedOrientation (void) const
 Gets the orientation of the OldNode as derived from all parents. More...
 
virtual const Vector3_getDerivedPosition (void) const
 Gets the position of the OldNode as derived from all parents. More...
 
virtual const Vector3_getDerivedScale (void) const
 Gets the scaling factor of the OldNode as derived from all parents. More...
 
virtual const Matrix4_getFullTransform (void) const
 Gets the full transformation matrix for this OldNode. More...
 
virtual void _setDerivedOrientation (const Quaternion &q)
 Sets the final world orientation of the OldNode directly. More...
 
virtual void _setDerivedPosition (const Vector3 &pos)
 Sets the final world position of the OldNode directly. More...
 
virtual void _update (bool updateChildren, bool parentHasChanged)
 Internal method to update the OldNode. More...
 
virtual void addChild (OldNode *child)
 Adds a (precreated) child scene OldNode to this OldNode. More...
 
virtual void cancelUpdate (OldNode *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 OldNode local space useful for simple transforms that don't require a child OldNode. More...
 
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. More...
 
virtual Quaternion convertWorldToLocalOrientation (const Quaternion &worldOrientation)
 Gets the local orientation, relative to this OldNode, of the given world-space orientation. More...
 
virtual Vector3 convertWorldToLocalPosition (const Vector3 &worldPos)
 Gets the local position, relative to this OldNode, of the given world-space position. More...
 
virtual OldNodecreateChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates an unnamed new OldNode as a child of this OldNode. More...
 
virtual OldNodecreateChild (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates a new named OldNode as a child of this OldNode. More...
 
virtual OldNodegetChild (unsigned short index) const
 Gets a pointer to a child OldNode. More...
 
virtual OldNodegetChild (const String &name) const
 Gets a pointer to a named child OldNode. More...
 
virtual ChildOldNodeIterator getChildIterator (void)
 Retrieves an iterator for efficiently looping through all children of this OldNode. More...
 
virtual ConstChildOldNodeIterator getChildIterator (void) const
 Retrieves an iterator for efficiently looping through all children of this OldNode. More...
 
virtual DebugRenderablegetDebugRenderable (Real scaling)
 Get a debug renderable for rendering the OldNode. More...
 
virtual bool getInheritOrientation (void) const
 Returns true if this OldNode is affected by orientation applied to the parent OldNode. More...
 
virtual bool getInheritScale (void) const
 Returns true if this OldNode is affected by scaling factors applied to the parent OldNode. More...
 
virtual const QuaterniongetInitialOrientation (void) const
 Gets the initial orientation of this OldNode, see setInitialState for more info. More...
 
virtual const Vector3getInitialPosition (void) const
 Gets the initial position of this OldNode, see setInitialState for more info. More...
 
virtual const Vector3getInitialScale (void) const
 Gets the initial position of this OldNode, see setInitialState for more info. More...
 
virtual ListenergetListener (void) const
 Gets the current listener for this OldNode. More...
 
virtual Matrix3 getLocalAxes (void) const
 Gets a matrix whose columns are the local axes based on the OldNodes orientation relative to it's parent. More...
 
const StringgetName (void) const
 Returns the name of the OldNode. More...
 
virtual const QuaterniongetOrientation () const
 Returns a quaternion representing the OldNodes orientation. More...
 
virtual OldNodegetParent (void) const
 Gets this OldNode's parent (NULL if this is the root). More...
 
virtual const Vector3getPosition (void) const
 Gets the position of the OldNode relative to it's parent. More...
 
virtual const Vector3getScale (void) const
 Gets the scaling factor of this OldNode. More...
 
virtual Real getSquaredViewDepth (const Camera *cam) const
 Helper function, get the squared view depth. More...
 
virtual const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
virtual void needUpdate (bool forceParentUpdate=false)
 To be called in the event of transform changes to this OldNode that require it's recalculation. More...
 
virtual unsigned short numChildren (void) const
 Reports the number of child OldNodes 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 OldNode around the X-axis. More...
 
virtual void removeAllChildren (void)
 Removes all child OldNodes attached to this OldNode. More...
 
virtual OldNoderemoveChild (unsigned short index)
 Drops the specified child from this OldNode. More...
 
virtual OldNoderemoveChild (OldNode *child)
 Drops the specified child from this OldNode. More...
 
virtual OldNoderemoveChild (const String &name)
 Drops the named child from this OldNode. More...
 
virtual void requestUpdate (OldNode *child, bool forceParentUpdate=false)
 Called by children to notify their parent that they need an update. More...
 
virtual void resetOrientation (void)
 Resets the OldNodes orientation (local axes as world axes, no rotation). More...
 
virtual void resetToInitialState (void)
 Resets the position / orientation / scale of this OldNode to it's initial state, see setInitialState for more info. More...
 
virtual void roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
 Rotate the OldNode around the Z-axis. More...
 
virtual void rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
 Rotate the OldNode around an arbitrary axis. More...
 
virtual void rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL)
 Rotate the OldNode around an aritrary axis using a Quarternion. More...
 
virtual void scale (const Vector3 &scale)
 Scales the OldNode, combining it's current scale with the passed in scaling factor. More...
 
virtual void scale (Real x, Real y, Real z)
 Scales the OldNode, combining it's current scale with the passed in scaling factor. More...
 
virtual void setInheritOrientation (bool inherit)
 Tells the OldNode whether it should inherit orientation from it's parent OldNode. More...
 
virtual void setInheritScale (bool inherit)
 Tells the OldNode whether it should inherit scaling factors from it's parent OldNode. More...
 
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. More...
 
virtual void setListener (Listener *listener)
 Sets a listener for this OldNode. More...
 
virtual void setOrientation (const Quaternion &q)
 Sets the orientation of this OldNode via a quaternion. More...
 
virtual void setOrientation (Real w, Real x, Real y, Real z)
 Sets the orientation of this OldNode via quaternion parameters. More...
 
virtual void setPosition (const Vector3 &pos)
 Sets the position of the OldNode relative to it's parent. More...
 
virtual void setPosition (Real x, Real y, Real z)
 Sets the position of the OldNode relative to it's parent. More...
 
virtual void setScale (const Vector3 &scale)
 Sets the scaling factor applied to this OldNode. More...
 
virtual void setScale (Real x, Real y, Real z)
 Sets the scaling factor applied to this OldNode. More...
 
virtual void setUserAny (const Any &anything)
 
virtual void translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT)
 Moves the OldNode along the Cartesian axes. More...
 
virtual void translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
 Moves the OldNode along the Cartesian axes. More...
 
virtual void translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT)
 Moves the OldNode along arbitrary axes. More...
 
virtual void translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
 Moves the OldNode along arbitrary axes. More...
 
virtual void yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
 Rotate the OldNode around the Y-axis. More...
 

Static Public Member Functions

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

Protected Types

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

Protected Member Functions

virtual void _updateFromParent (void) const
 Triggers the OldNode to update it's combined transforms. More...
 
virtual OldNodecreateChildImpl (void)=0
 Internal method for creating a new child OldNode - must be overridden per subclass. More...
 
virtual OldNodecreateChildImpl (const String &name)=0
 Internal method for creating a new child OldNode - must be overridden per subclass. More...
 
virtual void setParent (OldNode *parent)
 Only available internally - notification of parent. More...
 
virtual void updateFromParentImpl (void) const
 Class-specific implementation of _updateFromParent. More...
 

Protected Attributes

Matrix4 mCachedTransform
 Cached derived transform as a 4x4 matrix. More...
 
bool mCachedTransformOutOfDate
 
ChildOldNodeMap 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...
 
DebugRenderablemDebug
 
Quaternion mDerivedOrientation
 Cached combined orientation. More...
 
Vector3 mDerivedPosition
 Cached combined position. More...
 
Vector3 mDerivedScale
 Cached combined scale. More...
 
bool mInheritOrientation
 Stores whether this OldNode inherits orientation from it's parent. More...
 
bool mInheritScale
 Stores whether this OldNode 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...
 
ListenermListener
 OldNode listener - only one allowed (no list) for size & performance reasons. More...
 
String mName
 Friendly name of this OldNode, 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 OldNode relative to it's parent. More...
 
OldNodemParent
 Pointer to parent OldNode. More...
 
bool mParentNotified
 Flag indicating that parent has been notified about update request. More...
 
Vector3 mPosition
 Stores the position/translation of the OldNode relative to its parent. More...
 
bool mQueuedForUpdate
 Flag indicating that the OldNode has been queued for update. More...
 
Vector3 mScale
 Stores the scaling factor applied to this OldNode. More...
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 

Static Protected Attributes

static QueuedUpdates msQueuedUpdates
 

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

Definition at line 63 of file OgreOldNode.h.

Member Typedef Documentation

Definition at line 77 of file OgreOldNode.h.

typedef set<OldNode*>::type Ogre::OldNode::ChildUpdateSet
protected

Definition at line 130 of file OgreOldNode.h.

typedef vector<OldNode*>::type Ogre::OldNode::QueuedUpdates
protected

Definition at line 227 of file OgreOldNode.h.

Member Enumeration Documentation

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

Enumerator
TS_LOCAL 

Transform is relative to the local space.

TS_PARENT 

Transform is relative to the space of the parent OldNode.

TS_WORLD 

Transform is relative to world space.

Definition at line 68 of file OgreOldNode.h.

Constructor & Destructor Documentation

Ogre::OldNode::OldNode ( )

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

Remarks
Generates a name.
Ogre::OldNode::OldNode ( const String name)

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

Remarks
Assigned a name.
virtual Ogre::OldNode::~OldNode ( )
virtual

Member Function Documentation

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

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

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

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

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

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

virtual const Matrix4& Ogre::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.
virtual void Ogre::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.
virtual void Ogre::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
virtual void Ogre::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
updateChildrenIf true, the update cascades down to all children. Specify false if you wish to update children separately, e.g. because of a more selective SceneManager implementation.
parentHasChangedThis flag indicates that the parent transform has changed, so the child should retrieve the parent's transform and combine it with its own even if it hasn't changed itself.
virtual void Ogre::OldNode::_updateFromParent ( void  ) const
protectedvirtual

Triggers the OldNode to update it's combined transforms.

This method is called internally by Ogre to ask the OldNode to update it's complete transformation based on it's parents derived transform.
virtual void Ogre::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
childThe OldNode which is to become a child OldNode of this one
virtual void Ogre::OldNode::cancelUpdate ( OldNode child)
virtual

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

virtual Quaternion Ogre::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.

virtual Vector3 Ogre::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.

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

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

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

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

virtual OldNode* Ogre::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
translateInitial translation offset of child relative to parent
rotateInitial rotation relative to parent
virtual OldNode* Ogre::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
translateInitial translation offset of child relative to parent
rotateInitial rotation relative to parent
virtual OldNode* Ogre::OldNode::createChildImpl ( void  )
protectedpure virtual

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

Implemented in Ogre::OldBone.

virtual OldNode* Ogre::OldNode::createChildImpl ( const String name)
protectedpure virtual

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

Implemented in Ogre::OldBone.

virtual OldNode* Ogre::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.
virtual OldNode* Ogre::OldNode::getChild ( const String name) const
virtual

Gets a pointer to a named child OldNode.

virtual ChildOldNodeIterator Ogre::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.
virtual ConstChildOldNodeIterator Ogre::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.
virtual DebugRenderable* Ogre::OldNode::getDebugRenderable ( Real  scaling)
virtual

Get a debug renderable for rendering the OldNode.

virtual bool Ogre::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.
virtual bool Ogre::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.
virtual const Quaternion& Ogre::OldNode::getInitialOrientation ( void  ) const
virtual

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

virtual const Vector3& Ogre::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.
virtual const Vector3& Ogre::OldNode::getInitialScale ( void  ) const
virtual

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

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

Gets the current listener for this OldNode.

Definition at line 666 of file OgreOldNode.h.

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

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

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

Returns the name of the OldNode.

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

Returns a quaternion representing the OldNodes orientation.

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

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

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

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

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

Gets the scaling factor of this OldNode.

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

Helper function, get the squared view depth.

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

Definition at line 756 of file OgreOldNode.h.

UserObjectBindings& Ogre::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.

Definition at line 762 of file OgreOldNode.h.

const UserObjectBindings& Ogre::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.

Definition at line 768 of file OgreOldNode.h.

virtual void Ogre::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
forceParentUpdateEven if the OldNode thinks it has already told it's parent, tell it anyway

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

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

Reports the number of child OldNodes 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::OldNode::pitch ( const Radian angle,
TransformSpace  relativeTo = TS_LOCAL 
)
virtual

Rotate the OldNode around the X-axis.

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

Process queued 'needUpdate' calls.

static void Ogre::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.
virtual void Ogre::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.

virtual OldNode* Ogre::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.
virtual OldNode* Ogre::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.
virtual OldNode* Ogre::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.
virtual void Ogre::OldNode::requestUpdate ( OldNode child,
bool  forceParentUpdate = false 
)
virtual

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

Parameters
forceParentUpdateEven if the OldNode thinks it has already told it's parent, tell it anyway
virtual void Ogre::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.
virtual void Ogre::OldNode::resetToInitialState ( void  )
virtual

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

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

Rotate the OldNode around the Z-axis.

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

Rotate the OldNode around an arbitrary axis.

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

Rotate the OldNode around an aritrary axis using a Quarternion.

virtual void Ogre::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.
virtual void Ogre::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.
virtual void Ogre::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
inheritIf true, this OldNode's orientation will be affected by its parent's orientation. If false, it will not be affected.
virtual void Ogre::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
inheritIf true, this OldNode's scale will be affected by its parent's scale. If false, it will not be affected.
virtual void Ogre::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.
virtual void Ogre::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.

Definition at line 662 of file OgreOldNode.h.

virtual void Ogre::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.
virtual void Ogre::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.
virtual void Ogre::OldNode::setParent ( OldNode parent)
protectedvirtual

Only available internally - notification of parent.

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

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

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

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

virtual void Ogre::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.
virtual void Ogre::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.
virtual void Ogre::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.

Definition at line 751 of file OgreOldNode.h.

virtual void Ogre::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
dVector with x,y,z values representing the translation.
relativeToThe space which this transform is relative to.
virtual void Ogre::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
xReal x value representing the translation.
yReal y value representing the translation.
zReal z value representing the translation.
relativeToThe space which this transform is relative to.
virtual void Ogre::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
axesA 3x3 Matrix containing 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as:
    1 0 0
    0 1 0
    0 0 1
    
i.e. the identity matrix.
moveVector relative to the axes above.
relativeToThe space which this transform is relative to.
virtual void Ogre::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
axesA 3x3 Matrix containing 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as
    1 0 0
    0 1 0
    0 0 1
    
i.e. the identity matrix.
xThe x translation component relative to the axes above.
yThe y translation component relative to the axes above.
zThe z translation component relative to the axes above.
relativeToThe space which this transform is relative to.
virtual void Ogre::OldNode::updateFromParentImpl ( void  ) const
protectedvirtual

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.

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

Rotate the OldNode around the Y-axis.

Member Data Documentation

Matrix4 Ogre::OldNode::mCachedTransform
mutableprotected

Cached derived transform as a 4x4 matrix.

Definition at line 221 of file OgreOldNode.h.

bool Ogre::OldNode::mCachedTransformOutOfDate
mutableprotected

Definition at line 222 of file OgreOldNode.h.

ChildOldNodeMap Ogre::OldNode::mChildren
protected

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 128 of file OgreOldNode.h.

ChildUpdateSet Ogre::OldNode::mChildrenToUpdate
mutableprotected

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

Definition at line 132 of file OgreOldNode.h.

DebugRenderable* Ogre::OldNode::mDebug
protected

Definition at line 230 of file OgreOldNode.h.

Quaternion Ogre::OldNode::mDerivedOrientation
mutableprotected

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

Definition at line 170 of file OgreOldNode.h.

Vector3 Ogre::OldNode::mDerivedPosition
mutableprotected

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

Definition at line 179 of file OgreOldNode.h.

Vector3 Ogre::OldNode::mDerivedScale
mutableprotected

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

Definition at line 188 of file OgreOldNode.h.

bool Ogre::OldNode::mInheritOrientation
protected

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

Definition at line 155 of file OgreOldNode.h.

bool Ogre::OldNode::mInheritScale
protected

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

Definition at line 158 of file OgreOldNode.h.

Quaternion Ogre::OldNode::mInitialOrientation
protected

The orientation to use as a base for keyframe animation.

Definition at line 216 of file OgreOldNode.h.

Vector3 Ogre::OldNode::mInitialPosition
protected

The position to use as a base for keyframe animation.

Definition at line 214 of file OgreOldNode.h.

Vector3 Ogre::OldNode::mInitialScale
protected

The scale to use as a base for keyframe animation.

Definition at line 218 of file OgreOldNode.h.

Listener* Ogre::OldNode::mListener
protected

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

Definition at line 225 of file OgreOldNode.h.

String Ogre::OldNode::mName
protected

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

Definition at line 143 of file OgreOldNode.h.

bool Ogre::OldNode::mNeedChildUpdate
mutableprotected

Flag indicating that all children need to be updated.

Definition at line 136 of file OgreOldNode.h.

bool Ogre::OldNode::mNeedParentUpdate
mutableprotected

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

Definition at line 134 of file OgreOldNode.h.

Quaternion Ogre::OldNode::mOrientation
protected

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

Definition at line 146 of file OgreOldNode.h.

OldNode* Ogre::OldNode::mParent
protected

Pointer to parent OldNode.

Definition at line 126 of file OgreOldNode.h.

bool Ogre::OldNode::mParentNotified
mutableprotected

Flag indicating that parent has been notified about update request.

Definition at line 138 of file OgreOldNode.h.

Vector3 Ogre::OldNode::mPosition
protected

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

Definition at line 149 of file OgreOldNode.h.

bool Ogre::OldNode::mQueuedForUpdate
mutableprotected

Flag indicating that the OldNode has been queued for update.

Definition at line 140 of file OgreOldNode.h.

Vector3 Ogre::OldNode::mScale
protected

Stores the scaling factor applied to this OldNode.

Definition at line 152 of file OgreOldNode.h.

QueuedUpdates Ogre::OldNode::msQueuedUpdates
staticprotected

Definition at line 228 of file OgreOldNode.h.

UserObjectBindings Ogre::OldNode::mUserObjectBindings
protected

User objects binding.

Definition at line 233 of file OgreOldNode.h.


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