Ogre::Node Class Reference

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

#include <OgreNode.h>

Inheritance diagram for Ogre::Node:

List of all members.


Public Types
typedef HashMap< String, Node * >	ChildNodeMap
typedef MapIterator< ChildNodeMap >	ChildNodeIterator
typedef ConstMapIterator< ChildNodeMap >	ConstChildNodeIterator
enum	TransformSpace { TS_LOCAL, TS_PARENT, TS_WORLD }
	Enumeration denoting the spaces which a transform can be relative to. More...
Public Member Functions
	Node ()
	Constructor, should only be called by parent, not directly.
	Node (const String &name)
	Constructor, should only be called by parent, not directly.
virtual	~Node ()
const String &	getName (void) const
	Returns the name of the node.
virtual Node *	getParent (void) const
	Gets this node's parent (NULL if this is the root).
virtual const Quaternion &	getOrientation () const
	Returns a quaternion representing the nodes orientation.
virtual void	setOrientation (const Quaternion &q)
	Sets the orientation of this node via a quaternion.
virtual void	setOrientation (Real w, Real x, Real y, Real z)
	Sets the orientation of this node via quaternion parameters.
virtual void	resetOrientation (void)
	Resets the nodes orientation (local axes as world axes, no rotation).
virtual void	setPosition (const Vector3 &pos)
	Sets the position of the node relative to it's parent.
virtual void	setPosition (Real x, Real y, Real z)
	Sets the position of the node relative to it's parent.
virtual const Vector3 &	getPosition (void) const
	Gets the position of the node relative to it's parent.
virtual void	setScale (const Vector3 &scale)
	Sets the scaling factor applied to this node.
virtual void	setScale (Real x, Real y, Real z)
	Sets the scaling factor applied to this node.
virtual const Vector3 &	getScale (void) const
	Gets the scaling factor of this node.
virtual void	setInheritScale (bool inherit)
	Tells the node whether it should inherit scaling factors from it's parent node.
virtual bool	getInheritScale (void) const
	Returns true if this node is affected by scaling factors applied to the parent node.
virtual void	scale (const Vector3 &scale)
	Scales the node, combining it's current scale with the passed in scaling factor.
virtual void	scale (Real x, Real y, Real z)
	Scales the node, combining it's current scale with the passed in scaling factor.
virtual void	translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT)
	Moves the node along the cartesian axes.
virtual void	translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
	Moves the node along the cartesian axes.
virtual void	translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT)
	Moves the node along arbitrary axes.
virtual void	translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
	Moves the node along arbitrary axes.
virtual void	roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the node around the Z-axis.
virtual void	pitch (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the node around the X-axis.
virtual void	yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the node around the Y-axis.
virtual void	rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
	Rotate the node around an arbitrary axis.
virtual void	rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL)
	Rotate the node around an aritrary axis using a Quarternion.
virtual Matrix3	getLocalAxes (void) const
	Gets a matrix whose columns are the local axes based on the nodes orientation relative to it's parent.
virtual Node *	createChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
	Creates an unnamed new Node as a child of this node.
