Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::Node Class Reference

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

#include <OgreNode.h>

Inheritance diagram for Ogre::Node:

Inheritance graph
[legend]
Collaboration diagram for Ogre::Node:

Collaboration graph
[legend]
List of all members.

Public Types

typedef HashMap< String, Node *,
_StringHash
ChildNodeMap
typedef MapIterator< ChildNodeMapChildNodeIterator

Public Methods

 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 StringgetName (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 QuaterniongetOrientation () 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 Vector3getPosition (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 Vector3getScale (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)
 Moves the node along the cartesian axes.

virtual void translate (Real x, Real y, Real z)
 Moves the node along the cartesian axes.

virtual void translate (const Matrix3 &axes, const Vector3 &move)
 Moves the node along arbitrary axes.

virtual void translate (const Matrix3 &axes, Real x, Real y, Real z)
 Moves the node along arbitrary axes.

virtual void roll (Real degrees)
 Rotate the node around the Z-axis.

virtual void pitch (Real degrees)
 Rotate the node around the X-axis.

virtual void yaw (Real degrees)
 Rotate the node around the Y-axis.

virtual void rotate (const Vector3 &axis, Real degrees)
 Rotate the node around an arbitrary axis.

virtual void rotate (const Quaternion &q)
 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 Node * removeChild (unsigned short index)
 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.

MaterialgetMaterial (void) const
 Overridden from Renderable.

void getRenderOperation (RenderOperation &op)
 Overridden from Renderable.

void getWorldTransforms (Matrix4 *xform) const
 Overridden from Renderable.

const QuaterniongetWorldOrientation (void) const
 @copydoc Renderable::getWorldOrientation

const Vector3getWorldPosition (void) const
 @copydoc Renderable::getWorldPosition

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 Vector3getInitialPosition (void) const
 Gets the initial position of this node, see setInitialState for more info.

virtual const QuaterniongetInitialOrientation (void) const
 Gets the initial orientation of this node, see setInitialState for more info.

virtual const Vector3getInitialScale (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 LightListgetLights (void) const
 @copydoc Renderable::getLights

virtual TechniquegetTechnique (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.


Protected Types

typedef std::set< Node * > ChildUpdateSet

Protected Methods

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.

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

Static Protected Attributes

unsigned long msNextGeneratedNameExt = 1
 Incremented count for next name extension.


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

Referenced by getChildIterator().

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

Definition at line 53 of file OgreNode.h.

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

Definition at line 62 of file OgreNode.h.


Constructor & Destructor Documentation

Ogre::Node::Node  
 

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

Remarks:
Generates a name.

Definition at line 42 of file OgreNode.cpp.

References mAccumAnimWeight, mDerivedOrientation, mDerivedPosition, mDerivedScale, mInheritScale, mInitialOrientation, mInitialPosition, mInitialScale, mName, mOrientation, mParent, mParentNotified, mPosition, mScale, msNextGeneratedNameExt, and needUpdate().

Ogre::Node::Node const String   name
 

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

Remarks:
Assigned a name.

Definition at line 61 of file OgreNode.cpp.

References mAccumAnimWeight, mDerivedOrientation, mDerivedPosition, mDerivedScale, mInheritScale, mInitialOrientation, mInitialPosition, mInitialScale, mName, mOrientation, mParent, mParentNotified, mPosition, mScale, and needUpdate().

Ogre::Node::~Node   [virtual]
 

Definition at line 77 of file OgreNode.cpp.


Member Function Documentation

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

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

Definition at line 394 of file OgreNode.cpp.

References _updateFromParent(), mDerivedOrientation, and mNeedParentUpdate.

Referenced by _getFullTransform(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::ParticleSystem::_updateBounds(), Ogre::TagPoint::_updateFromParent(), _updateFromParent(), Ogre::BillboardSet::genBillboardAxes(), Ogre::TerrainRenderable::getWorldOrientation(), Ogre::SubEntity::getWorldOrientation(), Ogre::SimpleRenderable::getWorldOrientation(), Ogre::ParticleSystem::getWorldOrientation(), getWorldOrientation(), Ogre::Frustum::getWorldOrientation(), Ogre::BillboardSet::getWorldOrientation(), Ogre::Frustum::isViewOutOfDate(), Ogre::Camera::isViewOutOfDate(), Ogre::Bone::setBindingPose(), and Ogre::Light::update().

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

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

Definition at line 404 of file OgreNode.cpp.

References _updateFromParent(), mDerivedPosition, and mNeedParentUpdate.

Referenced by Ogre::Camera::_autoTrack(), _getFullTransform(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::ParticleSystem::_updateBounds(), Ogre::TagPoint::_updateFromParent(), _updateFromParent(), Ogre::BspIntersectionSceneQuery::execute(), getSquaredViewDepth(), Ogre::Frustum::getSquaredViewDepth(), Ogre::MovableObject::getWorldBoundingSphere(), Ogre::TerrainRenderable::getWorldPosition(), Ogre::SubEntity::getWorldPosition(), Ogre::SimpleRenderable::getWorldPosition(), Ogre::ParticleSystem::getWorldPosition(), getWorldPosition(), Ogre::Frustum::getWorldPosition(), Ogre::BillboardSet::getWorldPosition(), Ogre::Frustum::isViewOutOfDate(), Ogre::Camera::isViewOutOfDate(), Ogre::Bone::setBindingPose(), and Ogre::Light::update().

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

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

Definition at line 414 of file OgreNode.cpp.

References mDerivedScale.

Referenced by _getFullTransform(), _updateFromParent(), Ogre::Entity::getBoundingBox(), and Ogre::Entity::getBoundingRadius().

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.

Definition at line 97 of file OgreNode.cpp.

References _getDerivedOrientation(), _getDerivedPosition(), _getDerivedScale(), makeTransform(), mCachedTransform, and mCachedTransformOutOfDate.

Referenced by Ogre::Skeleton::_getBoneMatrices(), Ogre::MovableObject::_getParentNodeFullTransform(), Ogre::TerrainRenderable::getWorldTransforms(), Ogre::SimpleRenderable::getWorldTransforms(), and getWorldTransforms().

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.

Definition at line 110 of file OgreNode.cpp.

References _updateFromParent(), mChildren, mChildrenToUpdate, mNeedChildUpdate, mNeedParentUpdate, and mParentNotified.

Referenced by Ogre::Skeleton::_getBoneMatrices(), and Ogre::Skeleton::setBindingPose().

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.

Definition at line 162 of file OgreNode.cpp.

References _getDerivedOrientation(), _getDerivedPosition(), _getDerivedScale(), mCachedTransformOutOfDate, mDerivedOrientation, mDerivedPosition, mDerivedScale, mOrientation, mParent, mPosition, and mScale.

Referenced by _getDerivedOrientation(), _getDerivedPosition(), and _update().

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.

Definition at line 653 of file OgreNode.cpp.

References mAccumAnimWeight, mInitialOrientation, mInitialPosition, mInitialScale, mOrientation, mPosition, mRotFromInitial, mScale, mScaleFromInitial, mTransFromInitial, needUpdate(), and Ogre::Real.

Referenced by Ogre::AnimationTrack::applyToNode().

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

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

Definition at line 224 of file OgreNode.cpp.

References getName(), mChildren, and setParent().

Referenced by Ogre::Overlay::add3D(), createChild(), Ogre::Bone::createChild(), Ogre::Bone::createChildTagPoint(), and Ogre::SkeletonSerializer::readBoneParent().

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

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

Definition at line 739 of file OgreNode.cpp.

References mChildrenToUpdate, mNeedChildUpdate, mParent, and mParentNotified.

Referenced by removeChild().

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

Definition at line 214 of file OgreNode.cpp.

References addChild(), createChildImpl(), rotate(), and translate().

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

Definition at line 204 of file OgreNode.cpp.

References addChild(), createChildImpl(), rotate(), and translate().

Referenced by Ogre::SceneNode::createChildSceneNode().

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.

Referenced by createChild().

Node * Ogre::Node::getChild const String   name const [virtual]
 

Gets a pointer to a named child node.

Definition at line 613 of file OgreNode.cpp.

References Except, and mChildren.

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.

Definition at line 236 of file OgreNode.cpp.

References mChildren.

Referenced by Ogre::SceneNode::removeAndDestroyChild().

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

Definition at line 648 of file OgreNode.cpp.

References ChildNodeIterator, and mChildren.

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.

Definition at line 449 of file OgreNode.cpp.

References mInheritScale.

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

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

Definition at line 602 of file OgreNode.cpp.

References mInitialOrientation.

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.

Definition at line 597 of file OgreNode.cpp.

References mInitialPosition.

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

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

Definition at line 608 of file OgreNode.cpp.

References mInitialScale.

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

@copydoc Renderable::getLights

Implements Ogre::Renderable.

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

Definition at line 572 of file OgreNode.h.

References Ogre::LightList.

Referenced by Ogre::TerrainRenderable::getLights(), Ogre::TagPoint::getLights(), Ogre::SubEntity::getLights(), Ogre::SimpleRenderable::getLights(), and Ogre::BillboardSet::getLights().

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.

Definition at line 322 of file OgreNode.cpp.

References mOrientation, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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

Definition at line 532 of file OgreNode.cpp.

References Except, and Ogre::Material::load().

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

Returns the name of the node.

Definition at line 527 of file OgreNode.cpp.

References mName.

Referenced by addChild(), Ogre::Skeleton::createBone(), Ogre::SceneManager::createSceneNode(), Ogre::OctreeSceneManager::createSceneNode(), Ogre::BspSceneManager::createSceneNode(), Ogre::Overlay::remove3D(), Ogre::SceneNode::removeAndDestroyAllChildren(), Ogre::SceneNode::removeAndDestroyChild(), and Ogre::SkeletonSerializer::writeBone().

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 132 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::renderSingleObject().

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::SubEntity, and Ogre::BorderRenderable.

Definition at line 98 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::renderSingleObject().

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

Returns a quaternion representing the nodes orientation.

Definition at line 274 of file OgreNode.cpp.

References mOrientation.

Referenced by Ogre::Skeleton::_dumpContents(), and Ogre::SkeletonSerializer::writeBone().

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

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

Definition at line 82 of file OgreNode.cpp.

References mParent.

Referenced by Ogre::Skeleton::deriveRootBone(), and Ogre::SkeletonSerializer::writeSkeleton().

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

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

Definition at line 317 of file OgreNode.cpp.

References mPosition.

Referenced by Ogre::Skeleton::_dumpContents(), and Ogre::SkeletonSerializer::writeBone().

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

Returns the preferred rasterisation mode of this renderable.

Reimplemented in Ogre::SubEntity.

Definition at line 129 of file OgreRenderable.h.

References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID.

Referenced by Ogre::SceneManager::renderSingleObject().

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.

Definition at line 548 of file OgreNode.cpp.

References Ogre::SubMesh::_getRenderOperation(), Ogre::Mesh::getSubMesh(), and Ogre::Material::load().

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

Gets the scaling factor of this node.

Definition at line 438 of file OgreNode.cpp.

References mScale.

Real Ogre::Node::getSquaredViewDepth const Camera   cam const [virtual]
 

Overridden, see Renderable.

Implements Ogre::Renderable.

Definition at line 687 of file OgreNode.cpp.

References _getDerivedPosition(), Ogre::Camera::getDerivedPosition(), Ogre::Real, and Ogre::Vector3::squaredLength().

Referenced by Ogre::Entity::_notifyCurrentCamera(), Ogre::SubEntity::getSquaredViewDepth(), and Ogre::BillboardSet::getSquaredViewDepth().

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

Definition at line 63 of file OgreRenderable.h.

References Ogre::Material::getBestTechnique().

Referenced by Ogre::RenderPriorityGroup::addRenderable().

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

@copydoc Renderable::getWorldOrientation

Implements Ogre::Renderable.

Definition at line 565 of file OgreNode.cpp.

References _getDerivedOrientation().

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

@copydoc Renderable::getWorldPosition

Implements Ogre::Renderable.

Definition at line 570 of file OgreNode.cpp.

References _getDerivedPosition().

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.

Definition at line 559 of file OgreNode.cpp.

References _getFullTransform().

Referenced by Ogre::Frustum::getWorldTransforms().

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.

Definition at line 492 of file OgreNode.cpp.

References Ogre::Quaternion::Inverse(), Ogre::Matrix4::setTrans(), Ogre::Quaternion::ToRotationMatrix(), Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

Referenced by Ogre::Bone::setBindingPose().

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.

Definition at line 470 of file OgreNode.cpp.

References Ogre::Matrix4::setTrans(), Ogre::Quaternion::ToRotationMatrix(), Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

Referenced by _getFullTransform(), and Ogre::TagPoint::_updateFromParent().

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.

Definition at line 695 of file OgreNode.cpp.

References mCachedTransformOutOfDate, mChildrenToUpdate, mNeedChildUpdate, mNeedParentUpdate, mParent, mParentNotified, and requestUpdate().

Referenced by Ogre::BillboardSet::_updateBounds(), _weightedTransform(), Ogre::SceneNode::attachObject(), Ogre::SceneNode::detachAllObjects(), Ogre::SceneNode::detachObject(), Ogre::TagPoint::needUpdate(), Node(), Ogre::SceneNode::removeAndDestroyAllChildren(), removeChild(), resetOrientation(), resetToInitialState(), rotate(), scale(), Ogre::SceneNode::SceneNode(), setInheritScale(), setOrientation(), setParent(), setPosition(), setScale(), and translate().

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

Reports the number of child nodes under this one.

Definition at line 231 of file OgreNode.cpp.

References mChildren.

void Ogre::Node::pitch Real    degrees [virtual]
 

Rotate the node around the X-axis.

Definition at line 368 of file OgreNode.cpp.

References Ogre::Real, and rotate().

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.

Definition at line 419 of file OgreNode.cpp.

References mChildren.

Referenced by Ogre::Overlay::clear(), and Ogre::SceneManager::clearScene().

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.

Definition at line 626 of file OgreNode.cpp.

References cancelUpdate(), Except, mChildren, and setParent().

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.

Definition at line 248 of file OgreNode.cpp.

References cancelUpdate(), Except, mChildren, needUpdate(), and setParent().

Referenced by Ogre::Overlay::remove3D(), and Ogre::SceneNode::removeAndDestroyChild().

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

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

Definition at line 722 of file OgreNode.cpp.

References mChildrenToUpdate, mParent, and mParentNotified.

Referenced by needUpdate().

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

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

Definition at line 295 of file OgreNode.cpp.

References mOrientation, and needUpdate().

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

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

Definition at line 582 of file OgreNode.cpp.

References mAccumAnimWeight, mInitialOrientation, mInitialPosition, mInitialScale, mOrientation, mPosition, mRotFromInitial, mScale, mScaleFromInitial, mTransFromInitial, and needUpdate().

Referenced by Ogre::SceneManager::_applySceneAnimations(), and Ogre::Bone::reset().

void Ogre::Node::roll Real    degrees [virtual]
 

Rotate the node around the Z-axis.

Definition at line 363 of file OgreNode.cpp.

References Ogre::Real, and rotate().

void Ogre::Node::rotate const Quaternion   q [virtual]
 

Rotate the node around an aritrary axis using a Quarternion.

Definition at line 387 of file OgreNode.cpp.

References mOrientation, and needUpdate().

void Ogre::Node::rotate const Vector3   axis,
Real    degrees
[virtual]
 

Rotate the node around an arbitrary axis.

Definition at line 379 of file OgreNode.cpp.

References Ogre::Quaternion::FromAngleAxis(), and Ogre::Real.

Referenced by Ogre::AnimationTrack::applyToNode(), createChild(), Ogre::Bone::createChild(), Ogre::Skeleton::createTagPoint(), Ogre::OverlayManager::parseNewMesh(), pitch(), roll(), and yaw().

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.

Definition at line 461 of file OgreNode.cpp.

References mScale, needUpdate(), Ogre::Real, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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.

Definition at line 454 of file OgreNode.cpp.

References mScale, and needUpdate().

Referenced by Ogre::AnimationTrack::applyToNode().

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.

Definition at line 443 of file OgreNode.cpp.

References mInheritScale, and needUpdate().

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.

Definition at line 575 of file OgreNode.cpp.

References mInitialOrientation, mInitialPosition, mInitialScale, mOrientation, mPosition, and mScale.

Referenced by Ogre::Bone::setBindingPose().

void Ogre::Node::setOrientation Real    w,
Real    x,
Real    y,
Real    z
[virtual]
 

Sets the orientation of this node via quaternion parameters.

Definition at line 286 of file OgreNode.cpp.

References mOrientation, needUpdate(), Ogre::Real, Ogre::Quaternion::w, Ogre::Quaternion::x, Ogre::Quaternion::y, and Ogre::Quaternion::z.

void Ogre::Node::setOrientation const Quaternion   q [virtual]
 

Sets the orientation of this node via a quaternion.

Definition at line 280 of file OgreNode.cpp.

References mOrientation, and needUpdate().

Referenced by Ogre::Overlay::_findVisibleObjects(), and Ogre::SkeletonSerializer::readBone().

void Ogre::Node::setParent Node *    parent [protected]
 

Only available internally - notification of parent.

Definition at line 88 of file OgreNode.cpp.

References mParent, mParentNotified, and needUpdate().

Referenced by addChild(), and removeChild().

void Ogre::Node::setPosition Real    x,
Real    y,
Real    z
[virtual]
 

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

Definition at line 310 of file OgreNode.cpp.

References Ogre::Real, and setPosition().

void Ogre::Node::setPosition const Vector3   pos [virtual]
 

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

Definition at line 302 of file OgreNode.cpp.

References mPosition, and needUpdate().

Referenced by Ogre::Overlay::_findVisibleObjects(), Ogre::SceneManager::_queueSkiesForRendering(), Ogre::SkeletonSerializer::readBone(), and setPosition().

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.

Definition at line 430 of file OgreNode.cpp.

References mScale, needUpdate(), Ogre::Real, Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.

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.

Definition at line 424 of file OgreNode.cpp.

References mScale, and needUpdate().

void Ogre::Node::translate const Matrix3   axes,
Real    x,
Real    y,
Real    z
[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.

Definition at line 357 of file OgreNode.cpp.

References Ogre::Real, and translate().

void Ogre::Node::translate const Matrix3   axes,
const Vector3   move
[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.

Definition at line 351 of file OgreNode.cpp.

References translate().

void Ogre::Node::translate Real    x,
Real    y,
Real    z
[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.

Definition at line 345 of file OgreNode.cpp.

References Ogre::Real, and translate().

void Ogre::Node::translate const Vector3   d [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.

Definition at line 338 of file OgreNode.cpp.

References mPosition, and needUpdate().

Referenced by Ogre::AnimationTrack::applyToNode(), createChild(), Ogre::Bone::createChild(), Ogre::Skeleton::createTagPoint(), Ogre::OverlayManager::parseNewMesh(), and translate().

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::GuiElement, and Ogre::BorderRenderable.

Definition at line 108 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().

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::GuiElement, and Ogre::BorderRenderable.

Definition at line 118 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::useRenderableViewProjMode().

void Ogre::Node::yaw Real    degrees [virtual]
 

Rotate the node around the Y-axis.

Definition at line 373 of file OgreNode.cpp.

References Ogre::Real, and rotate().


Member Data Documentation

Real Ogre::Node::mAccumAnimWeight [protected]
 

Definition at line 165 of file OgreNode.h.

Referenced by _weightedTransform(), Node(), and resetToInitialState().

Matrix4 Ogre::Node::mCachedTransform [protected]
 

Cached derived transform as a 4x4 matrix.

Definition at line 174 of file OgreNode.h.

Referenced by _getFullTransform().

bool Ogre::Node::mCachedTransformOutOfDate [protected]
 

Definition at line 175 of file OgreNode.h.

Referenced by _getFullTransform(), _updateFromParent(), and needUpdate().

ChildNodeMap Ogre::Node::mChildren [protected]
 

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 60 of file OgreNode.h.

Referenced by Ogre::SceneNode::_findVisibleObjects(), Ogre::OctreeNode::_removeNodeAndChildren(), _update(), Ogre::SceneNode::_updateBounds(), addChild(), getChild(), getChildIterator(), numChildren(), removeAllChildren(), Ogre::SceneNode::removeAndDestroyAllChildren(), and removeChild().

ChildUpdateSet Ogre::Node::mChildrenToUpdate [protected]
 

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

Definition at line 64 of file OgreNode.h.

Referenced by _update(), cancelUpdate(), needUpdate(), and requestUpdate().

Quaternion Ogre::Node::mDerivedOrientation [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 100 of file OgreNode.h.

Referenced by _getDerivedOrientation(), Ogre::TagPoint::_updateFromParent(), _updateFromParent(), and Node().

Vector3 Ogre::Node::mDerivedPosition [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 109 of file OgreNode.h.

Referenced by _getDerivedPosition(), Ogre::TagPoint::_updateFromParent(), _updateFromParent(), and Node().

Vector3 Ogre::Node::mDerivedScale [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 118 of file OgreNode.h.

Referenced by _getDerivedScale(), Ogre::TagPoint::_updateFromParent(), _updateFromParent(), and Node().

bool Ogre::Node::mInheritScale [protected]
 

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

Definition at line 88 of file OgreNode.h.

Referenced by getInheritScale(), Node(), and setInheritScale().

Quaternion Ogre::Node::mInitialOrientation [protected]
 

The orientation to use as a base for keyframe animation.

Definition at line 160 of file OgreNode.h.

Referenced by _weightedTransform(), getInitialOrientation(), Node(), resetToInitialState(), and setInitialState().

Vector3 Ogre::Node::mInitialPosition [protected]
 

The position to use as a base for keyframe animation.

Definition at line 158 of file OgreNode.h.

Referenced by _weightedTransform(), getInitialPosition(), Node(), resetToInitialState(), and setInitialState().

Vector3 Ogre::Node::mInitialScale [protected]
 

The scale to use as a base for keyframe animation.

Definition at line 162 of file OgreNode.h.

Referenced by _weightedTransform(), getInitialScale(), Node(), resetToInitialState(), and setInitialState().

String Ogre::Node::mName [protected]
 

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

Definition at line 73 of file OgreNode.h.

Referenced by getName(), and Node().

bool Ogre::Node::mNeedChildUpdate [protected]
 

Flag indicating that all children need to be updated.

Definition at line 68 of file OgreNode.h.

Referenced by _update(), cancelUpdate(), and needUpdate().

bool Ogre::Node::mNeedParentUpdate [protected]
 

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

Definition at line 66 of file OgreNode.h.

Referenced by _getDerivedOrientation(), _getDerivedPosition(), _update(), Ogre::BspSceneNode::_update(), and needUpdate().

Quaternion Ogre::Node::mOrientation [protected]
 

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

Definition at line 79 of file OgreNode.h.

Referenced by _updateFromParent(), _weightedTransform(), getLocalAxes(), getOrientation(), Node(), resetOrientation(), resetToInitialState(), rotate(), setInitialState(), and setOrientation().

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

Pointer to parent node.

Definition at line 58 of file OgreNode.h.

Referenced by _updateFromParent(), cancelUpdate(), getParent(), needUpdate(), Node(), requestUpdate(), and setParent().

bool Ogre::Node::mParentNotified [protected]
 

Flag indicating that parent has been notified about update request.

Definition at line 70 of file OgreNode.h.

Referenced by _update(), cancelUpdate(), needUpdate(), Node(), requestUpdate(), and setParent().

Vector3 Ogre::Node::mPosition [protected]
 

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

Definition at line 82 of file OgreNode.h.

Referenced by _updateFromParent(), _weightedTransform(), getPosition(), Node(), resetToInitialState(), setInitialState(), setPosition(), and translate().

Quaternion Ogre::Node::mRotFromInitial [protected]
 

Definition at line 169 of file OgreNode.h.

Referenced by _weightedTransform(), and resetToInitialState().

Vector3 Ogre::Node::mScale [protected]
 

Stores the scaling factor applied to this node.

Definition at line 85 of file OgreNode.h.

Referenced by _updateFromParent(), _weightedTransform(), getScale(), Node(), resetToInitialState(), scale(), setInitialState(), and setScale().

Vector3 Ogre::Node::mScaleFromInitial [protected]
 

Definition at line 171 of file OgreNode.h.

Referenced by _weightedTransform(), and resetToInitialState().

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

Incremented count for next name extension.

Definition at line 40 of file OgreNode.cpp.

Referenced by Node().

Vector3 Ogre::Node::mTransFromInitial [protected]
 

Definition at line 167 of file OgreNode.h.

Referenced by _weightedTransform(), and resetToInitialState().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:18:41 2004