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

Ogre::Bone Class Reference

A bone in a skeleton. More...

#include <OgreBone.h>

Inheritance diagram for Ogre::Bone:

Inheritance graph
[legend]
List of all members.

Public Types

typedef HashMap< String, Node * > ChildNodeMap
typedef MapIterator< ChildNodeMapChildNodeIterator
enum  TransformSpace { TS_LOCAL, TS_PARENT, TS_WORLD }
 Enumeration denoting the spaces which a transform can be relative to. More...


Public Methods

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

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

 ~Bone ()
Bone * createChild (unsigned short handle, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates a new Bone as a child of this bone.

unsigned short getHandle (void) const
 Gets the numeric handle for this bone (unique within the skeleton).

void setBindingPose (void)
 Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh.

void reset (void)
 Resets the position and orientation of this Bone to the original binding position.

void setManuallyControlled (bool manuallyControlled)
 Sets whether or not this bone is manually controlled.

bool isManuallyControlled () const
 Getter for mManuallyControlled Flag.

const Matrix4_getBindingPoseInverseTransform (void) const
 Gets the inverse transform which takes bone space to origin from the binding pose.

const StringgetName (void) const
 Returns the name of the node.

virtual NodegetParent (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, 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 NodecreateChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
 Creates an unnamed new Node as a child of this node.

virtual NodecreateChild (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 NodegetChild (unsigned short index) const
 Gets a pointer to a child node.

virtual NodegetChild (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 NoderemoveChild (unsigned short index)
 Drops the specified child from this node.

virtual NoderemoveChild (Node *child)
 Drops the specified child from this node.

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

virtual const PlaneListgetClipPlanes () 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 Vector4getCustomParameter (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.


Protected Types

typedef std::set< Node * > ChildUpdateSet
typedef std::map< size_t,
Vector4
CustomParameterMap

Protected Methods

NodecreateChildImpl (void)
 See Node.

NodecreateChildImpl (const String &name)
 See Node.

void setParent (Node *parent)
 Only available internally - notification of parent.

virtual void _updateFromParent (void) const
 Triggers the node to update it's combined transforms.

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

unsigned short mHandle
 The numeric handle of this bone.

bool mManuallyControlled
 Bones set as manuallyControlled are not reseted in Skeleton::reset().

SkeletonmCreator
 Pointer back to creator, for child creation (central memory allocation).

Matrix4 mBindDerivedInverseTransform
 The inversed derived transform of the bone in the binding pose.

NodemParent
 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
CustomParameterMap mCustomParameters

Static Protected Attributes

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

const PlaneList msDummyPlaneList

Detailed Description

A bone in a skeleton.

Remarks:
See Skeleton for more information about the principles behind skeletal animation. This class is a node in the joint hierarchy. Mesh vertices also have assignments to bones to define how they move in relation to the skeleton.

Definition at line 41 of file OgreBone.h.


Member Typedef Documentation

typedef MapIterator<ChildNodeMap> Ogre::Node::ChildNodeIterator [inherited]
 

Definition at line 65 of file OgreNode.h.

Referenced by Ogre::Node::getChildIterator().

typedef HashMap<String, Node*> Ogre::Node::ChildNodeMap [inherited]
 

Definition at line 64 of file OgreNode.h.

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

Definition at line 73 of file OgreNode.h.

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

Definition at line 232 of file OgreRenderable.h.


Member Enumeration Documentation

enum Ogre::Node::TransformSpace [inherited]
 

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::Bone::Bone unsigned short    handle,
Skeleton   creator
 

Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone).

Definition at line 34 of file OgreBone.cpp.

Ogre::Bone::Bone const String   name,
unsigned short    handle,
Skeleton   creator
 

Constructor, not to be used directly (use Bone::createChild or Skeleton::createBone).

Definition at line 39 of file OgreBone.cpp.

References Ogre::String.

Ogre::Bone::~Bone  
 

Definition at line 44 of file OgreBone.cpp.


Member Function Documentation

const Matrix4 & Ogre::Bone::_getBindingPoseInverseTransform void    const
 

Gets the inverse transform which takes bone space to origin from the binding pose.

Remarks:
Internal use only.

Definition at line 90 of file OgreBone.cpp.

References mBindDerivedInverseTransform.

Referenced by Ogre::Skeleton::_getBoneMatrices().

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

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

Definition at line 447 of file OgreNode.cpp.

References Ogre::Node::_updateFromParent(), Ogre::Node::mDerivedOrientation, and Ogre::Node::mNeedParentUpdate.

Referenced by Ogre::MovablePlane::_getDerivedPlane(), Ogre::Node::_getFullTransform(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::ParticleSystem::_updateBounds(), Ogre::TagPoint::_updateFromParent(), Ogre::Node::_updateFromParent(), Ogre::BillboardSet::genBillboardAxes(), Ogre::TerrainRenderable::getWorldOrientation(), Ogre::SubEntity::getWorldOrientation(), Ogre::SimpleRenderable::getWorldOrientation(), Ogre::ParticleSystem::getWorldOrientation(), Ogre::Node::getWorldOrientation(), Ogre::Frustum::getWorldOrientation(), Ogre::Entity::EntityShadowRenderable::getWorldOrientation(), Ogre::BillboardSet::getWorldOrientation(), Ogre::Frustum::isViewOutOfDate(), Ogre::Camera::isViewOutOfDate(), Ogre::Node::rotate(), setBindingPose(), Ogre::SceneNode::setDirection(), Ogre::Node::translate(), and Ogre::Light::update().

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

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

Definition at line 457 of file OgreNode.cpp.

References Ogre::Node::_updateFromParent(), Ogre::Node::mDerivedPosition, and Ogre::Node::mNeedParentUpdate.

Referenced by Ogre::SceneNode::_autoTrack(), Ogre::Camera::_autoTrack(), Ogre::MovablePlane::_getDerivedPlane(), Ogre::Node::_getFullTransform(), Ogre::ParticleSystem::_triggerEmitters(), Ogre::ParticleSystem::_updateBounds(), Ogre::TagPoint::_updateFromParent(), Ogre::Node::_updateFromParent(), Ogre::BspIntersectionSceneQuery::execute(), Ogre::MovableObject::getPointExtrusionDistance(), Ogre::Node::getSquaredViewDepth(), Ogre::Frustum::getSquaredViewDepth(), Ogre::MovableObject::getWorldBoundingSphere(), Ogre::TerrainRenderable::getWorldPosition(), Ogre::SubEntity::getWorldPosition(), Ogre::SimpleRenderable::getWorldPosition(), Ogre::ParticleSystem::getWorldPosition(), Ogre::Node::getWorldPosition(), Ogre::Frustum::getWorldPosition(), Ogre::Entity::EntityShadowRenderable::getWorldPosition(), Ogre::BillboardSet::getWorldPosition(), Ogre::Frustum::isViewOutOfDate(), Ogre::Camera::isViewOutOfDate(), Ogre::SceneNode::lookAt(), Ogre::SceneManager::ShadowCasterSceneQueryListener::queryResult(), setBindingPose(), and Ogre::Light::update().

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

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

Definition at line 467 of file OgreNode.cpp.

References Ogre::Node::mDerivedScale.

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

Matrix4 Ogre::Node::_getFullTransform void    const [virtual, inherited]
 

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 Ogre::Node::_getDerivedOrientation(), Ogre::Node::_getDerivedPosition(), Ogre::Node::_getDerivedScale(), Ogre::Node::makeTransform(), Ogre::Node::mCachedTransform, and Ogre::Node::mCachedTransformOutOfDate.

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

void Ogre::Node::_update bool    updateChildren,
bool    parentHasChanged
[virtual, inherited]
 

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 Ogre::Node::_updateFromParent(), Ogre::Node::mChildren, Ogre::Node::mChildrenToUpdate, Ogre::Node::mNeedChildUpdate, Ogre::Node::mNeedParentUpdate, and Ogre::Node::mParentNotified.

Referenced by Ogre::SkeletonInstance::load().

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

References Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::index, params, and Ogre::GpuProgramParameters::setConstant().

Referenced by Ogre::GpuProgramParameters::_updateAutoParamsNoLights().

void Ogre::Node::_updateFromParent void    const [protected, virtual, inherited]
 

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 Ogre::Node::_getDerivedOrientation(), Ogre::Node::_getDerivedPosition(), Ogre::Node::_getDerivedScale(), Ogre::Node::mCachedTransformOutOfDate, Ogre::Node::mDerivedOrientation, Ogre::Node::mDerivedPosition, Ogre::Node::mDerivedScale, Ogre::Node::mOrientation, Ogre::Node::mParent, Ogre::Node::mPosition, and Ogre::Node::mScale.

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

void Ogre::Node::_weightedTransform Real    weight,
const Vector3   translate,
const Quaternion   rotate,
const Vector3   scale
[virtual, inherited]
 

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 706 of file OgreNode.cpp.

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

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

void Ogre::Node::addChild Node   child [virtual, inherited]
 

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

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

Definition at line 224 of file OgreNode.cpp.

References Ogre::Node::getName(), Ogre::Node::mChildren, and Ogre::Node::setParent().

Referenced by Ogre::Overlay::add3D(), Ogre::TerrainSceneManager::attachPage(), Ogre::SkeletonInstance::cloneBoneAndChildren(), Ogre::Node::createChild(), createChild(), Ogre::SkeletonInstance::createTagPointOnBone(), and Ogre::SkeletonSerializer::readBoneParent().

void Ogre::Node::cancelUpdate Node   child [virtual, inherited]
 

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

Definition at line 792 of file OgreNode.cpp.

References Ogre::Node::mChildrenToUpdate, Ogre::Node::mNeedChildUpdate, Ogre::Node::mParent, and Ogre::Node::mParentNotified.

Referenced by Ogre::Node::removeChild().

Node * Ogre::Node::createChild const String   name,
const Vector3   translate = Vector3::ZERO,
const Quaternion   rotate = Quaternion::IDENTITY
[virtual, inherited]
 

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 Ogre::Node::addChild(), Ogre::Node::createChildImpl(), Ogre::Node::rotate(), Ogre::String, and Ogre::Node::translate().

Node * Ogre::Node::createChild const Vector3   translate = Vector3::ZERO,
const Quaternion   rotate = Quaternion::IDENTITY
[virtual, inherited]
 

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 Ogre::Node::addChild(), Ogre::Node::createChildImpl(), Ogre::Node::rotate(), and Ogre::Node::translate().

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

Bone * Ogre::Bone::createChild unsigned short    handle,
const Vector3   translate = Vector3::ZERO,
const Quaternion   rotate = Quaternion::IDENTITY
 

Creates a new Bone as a child of this bone.

Remarks:
This method creates a new bone which will inherit the transforms of this bone, with the handle specified.
Parameters:
handle  The numeric handle to give the new bone; must be unique within the Skeleton.
translate  Initial translation offset of child relative to parent
rotate  Initial rotation relative to parent

Definition at line 48 of file OgreBone.cpp.

References Ogre::Node::addChild(), Ogre::Skeleton::createBone(), mCreator, Ogre::Node::rotate(), and Ogre::Node::translate().

Node * Ogre::Bone::createChildImpl const String   name [protected, virtual]
 

See Node.

Implements Ogre::Node.

Definition at line 63 of file OgreBone.cpp.

References Ogre::Skeleton::createBone(), mCreator, and Ogre::String.

Node * Ogre::Bone::createChildImpl void    [protected, virtual]
 

See Node.

Implements Ogre::Node.

Definition at line 58 of file OgreBone.cpp.

References Ogre::Skeleton::createBone(), and mCreator.

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

Definition at line 153 of file OgreRenderable.h.

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

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

Gets a pointer to a named child node.

Definition at line 666 of file OgreNode.cpp.

References Except, Ogre::Node::mChildren, and Ogre::String.

Node * Ogre::Node::getChild unsigned short    index const [virtual, inherited]
 

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

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

Node::ChildNodeIterator Ogre::Node::getChildIterator void    [virtual, inherited]
 

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 701 of file OgreNode.cpp.

References Ogre::Node::ChildNodeIterator, and Ogre::Node::mChildren.

Referenced by Ogre::SkeletonInstance::cloneBoneAndChildren().

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

Definition at line 145 of file OgreRenderable.h.

References Ogre::PlaneList.

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

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

References Except.

unsigned short Ogre::Bone::getHandle void    const
 

Gets the numeric handle for this bone (unique within the skeleton).

Definition at line 95 of file OgreBone.cpp.

References mHandle.

Referenced by Ogre::Skeleton::_dumpContents(), Ogre::SkeletonInstance::cloneBoneAndChildren(), Ogre::SkeletonSerializer::writeAnimationTrack(), Ogre::SkeletonSerializer::writeBone(), and Ogre::SkeletonSerializer::writeSkeleton().

bool Ogre::Node::getInheritScale void    const [virtual, inherited]
 

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

Remarks:
See setInheritScale for more info.

Definition at line 502 of file OgreNode.cpp.

References Ogre::Node::mInheritScale.

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

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

Definition at line 655 of file OgreNode.cpp.

References Ogre::Node::mInitialOrientation.

const Vector3 & Ogre::Node::getInitialPosition void    const [virtual, inherited]
 

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 650 of file OgreNode.cpp.

References Ogre::Node::mInitialPosition.

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

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

Definition at line 661 of file OgreNode.cpp.

References Ogre::Node::mInitialScale.

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

@copydoc Renderable::getLights

Implements Ogre::Renderable.

Reimplemented in Ogre::TagPoint.

Definition at line 620 of file OgreNode.h.

References Ogre::LightList.

Matrix3 Ogre::Node::getLocalAxes void    const [virtual, inherited]
 

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

Definition at line 340 of file OgreNode.cpp.

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

Material * Ogre::Node::getMaterial void    const [virtual, inherited]
 

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 585 of file OgreNode.cpp.

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

const String & Ogre::Node::getName void    const [inherited]
 

Returns the name of the node.

Definition at line 580 of file OgreNode.cpp.

References Ogre::Node::mName, and Ogre::String.

Referenced by Ogre::Node::addChild(), Ogre::SkeletonInstance::cloneBoneAndChildren(), 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 137 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 103 of file OgreRenderable.h.

Referenced by Ogre::AutoParamDataSource::getWorldMatrix(), Ogre::AutoParamDataSource::getWorldMatrixArray(), Ogre::AutoParamDataSource::getWorldMatrixCount(), and Ogre::SceneManager::renderSingleObject().

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

Returns a quaternion representing the nodes orientation.

Definition at line 292 of file OgreNode.cpp.

References Ogre::Node::mOrientation.

Referenced by Ogre::Skeleton::_dumpContents(), Ogre::SkeletonInstance::cloneBoneAndChildren(), Ogre::SceneNode::setDirection(), and Ogre::SkeletonSerializer::writeBone().

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

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

Definition at line 82 of file OgreNode.cpp.

References Ogre::Node::mParent.

Referenced by Ogre::Skeleton::deriveRootBone(), Ogre::SkeletonInstance::freeTagPoint(), Ogre::SceneNode::getParentSceneNode(), and Ogre::SkeletonSerializer::writeSkeleton().

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

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

Definition at line 335 of file OgreNode.cpp.

References Ogre::Node::mPosition.

Referenced by Ogre::Skeleton::_dumpContents(), Ogre::SkeletonInstance::cloneBoneAndChildren(), 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 134 of file OgreRenderable.h.

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

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

void Ogre::Node::getRenderOperation RenderOperation   op [virtual, inherited]
 

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 601 of file OgreNode.cpp.

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

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

Gets the scaling factor of this node.

Definition at line 491 of file OgreNode.cpp.

References Ogre::Node::mScale.

Referenced by Ogre::SkeletonInstance::cloneBoneAndChildren().

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

Overridden, see Renderable.

Implements Ogre::Renderable.

Definition at line 740 of file OgreNode.cpp.

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

Referenced by Ogre::Entity::_notifyCurrentCamera(), and Ogre::SubEntity::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 68 of file OgreRenderable.h.

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

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

@copydoc Renderable::getWorldOrientation

Implements Ogre::Renderable.

Definition at line 618 of file OgreNode.cpp.

References Ogre::Node::_getDerivedOrientation().

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

@copydoc Renderable::getWorldPosition

Implements Ogre::Renderable.

Definition at line 623 of file OgreNode.cpp.

References Ogre::Node::_getDerivedPosition().

void Ogre::Node::getWorldTransforms Matrix4   xform const [virtual, inherited]
 

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 612 of file OgreNode.cpp.

References Ogre::Node::_getFullTransform().

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

bool Ogre::Bone::isManuallyControlled   const
 

Getter for mManuallyControlled Flag.

Definition at line 86 of file OgreBone.cpp.

References mManuallyControlled.

void Ogre::Node::makeInverseTransform const Vector3   position,
const Vector3   scale,
const Quaternion   orientation,
Matrix4   destMatrix
[protected, inherited]
 

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 545 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 setBindingPose().

void Ogre::Node::makeTransform const Vector3   position,
const Vector3   scale,
const Quaternion   orientation,
Matrix4   destMatrix
const [protected, inherited]
 

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 523 of file OgreNode.cpp.

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

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

void Ogre::Node::needUpdate   [virtual, inherited]
 

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 748 of file OgreNode.cpp.

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

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

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

Reports the number of child nodes under this one.

Definition at line 231 of file OgreNode.cpp.

References Ogre::Node::mChildren.

void Ogre::Node::pitch const Radian   angle,
TransformSpace    relativeTo = TS_LOCAL
[virtual, inherited]
 

Rotate the node around the X-axis.

Definition at line 407 of file OgreNode.cpp.

References Ogre::Node::rotate().

void Ogre::Node::removeAllChildren void    [virtual, inherited]
 

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 472 of file OgreNode.cpp.

References Ogre::Node::mChildren.

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

Node * Ogre::Node::removeChild const String   name [virtual, inherited]
 

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 679 of file OgreNode.cpp.

References Ogre::Node::cancelUpdate(), Except, Ogre::Node::mChildren, Ogre::Node::setParent(), and Ogre::String.

Node * Ogre::Node::removeChild Node   child [virtual, inherited]
 

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 273 of file OgreNode.cpp.

References Ogre::Node::cancelUpdate(), Ogre::Node::mChildren, and Ogre::Node::setParent().

Node * Ogre::Node::removeChild unsigned short    index [virtual, inherited]
 

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 Ogre::Node::cancelUpdate(), Except, Ogre::Node::mChildren, and Ogre::Node::setParent().

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

void Ogre::Node::requestUpdate Node   child [virtual, inherited]
 

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

Definition at line 775 of file OgreNode.cpp.

References Ogre::Node::mChildrenToUpdate, Ogre::Node::mParent, and Ogre::Node::mParentNotified.

Referenced by Ogre::Node::needUpdate().

void Ogre::Bone::reset void   
 

Resets the position and orientation of this Bone to the original binding position.

Remarks:
Bones are bound to the mesh in a binding pose. They are then modified from this position during animation. This method returns the bone to it's original position and orientation.

Definition at line 77 of file OgreBone.cpp.

References Ogre::Node::resetToInitialState().

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

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

Definition at line 313 of file OgreNode.cpp.

References Ogre::Node::mOrientation, and Ogre::Node::needUpdate().

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

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

Definition at line 635 of file OgreNode.cpp.

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

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

void Ogre::Node::roll const Radian   angle,
TransformSpace    relativeTo = TS_LOCAL
[virtual, inherited]
 

Rotate the node around the Z-axis.

Definition at line 402 of file OgreNode.cpp.

References Ogre::Node::rotate().

void Ogre::Node::rotate const Quaternion   q,
TransformSpace    relativeTo = TS_LOCAL
[virtual, inherited]
 

Rotate the node around an aritrary axis using a Quarternion.

Definition at line 426 of file OgreNode.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::Quaternion::Inverse(), Ogre::Node::mOrientation, Ogre::Node::needUpdate(), Ogre::Node::TS_LOCAL, Ogre::Node::TS_PARENT, and Ogre::Node::TS_WORLD.

void Ogre::Node::rotate const Vector3   axis,
const Radian   angle,
TransformSpace    relativeTo = TS_LOCAL
[virtual, inherited]
 

Rotate the node around an arbitrary axis.

Definition at line 418 of file OgreNode.cpp.

References Ogre::Quaternion::FromAngleAxis().

Referenced by Ogre::AnimationTrack::applyToNode(), Ogre::Node::createChild(), createChild(), Ogre::OverlayManager::parseNewMesh(), Ogre::Node::pitch(), Ogre::Node::roll(), Ogre::SceneNode::yaw(), and Ogre::Node::yaw().

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

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 514 of file OgreNode.cpp.

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

void Ogre::Node::scale const Vector3   scale [virtual, inherited]
 

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 507 of file OgreNode.cpp.

References Ogre::Node::mScale, and Ogre::Node::needUpdate().

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

void Ogre::Bone::setBindingPose void   
 

Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh.

Definition at line 68 of file OgreBone.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::Node::_getDerivedPosition(), Ogre::Node::makeInverseTransform(), mBindDerivedInverseTransform, and Ogre::Node::setInitialState().

Referenced by Ogre::SkeletonInstance::createTagPointOnBone().

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

void Ogre::Node::setInheritScale bool    inherit [virtual, inherited]
 

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 496 of file OgreNode.cpp.

References Ogre::Node::mInheritScale, and Ogre::Node::needUpdate().

void Ogre::Node::setInitialState void    [virtual, inherited]
 

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 628 of file OgreNode.cpp.

References Ogre::Node::mInitialOrientation, Ogre::Node::mInitialPosition, Ogre::Node::mInitialScale, Ogre::Node::mOrientation, Ogre::Node::mPosition, and Ogre::Node::mScale.

Referenced by setBindingPose().

void Ogre::Bone::setManuallyControlled bool    manuallyControlled
 

Sets whether or not this bone is manually controlled.

Remarks:
Manually controlled bones can be altered by the application at runtime, and their positions will not be reset by the animation routines. Note that you should also make sure that there are no AnimationTrack objects referencing this bone, or if there are, you should disable them using pAnimation->destroyTrack(pBone->getHandle());

Definition at line 82 of file OgreBone.cpp.

References mManuallyControlled.

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

Sets the orientation of this node via quaternion parameters.

Definition at line 304 of file OgreNode.cpp.

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

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

Sets the orientation of this node via a quaternion.

Definition at line 298 of file OgreNode.cpp.

References Ogre::Node::mOrientation, and Ogre::Node::needUpdate().

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

void Ogre::Node::setParent Node   parent [protected, inherited]
 

Only available internally - notification of parent.

Definition at line 88 of file OgreNode.cpp.

References Ogre::Node::mParent, Ogre::Node::mParentNotified, and Ogre::Node::needUpdate().

Referenced by Ogre::Node::addChild(), and Ogre::Node::removeChild().

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

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

Definition at line 328 of file OgreNode.cpp.

References Ogre::Real, and Ogre::Node::setPosition().

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

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

Definition at line 320 of file OgreNode.cpp.

References Ogre::Node::mPosition, and Ogre::Node::needUpdate().

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

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

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 483 of file OgreNode.cpp.

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

void Ogre::Node::setScale const Vector3   scale [virtual, inherited]
 

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 477 of file OgreNode.cpp.

References Ogre::Node::mScale, and Ogre::Node::needUpdate().

Referenced by Ogre::SkeletonInstance::cloneBoneAndChildren(), and Ogre::SkeletonInstance::createTagPointOnBone().

void Ogre::Node::translate const Matrix3   axes,
Real    x,
Real    y,
Real    z,
TransformSpace    relativeTo = TS_PARENT
[virtual, inherited]
 

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.

Definition at line 396 of file OgreNode.cpp.

References Ogre::Real, and Ogre::Node::translate().

void Ogre::Node::translate const Matrix3   axes,
const Vector3   move,
TransformSpace    relativeTo = TS_PARENT
[virtual, inherited]
 

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.

Definition at line 390 of file OgreNode.cpp.

References Ogre::Node::translate().

void Ogre::Node::translate Real    x,
Real    y,
Real    z,
TransformSpace    relativeTo = TS_PARENT
[virtual, inherited]
 

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.

Definition at line 384 of file OgreNode.cpp.

References Ogre::Real, and Ogre::Node::translate().

void Ogre::Node::translate const Vector3   d,
TransformSpace    relativeTo = TS_PARENT
[virtual, inherited]
 

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.

Definition at line 356 of file OgreNode.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::Quaternion::Inverse(), Ogre::Node::mOrientation, Ogre::Node::mParent, Ogre::Node::mPosition, Ogre::Node::needUpdate(), Ogre::Node::TS_LOCAL, Ogre::Node::TS_PARENT, and Ogre::Node::TS_WORLD.

Referenced by Ogre::AnimationTrack::applyToNode(), Ogre::Node::createChild(), createChild(), Ogre::OverlayManager::parseNewMesh(), and Ogre::Node::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, Ogre::Rectangle2D, and Ogre::BorderRenderable.

Definition at line 113 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, Ogre::Rectangle2D, and Ogre::BorderRenderable.

Definition at line 123 of file OgreRenderable.h.

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

void Ogre::Node::yaw const Radian   angle,
TransformSpace    relativeTo = TS_LOCAL
[virtual, inherited]
 

Rotate the node around the Y-axis.

Reimplemented in Ogre::SceneNode.

Definition at line 412 of file OgreNode.cpp.

References Ogre::Node::rotate().


Member Data Documentation

Real Ogre::Node::mAccumAnimWeight [protected, inherited]
 

Definition at line 176 of file OgreNode.h.

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

Matrix4 Ogre::Bone::mBindDerivedInverseTransform [protected]
 

The inversed derived transform of the bone in the binding pose.

Definition at line 118 of file OgreBone.h.

Referenced by _getBindingPoseInverseTransform(), and setBindingPose().

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

Cached derived transform as a 4x4 matrix.

Definition at line 185 of file OgreNode.h.

Referenced by Ogre::Node::_getFullTransform().

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

Definition at line 186 of file OgreNode.h.

Referenced by Ogre::Node::_getFullTransform(), Ogre::Node::_updateFromParent(), and Ogre::Node::needUpdate().

ChildNodeMap Ogre::Node::mChildren [protected, inherited]
 

Collection of pointers to direct children; hashmap for efficiency.

Definition at line 71 of file OgreNode.h.

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

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

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

Definition at line 75 of file OgreNode.h.

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

Skeleton* Ogre::Bone::mCreator [protected]
 

Pointer back to creator, for child creation (central memory allocation).

Definition at line 115 of file OgreBone.h.

Referenced by createChild(), and createChildImpl().

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

Definition at line 233 of file OgreRenderable.h.

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

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

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

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

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

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

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

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

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

unsigned short Ogre::Bone::mHandle [protected]
 

The numeric handle of this bone.

Definition at line 104 of file OgreBone.h.

Referenced by getHandle().

bool Ogre::Node::mInheritScale [protected, inherited]
 

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

Definition at line 99 of file OgreNode.h.

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

Quaternion Ogre::Node::mInitialOrientation [protected, inherited]
 

The orientation to use as a base for keyframe animation.

Definition at line 171 of file OgreNode.h.

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

Vector3 Ogre::Node::mInitialPosition [protected, inherited]
 

The position to use as a base for keyframe animation.

Definition at line 169 of file OgreNode.h.

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

Vector3 Ogre::Node::mInitialScale [protected, inherited]
 

The scale to use as a base for keyframe animation.

Definition at line 173 of file OgreNode.h.

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

bool Ogre::Bone::mManuallyControlled [protected]
 

Bones set as manuallyControlled are not reseted in Skeleton::reset().

Definition at line 107 of file OgreBone.h.

Referenced by isManuallyControlled(), and setManuallyControlled().

String Ogre::Node::mName [protected, inherited]
 

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

Definition at line 84 of file OgreNode.h.

Referenced by Ogre::Node::getName(), and Ogre::Node::Node().

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

Flag indicating that all children need to be updated.

Definition at line 79 of file OgreNode.h.

Referenced by Ogre::Node::_update(), Ogre::Node::cancelUpdate(), and Ogre::Node::needUpdate().

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

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

Definition at line 77 of file OgreNode.h.

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

Quaternion Ogre::Node::mOrientation [protected, inherited]
 

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

Definition at line 90 of file OgreNode.h.

Referenced by Ogre::Node::_updateFromParent(), Ogre::Node::_weightedTransform(), Ogre::Node::getLocalAxes(), Ogre::Node::getOrientation(), Ogre::Node::Node(), Ogre::Node::resetOrientation(), Ogre::Node::resetToInitialState(), Ogre::Node::rotate(), Ogre::SceneNode::setDirection(), Ogre::Node::setInitialState(), Ogre::Node::setOrientation(), and Ogre::Node::translate().

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

Pointer to parent node.

Definition at line 69 of file OgreNode.h.

Referenced by Ogre::Node::_updateFromParent(), Ogre::Node::cancelUpdate(), Ogre::Node::getParent(), Ogre::Node::needUpdate(), Ogre::Node::Node(), Ogre::Node::requestUpdate(), Ogre::SceneNode::setDirection(), Ogre::Node::setParent(), and Ogre::Node::translate().

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

Flag indicating that parent has been notified about update request.

Definition at line 81 of file OgreNode.h.

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

Vector3 Ogre::Node::mPosition [protected, inherited]
 

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

Definition at line 93 of file OgreNode.h.

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

Quaternion Ogre::Node::mRotFromInitial [protected, inherited]
 

Definition at line 180 of file OgreNode.h.

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

Vector3 Ogre::Node::mScale [protected, inherited]
 

Stores the scaling factor applied to this node.

Definition at line 96 of file OgreNode.h.

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

Vector3 Ogre::Node::mScaleFromInitial [protected, inherited]
 

Definition at line 182 of file OgreNode.h.

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

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

Definition at line 45 of file OgreRenderSystem.cpp.

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

Incremented count for next name extension.

Definition at line 40 of file OgreNode.cpp.

Referenced by Ogre::Node::Node().

Vector3 Ogre::Node::mTransFromInitial [protected, inherited]
 

Definition at line 178 of file OgreNode.h.

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


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

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:50:49 2004