virtual Node *	createChild (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
	Creates a new named Node as a child of this node.
virtual void	addChild (Node *child)
	Adds a (precreated) child scene node to this node.
virtual unsigned short	numChildren (void) const
	Reports the number of child nodes under this one.
virtual Node *	getChild (unsigned short index) const
	Gets a pointer to a child node.
virtual Node *	getChild (const String &name) const
	Gets a pointer to a named child node.
virtual ChildNodeIterator	getChildIterator (void)
	Retrieves an iterator for efficiently looping through all children of this node.
virtual ConstChildNodeIterator	getChildIterator (void) const
	Retrieves an iterator for efficiently looping through all children of this node.
virtual Node *	removeChild (unsigned short index)
	Drops the specified child from this node.
virtual Node *	removeChild (Node *child)
	Drops the specified child from this node.
virtual Node *	removeChild (const String &name)
	Drops the named child from this node.
virtual void	removeAllChildren (void)
	Removes all child Nodes attached to this node.
virtual const Quaternion &	_getDerivedOrientation (void) const
	Gets the orientation of the node as derived from all parents.
virtual const Vector3 &	_getDerivedPosition (void) const
	Gets the position of the node as derived from all parents.
virtual const Vector3 &	_getDerivedScale (void) const
	Gets the scaling factor of the node as derived from all parents.
virtual Matrix4	_getFullTransform (void) const
	Gets the full transformation matrix for this node.
virtual void	_update (bool updateChildren, bool parentHasChanged)
	Internal method to update the Node.
const MaterialPtr &	getMaterial (void) const
	Overridden from Renderable.
void	getRenderOperation (RenderOperation &op)
	Overridden from Renderable.
void	getWorldTransforms (Matrix4 *xform) const
	Overridden from Renderable.
const Quaternion &	getWorldOrientation (void) const

const Vector3 &	getWorldPosition (void) const

virtual void	setInitialState (void)
	Sets the current transform of this node to be the 'initial state' ie that position / orientation / scale to be used as a basis for delta values used in keyframe animation.
virtual void	resetToInitialState (void)
	Resets the position / orientation / scale of this node to it's initial state, see setInitialState for more info.
virtual const Vector3 &	getInitialPosition (void) const
	Gets the initial position of this node, see setInitialState for more info.
virtual const Quaternion &	getInitialOrientation (void) const
	Gets the initial orientation of this node, see setInitialState for more info.
virtual const Vector3 &	getInitialScale (void) const
	Gets the initial position of this node, see setInitialState for more info.
virtual void	_weightedTransform (Real weight, const Vector3 &translate, const Quaternion &rotate, const Vector3 &scale)
	Internal weighted transform method.
Real	getSquaredViewDepth (const Camera *cam) const
	Overridden, see Renderable.
virtual void	needUpdate ()
	To be called in the event of transform changes to this node that require it's recalculation.
virtual void	requestUpdate (Node *child)
	Called by children to notify their parent that they need an update.
virtual void	cancelUpdate (Node *child)
	Called by children to notify their parent that they no longer need an update.
const LightList &	getLights (void) const
	Remarks: Directional lights, which have no position, will always be first on this list.
virtual Technique *	getTechnique (void) const
	Retrieves a pointer to the Material Technique this renderable object uses.
virtual unsigned short	getNumWorldTransforms (void) const
	Returns the number of world transform matrices this renderable requires.
virtual bool	useIdentityProjection (void) const
	Returns whether or not to use an 'identity' projection.
virtual bool	useIdentityView (void) const
	Returns whether or not to use an 'identity' projection.
virtual SceneDetailLevel	getRenderDetail () const
	Returns the preferred rasterisation mode of this renderable.
virtual bool	getNormaliseNormals (void) const
	Returns whether or not this Renderable wishes the hardware to normalise normals.
virtual const PlaneList &	getClipPlanes () const
virtual bool	getCastsShadows (void) const
	Method which reports whether this renderable would normally cast a shadow.
void	setCustomParameter (size_t index, const Vector4 &value)
	Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index.
virtual void	_updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
	Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
virtual void	setRenderDetailOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual bool	getRenderDetailOverrideable (void) const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Protected Types
typedef std::set< Node * >	ChildUpdateSet
typedef std::map< size_t, Vector4 >	CustomParameterMap
Protected Member Functions
virtual void	setParent (Node *parent)
	Only available internally - notification of parent.
virtual void	_updateFromParent (void) const
	Triggers the node to update it's combined transforms.
virtual Node *	createChildImpl (void)=0
	Internal method for creating a new child node - must be overridden per subclass.
virtual Node *	createChildImpl (const String &name)=0
	Internal method for creating a new child node - must be overridden per subclass.
void	makeTransform (const Vector3 &position, const Vector3 &scale, const Quaternion &orientation, Matrix4 &destMatrix) const
	Internal method for building a Matrix4 from orientation / scale / position.
void	makeInverseTransform (const Vector3 &position, const Vector3 &scale, const Quaternion &orientation, Matrix4 &destMatrix)
	Internal method for building an inverse Matrix4 from orientation / scale / position.
Protected Attributes
Node *	mParent
	Pointer to parent node.
ChildNodeMap	mChildren
	Collection of pointers to direct children; hashmap for efficiency.
ChildUpdateSet	mChildrenToUpdate
	List of children which need updating, used if self is not out of date but children are.
bool	mNeedParentUpdate
	Flag to indicate own transform from parent is out of date.
bool	mNeedChildUpdate
	Flag indicating that all children need to be updated.
bool	mParentNotified
	Flag indicating that parent has been notified about update request.
String	mName
	Friendly name of this node, can be automatically generated if you don't care.
Quaternion	mOrientation
	Stores the orientation of the node relative to it's parent.
Vector3	mPosition
	Stores the position/translation of the node relative to its parent.
Vector3	mScale
	Stores the scaling factor applied to this node.
bool	mInheritScale
	Stores whether this node inherits scale from it's parent.
MaterialPtr	mpMaterial
	Material pointer should this node be rendered.
Quaternion	mDerivedOrientation
	Cached combined orientation.
Vector3	mDerivedPosition
	Cached combined position.
Vector3	mDerivedScale
	Cached combined scale.
Vector3	mInitialPosition
	The position to use as a base for keyframe animation.
Quaternion	mInitialOrientation
	The orientation to use as a base for keyframe animation.
Vector3	mInitialScale
	The scale to use as a base for keyframe animation.
Real	mAccumAnimWeight
Vector3	mTransFromInitial
Quaternion	mRotFromInitial
Vector3	mScaleFromInitial
Matrix4	mCachedTransform
	Cached derived transform as a 4x4 matrix.
bool	mCachedTransformOutOfDate
CustomParameterMap	mCustomParameters
bool	mRenderDetailOverrideable
Static Protected Attributes
unsigned long	msNextGeneratedNameExt
	Incremented count for next name extension.
const PlaneList	msDummyPlaneList

Detailed Description

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

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

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

Definition at line 50 of file OgreNode.h.

Member Typedef Documentation

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

Definition at line 65 of file OgreNode.h.

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

Definition at line 64 of file OgreNode.h.

typedef std::set<Node*> Ogre::Node::ChildUpdateSet [protected]

Definition at line 74 of file OgreNode.h.

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

Definition at line 66 of file OgreNode.h.

typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap [protected, inherited]

Definition at line 251 of file OgreRenderable.h.

Member Enumeration Documentation

enum Ogre::Node::TransformSpace

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

Enumeration values:

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

Constructor & Destructor Documentation

Ogre::Node::Node ( )

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

Remarks:
Generates a name.

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

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

Remarks:
Assigned a name.

virtual Ogre::Node::~Node ( ) [virtual]

Member Function Documentation

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

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

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

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

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

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

virtual Matrix4 Ogre::Node::_getFullTransform ( void ) const [virtual]

Gets the full transformation matrix for this node.

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

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

bool parentHasChanged

) [virtual]

Internal method to update the Node.

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

Parameters:

updateChildren If true, the update cascades down to all children. Specify false if you wish to update children separately, e.g. because of a more selective SceneManager implementation.

parentHasChanged This flag indicates that the parent xform has changed, so the child should retrieve the parent's xform and combine it with its own even if it hasn't changed itself.

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

virtual void Ogre::Renderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry & constantEntry,

GpuProgramParameters * params

) const [virtual, inherited]

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks:
This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.

You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.

Parameters:

constantEntry The auto constant entry referring to the parameter being updated

params The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::TerrainRenderable.
Definition at line 219 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::index, and params.

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

Triggers the node to update it's combined transforms.

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

Reimplemented in Ogre::TagPoint.

virtual void Ogre::Node::_weightedTransform ( Real weight,

const Vector3 & translate,

const Quaternion & rotate,

const Vector3 & scale

) [virtual]

Internal weighted transform method.

Remarks:
This method transforms a Node by a weighted amount from it's initial state. If weighted transforms have already been applied, the previous transforms and this one are blended together based on their relative weight. This method should not be used in combination with the unweighted rotate, translate etc methods.

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

Adds a (precreated) child scene node to this node.
If it is attached to another node, it must be detached first.
Parameters:

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

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

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

virtual Node* Ogre::Node::createChild ( const String & name,

const Vector3 & translate = Vector3::ZERO,

const Quaternion & rotate = Quaternion::IDENTITY

) [virtual]

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

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

Parameters:

translate Initial translation offset of child relative to parent

rotate Initial rotation relative to parent

virtual Node* Ogre::Node::createChild ( const Vector3 & translate = Vector3::ZERO,

const Quaternion & rotate = Quaternion::IDENTITY

) [virtual]

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

Parameters:

translate Initial translation offset of child relative to parent

rotate Initial rotation relative to parent

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

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

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

virtual Node* Ogre::Node::createChildImpl ( void ) [protected, pure virtual]

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

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

virtual bool Ogre::Renderable::getCastsShadows ( void ) const [virtual, inherited]

Method which reports whether this renderable would normally cast a shadow.

Remarks:
Subclasses should override this if they could have been used to generate a shadow.

Reimplemented in Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 154 of file OgreRenderable.h.

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

Gets a pointer to a named child node.

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

Gets a pointer to a child node.

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

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

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

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

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

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

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

virtual const PlaneList& Ogre::Renderable::getClipPlanes ( ) const [virtual, inherited]

Definition at line 146 of file OgreRenderable.h.
References Ogre::PlaneList.

const Vector4& Ogre::Renderable::getCustomParameter ( size_t index ) const [inherited]

Gets the custom value associated with this Renderable at the given index.

Parameters:

@see setCustomParaemter for full details.

Definition at line 180 of file OgreRenderable.h.
References OGRE_EXCEPT.

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

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

Remarks:
See setInheritScale for more info.

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

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

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

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

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

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

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

const LightList& Ogre::Node::getLights ( void ) const [virtual]

Remarks:
Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.
Reimplemented in Ogre::TagPoint.

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

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

const MaterialPtr& Ogre::Node::getMaterial ( void ) const [virtual]

Overridden from Renderable.

Remarks:
This is only used if the SceneManager chooses to render the node. This option can be set for SceneNodes at SceneManager::setDisplaySceneNodes, and for entities based on skeletal models using Entity::setDisplayBones()

Implements Ogre::Renderable.

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

Returns the name of the node.

virtual bool Ogre::Renderable::getNormaliseNormals ( void ) const [virtual, inherited]

Returns whether or not this Renderable wishes the hardware to normalise normals.

Reimplemented in Ogre::SubEntity.
Definition at line 138 of file OgreRenderable.h.

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void ) const [virtual, inherited]

Returns the number of world transform matrices this renderable requires.

Remarks:
When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::BorderRenderable, and Ogre::SubEntity.
Definition at line 104 of file OgreRenderable.h.

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

Returns a quaternion representing the nodes orientation.

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

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

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

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

virtual SceneDetailLevel Ogre::Renderable::getRenderDetail ( ) const [virtual, inherited]

Returns the preferred rasterisation mode of this renderable.

Reimplemented in Ogre::SubEntity.
Definition at line 135 of file OgreRenderable.h.
References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID.

virtual bool Ogre::Renderable::getRenderDetailOverrideable ( void ) const [virtual, inherited]

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Reimplemented in Ogre::BorderRenderable.
Definition at line 243 of file OgreRenderable.h.

void Ogre::Node::getRenderOperation ( RenderOperation & op ) [virtual]

Overridden from Renderable.

Remarks:
This is only used if the SceneManager chooses to render the node. This option can be set for SceneNodes at SceneManager::setDisplaySceneNodes, and for entities based on skeletal models using Entity::setDisplaySkeleton()

Implements Ogre::Renderable.
Reimplemented in Ogre::OctreeNode.

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

Gets the scaling factor of this node.

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

Overridden, see Renderable.

Implements Ogre::Renderable.

virtual Technique* Ogre::Renderable::getTechnique ( void ) const [virtual, inherited]

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks:
This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 69 of file OgreRenderable.h.

const Quaternion& Ogre::Node::getWorldOrientation ( void ) const [virtual]

Implements Ogre::Renderable.

const Vector3& Ogre::Node::getWorldPosition ( void ) const [virtual]

Implements Ogre::Renderable.

void Ogre::Node::getWorldTransforms ( Matrix4 * xform ) const [virtual]

Overridden from Renderable.

Remarks:
This is only used if the SceneManager chooses to render the node. This option can be set for SceneNodes at SceneManager::setDisplaySceneNodes, and for entities based on skeletal models using Entity::setDisplaySkeleton()

Implements Ogre::Renderable.

void Ogre::Node::makeInverseTransform ( const Vector3 & position,

const Vector3 & scale,

const Quaternion & orientation,

Matrix4 & destMatrix

) [protected]

Internal method for building an inverse Matrix4 from orientation / scale / position.

Remarks:
As makeTransform except it build the inverse given the same data as makeTransform, so performing -translation, 1/scale, -rotate in that order.

void Ogre::Node::makeTransform ( const Vector3 & position,

const Vector3 & scale,

const Quaternion & orientation,

Matrix4 & destMatrix

) const [protected]

Internal method for building a Matrix4 from orientation / scale / position.

Remarks:
Transform is performed in the order rotate, scale, translation, i.e. translation is independent of orientation axes, scale does not affect size of translation, rotation and scaling are always centered on the origin.

virtual void Ogre::Node::needUpdate ( ) [virtual]

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

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

Reimplemented in Ogre::TagPoint.

virtual unsigned short Ogre::Node::numChildren ( void ) const [virtual]

Reports the number of child nodes under this one.

virtual void Ogre::Node::pitch ( const Radian & angle,

TransformSpace relativeTo = TS_LOCAL

) [virtual]

Rotate the node around the X-axis.

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

Removes all child Nodes attached to this node.
Does not delete the nodes, just detaches them from this parent, potentially to be reattached elsewhere.

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

Drops the named child from this node.

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

Reimplemented in Ogre::OctreeNode.

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

Drops the specified child from this node.

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

Reimplemented in Ogre::OctreeNode.

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

Drops the specified child from this node.

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

Reimplemented in Ogre::OctreeNode.

virtual void Ogre::Node::requestUpdate ( Node * child ) [virtual]

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

virtual void Ogre::Node::resetOrientation ( void ) [virtual]

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

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

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

virtual void Ogre::Node::roll ( const Radian & angle,

TransformSpace relativeTo = TS_LOCAL

) [virtual]

Rotate the node around the Z-axis.

virtual void Ogre::Node::rotate ( const Quaternion & q,

TransformSpace relativeTo = TS_LOCAL

) [virtual]

Rotate the node around an aritrary axis using a Quarternion.

virtual void Ogre::Node::rotate ( const Vector3 & axis,

const Radian & angle,

TransformSpace relativeTo = TS_LOCAL

) [virtual]

Rotate the node around an arbitrary axis.

virtual void Ogre::Node::scale ( Real x,

Real y,

Real z

) [virtual]

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

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

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

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

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

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

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

void Ogre::Renderable::setCustomParameter ( size_t index,

const Vector4 & value

) [inherited]

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks:
Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.

Parameters:

index The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.

value The value to associate.

Definition at line 171 of file OgreRenderable.h.

virtual void Ogre::Node::setInheritScale ( bool inherit ) [virtual]

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

Remarks:
Scaling factors, unlike other transforms, are not always inherited by child nodes. Whether or not scalings affect both the size and position 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 and position 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 and relative position). The default is to inherit as with other transforms.

Parameters:

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

virtual void Ogre::Node::setInitialState ( void ) [virtual]

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

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

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

virtual void Ogre::Node::setOrientation ( Real w,

Real x,

Real y,

Real z

) [virtual]

Sets the orientation of this node via quaternion parameters.

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

Sets the orientation of this node via a quaternion.

virtual void Ogre::Node::setParent ( Node * parent ) [protected, virtual]

Only available internally - notification of parent.

Reimplemented in Ogre::SceneNode.

virtual void Ogre::Node::setPosition ( Real x,

Real y,

Real z

) [virtual]

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

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

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

virtual void Ogre::Renderable::setRenderDetailOverrideable ( bool override ) [virtual, inherited]

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Parameters:

override true means that a lower camera detail will override this renderables detail level, false means it won't.

Definition at line 235 of file OgreRenderable.h.

virtual void Ogre::Node::setScale ( Real x,

Real y,

Real z

) [virtual]

Sets the scaling factor applied to this node.

Remarks:
Scaling factors, unlike other transforms, are not always inherited by child nodes. Whether or not scalings affect both the size and position 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 and position 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 and relative position). The default is to inherit as with other transforms.

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

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

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 both the size and position 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 and position 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 and relative position). 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::translate ( const Matrix3 & axes,

Real x,

Real y,

Real z,

TransformSpace relativeTo = TS_PARENT

) [virtual]

Moves the node along arbitrary axes.

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

Parameters:

axes A 3x3 Matrix containg 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as
1 0 0 0 1 0 0 0 1
i.e. the identity matrix.

x,y,z Translation components relative to the axes above.

relativeTo The space which this transform is relative to.

virtual void Ogre::Node::translate ( const Matrix3 & axes,

const Vector3 & move,

TransformSpace relativeTo = TS_PARENT

) [virtual]

Moves the node along arbitrary axes.

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

Parameters:

axes A 3x3 Matrix containg 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as:
1 0 0 0 1 0 0 0 1
i.e. the identity matrix.

move Vector relative to the axes above.

relativeTo The space which this transform is relative to.

virtual void Ogre::Node::translate ( Real x,

Real y,

Real z,

TransformSpace relativeTo = TS_PARENT

) [virtual]

Moves the node along the cartesian axes.

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

Parameters:

x

y

z Real x, y and z values representing the translation.

relativeTo The space which this transform is relative to.

virtual void Ogre::Node::translate ( const Vector3 & d,

TransformSpace relativeTo = TS_PARENT

) [virtual]

Moves the node along the cartesian axes.

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

Parameters:

d Vector with x,y,z values representing the translation.

relativeTo The space which this transform is relative to.

virtual bool Ogre::Renderable::useIdentityProjection ( void ) const [virtual, inherited]

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented in Ogre::BorderRenderable, Ogre::OverlayElement, and Ogre::Rectangle2D.
Definition at line 114 of file OgreRenderable.h.

virtual bool Ogre::Renderable::useIdentityView ( void ) const [virtual, inherited]

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented in Ogre::BorderRenderable, Ogre::OverlayElement, and Ogre::Rectangle2D.
Definition at line 124 of file OgreRenderable.h.

virtual void Ogre::Node::yaw ( const Radian & angle,

TransformSpace relativeTo = TS_LOCAL

) [virtual]

Rotate the node around the Y-axis.

Reimplemented in Ogre::SceneNode.

Member Data Documentation

Real Ogre::Node::mAccumAnimWeight [protected]

Definition at line 180 of file OgreNode.h.

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

Cached derived transform as a 4x4 matrix.

Definition at line 189 of file OgreNode.h.

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

Definition at line 190 of file OgreNode.h.

ChildNodeMap Ogre::Node::mChildren [protected]

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 72 of file OgreNode.h.

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

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

Definition at line 76 of file OgreNode.h.

CustomParameterMap Ogre::Renderable::mCustomParameters [protected, inherited]

Definition at line 252 of file OgreRenderable.h.

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

Cached combined orientation.

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

Definition at line 115 of file OgreNode.h.

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

Cached combined position.

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

Definition at line 124 of file OgreNode.h.

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

Cached combined scale.

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

Definition at line 133 of file OgreNode.h.

bool Ogre::Node::mInheritScale [protected]

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

Definition at line 100 of file OgreNode.h.

Quaternion Ogre::Node::mInitialOrientation [protected]

The orientation to use as a base for keyframe animation.

Definition at line 175 of file OgreNode.h.

Vector3 Ogre::Node::mInitialPosition [protected]

The position to use as a base for keyframe animation.

Definition at line 173 of file OgreNode.h.

Vector3 Ogre::Node::mInitialScale [protected]

The scale to use as a base for keyframe animation.

Definition at line 177 of file OgreNode.h.

String Ogre::Node::mName [protected]

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

Definition at line 85 of file OgreNode.h.

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

Flag indicating that all children need to be updated.

Definition at line 80 of file OgreNode.h.

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

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

Definition at line 78 of file OgreNode.h.

Quaternion Ogre::Node::mOrientation [protected]

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

Definition at line 91 of file OgreNode.h.

Node* Ogre::Node::mParent [protected]

Pointer to parent node.

Definition at line 70 of file OgreNode.h.

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

Flag indicating that parent has been notified about update request.

Definition at line 82 of file OgreNode.h.

MaterialPtr Ogre::Node::mpMaterial [mutable, protected]

Material pointer should this node be rendered.

Definition at line 103 of file OgreNode.h.

Vector3 Ogre::Node::mPosition [protected]

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

Definition at line 94 of file OgreNode.h.

bool Ogre::Renderable::mRenderDetailOverrideable [protected, inherited]

Definition at line 253 of file OgreRenderable.h.

Quaternion Ogre::Node::mRotFromInitial [protected]

Definition at line 184 of file OgreNode.h.

Vector3 Ogre::Node::mScale [protected]

Stores the scaling factor applied to this node.

Definition at line 97 of file OgreNode.h.

Vector3 Ogre::Node::mScaleFromInitial [protected]

Definition at line 186 of file OgreNode.h.

const PlaneList Ogre::Renderable::msDummyPlaneList [static, protected, inherited]

Definition at line 250 of file OgreRenderable.h.

unsigned long Ogre::Node::msNextGeneratedNameExt [static, protected]

Incremented count for next name extension.

Definition at line 88 of file OgreNode.h.

Vector3 Ogre::Node::mTransFromInitial [protected]

Definition at line 182 of file OgreNode.h.

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

OgreNode.h

Ogre::Node Class Reference

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes