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

# Ogre::BspSceneNode Class Reference

Specialisation of SceneNode for the BspSceneManager. More...

`#include <OgreBspSceneNode.h>`

Inheritance diagram for Ogre::BspSceneNode:

[legend]
List of all members.

## Public Types

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

## Public Methods

| BspSceneNode (SceneManager *creator)
| BspSceneNode (SceneManager *creator, const String &name)
void | _update (bool updateChildren, bool parentHasChanged)
| Overridden from Node.
MovableObject * | detachObject (unsigned short index)
| Detaches the indexed object from this scene node.
MovableObject * | detachObject (const String &name)
| Detaches the named object from this node and returns a pointer to it.
void | detachAllObjects (void)
| Detaches all objects attached to this node.
virtual void | attachObject (MovableObject *obj)
| Adds an instance of a scene object to this node.
virtual unsigned short | numAttachedObjects (void) const
| Reports the number of objects attached to this node.
virtual MovableObject * | getAttachedObject (unsigned short index)
| Retrieves a pointer to an attached object.
virtual MovableObject * | getAttachedObject (const String &name)
| Retrieves a pointer to an attached object.
virtual void | detachObject (MovableObject *obj)
| Detaches an object by pointer.
virtual void | _findVisibleObjects (Camera *cam, RenderQueue *queue, bool includeChildren=true, bool displayNodes=false, bool onlyShadowCasters=false)
| Internal method which locates any visible objects attached to this node and adds them to the passed in queue.
virtual AxisAlignedBox | _getWorldAABB (void) const
| Gets the axis-aligned bounding box of this node (and hence all subnodes).
virtual ObjectIterator | getAttachedObjectIterator (void)
| Retrieves an iterator which can be used to efficiently step through the objects attached to this node.
SceneManager * | getCreator (void) const
| Gets the creator of this scene node.
virtual void | removeAndDestroyChild (const String &name)
| This method removes and destroys the named child and all of its children.
virtual void | removeAndDestroyChild (unsigned short index)
| This method removes and destroys the child and all of its children.
virtual void | removeAndDestroyAllChildren (void)
| Removes and destroys all children of this node.
virtual void | showBoundingBox (bool bShow)
| Allows the showing of the node's bounding box.
virtual void | _addBoundingBoxToQueue (RenderQueue *queue)
| Add the bounding box to the rendering queue.
virtual bool | getShowBoundingBox () const
| This allows scene managers to determine if the node's bounding box should be added to the rendering queue.
virtual SceneNode * | createChildSceneNode (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
| Creates an unnamed new SceneNode as a child of this node.
virtual SceneNode * | createChildSceneNode (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
| Creates a new named SceneNode as a child of this node.
const LightList & | findLights (Real radius) const
| Allows retrieval of the nearest lights to the centre of this SceneNode.
void | setFixedYawAxis (bool useFixed, const Vector3 &fixedAxis=Vector3::UNIT_Y)
| Tells the node whether to yaw around it's own local Y axis or a fixed axis of choice.
virtual void | yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around the Y-axis.
void | setDirection (Real x, Real y, Real z, TransformSpace relativeTo=TS_LOCAL, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
| Sets the node's direction vector ie it's local -z.
void | setDirection (const Vector3 &vec, TransformSpace relativeTo=TS_LOCAL, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
| Sets the node's direction vector ie it's local -z.
void | lookAt (const Vector3 &targetPoint, TransformSpace relativeTo, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z)
| Points the local -Z direction of this node at a point in space.
void | setAutoTracking (bool enabled, SceneNode *target=0, const Vector3 &localDirectionVector=Vector3::NEGATIVE_UNIT_Z, const Vector3 &offset=Vector3::ZERO)
| Enables / disables automatic tracking of another SceneNode.
SceneNode * | getAutoTrackTarget (void)
| Get the auto tracking target for this node, if any.
const Vector3 & | getAutoTrackOffset (void)
| Get the auto tracking offset for this node, if the node is auto tracking.
const Vector3 & | getAutoTrackLocalDirection (void)
| Get the auto tracking local direction for this node, if it is auto tracking.
void | _autoTrack (void)
| Internal method used by OGRE to update auto-tracking cameras.
SceneNode * | getParentSceneNode (void) const
| Gets the parent of this SceneNode.
void | setVisible (bool visible, bool cascade=true)
| Makes all objects attached to this node become visible / invisble.
void | flipVisibility (bool cascade=true)
| Inverts the visibility of all objects attached to this node.
const String & | getName (void) const
| Returns the name of the node.
virtual Node * | getParent (void) const
| Gets this node's parent (NULL if this is the root).
virtual const Quaternion & | getOrientation () const
| Returns a quaternion representing the nodes orientation.
virtual void | setOrientation (const Quaternion &q)
| Sets the orientation of this node via a quaternion.
virtual void | setOrientation (Real w, Real x, Real y, Real z)
| Sets the orientation of this node via quaternion parameters.
virtual void | resetOrientation (void)
| Resets the nodes orientation (local axes as world axes, no rotation).
virtual void | setPosition (const Vector3 &pos)
| Sets the position of the node relative to it's parent.
virtual void | setPosition (Real x, Real y, Real z)
| Sets the position of the node relative to it's parent.
virtual const Vector3 & | getPosition (void) const
| Gets the position of the node relative to it's parent.
virtual void | setScale (const Vector3 &scale)
| Sets the scaling factor applied to this node.
virtual void | setScale (Real x, Real y, Real z)
| Sets the scaling factor applied to this node.
virtual const Vector3 & | getScale (void) const
| Gets the scaling factor of this node.
virtual void | setInheritScale (bool inherit)
| Tells the node whether it should inherit scaling factors from it's parent node.
virtual bool | getInheritScale (void) const
| Returns true if this node is affected by scaling factors applied to the parent node.
virtual void | scale (const Vector3 &scale)
| Scales the node, combining it's current scale with the passed in scaling factor.
virtual void | scale (Real x, Real y, Real z)
| Scales the node, combining it's current scale with the passed in scaling factor.
virtual void | translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT)
| Moves the node along the cartesian axes.
virtual void | translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
| Moves the node along the cartesian axes.
virtual void | translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT)
| Moves the node along arbitrary axes.
virtual void | translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT)
| Moves the node along arbitrary axes.
virtual void | roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around the Z-axis.
virtual void | pitch (const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around the X-axis.
virtual void | rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around an arbitrary axis.
virtual void | rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL)
| Rotate the node around an aritrary axis using a Quarternion.
virtual Matrix3 | getLocalAxes (void) const
| Gets a matrix whose columns are the local axes based on the nodes orientation relative to it's parent.
virtual Node * | createChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
| Creates an unnamed new Node as a child of this node.
virtual Node * | createChild (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY)
| Creates a new named Node as a child of this node.
virtual void | addChild (Node *child)
| Adds a (precreated) child scene node to this node.
virtual unsigned short | numChildren (void) const
| Reports the number of child nodes under this one.
virtual Node * | getChild (unsigned short index) const
| Gets a pointer to a child node.
virtual Node * | getChild (const String &name) const
| Gets a pointer to a named child node.
virtual ChildNodeIterator | getChildIterator (void)
| Retrieves an iterator for efficiently looping through all children of this node.
virtual Node * | removeChild (unsigned short index)
| Drops the specified child from this node.
virtual Node * | removeChild (Node *child)
| Drops the specified child from this node.
virtual Node * | removeChild (const String &name)
| Drops the named child from this node.
virtual void | removeAllChildren (void)
| Removes all child Nodes attached to this node.
virtual const Quaternion & | _getDerivedOrientation (void) const
| Gets the orientation of the node as derived from all parents.
virtual const Vector3 & | _getDerivedPosition (void) const
| Gets the position of the node as derived from all parents.
virtual const Vector3 & | _getDerivedScale (void) const
| Gets the scaling factor of the node as derived from all parents.
virtual Matrix4 | _getFullTransform (void) const
| Gets the full transformation matrix for this node.
Material * | getMaterial (void) const
| Overridden from Renderable.
void | getRenderOperation (RenderOperation &op)
| Overridden from Renderable.
void | getWorldTransforms (Matrix4 *xform) const
| Overridden from Renderable.
const Quaternion & | getWorldOrientation (void) const
| @copydoc Renderable::getWorldOrientation
const Vector3 & | getWorldPosition (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 Vector3 & | getInitialPosition (void) const
| Gets the initial position of this node, see setInitialState for more info.
virtual const Quaternion & | getInitialOrientation (void) const
| Gets the initial orientation of this node, see setInitialState for more info.
virtual const Vector3 & | getInitialScale (void) const
| Gets the initial position of this node, see setInitialState for more info.
virtual void | _weightedTransform (Real weight, const Vector3 &translate, const Quaternion &rotate, const Vector3 &scale)
| Internal weighted transform method.
Real | getSquaredViewDepth (const Camera *cam) const
| Overridden, see Renderable.
virtual void | needUpdate ()
| To be called in the event of transform changes to this node that require it's recalculation.
virtual void | requestUpdate (Node *child)
| Called by children to notify their parent that they need an update.
virtual void | cancelUpdate (Node *child)
| Called by children to notify their parent that they no longer need an update.
const LightList & | getLights (void) const
| @copydoc Renderable::getLights
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses.
virtual unsigned short | getNumWorldTransforms (void) const
| Returns the number of world transform matrices this renderable requires.
virtual bool | useIdentityProjection (void) const
| Returns whether or not to use an 'identity' projection.
virtual bool | useIdentityView (void) const
| Returns whether or not to use an 'identity' projection.
virtual SceneDetailLevel | getRenderDetail () const
| Returns the preferred rasterisation mode of this renderable.
virtual bool | getNormaliseNormals (void) const
| Returns whether or not this Renderable wishes the hardware to normalise normals.
virtual const PlaneList & | getClipPlanes () const
virtual bool | getCastsShadows (void) const
| Method which reports whether this renderable would normally cast a shadow.
void | setCustomParameter (size_t index, const Vector4 &value)
| Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index.
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

## Protected Types

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

## Protected Methods

virtual void | _updateBounds (void)
| Tells the SceneNode to update the world bound info it stores.
Node * | createChildImpl (void)
| See Node.
Node * | createChildImpl (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

ObjectMap | mObjectsByName
LightList | mLightList
bool | mLightListDirty
WireBoundingBox * | mWireBoundingBox
| Pointer to a Wire Bounding Box for this Node.
bool | mShowBoundingBox
| Flag that determines if the bounding box of the node should be displayed.
SceneManager * | mCreator
| SceneManager which created this node.
AxisAlignedBox | mWorldAABB
| World-Axis aligned bounding box, updated only through _update.
bool | mYawFixed
| Whether to yaw around a fixed axis.
Vector3 | mYawFixedAxis
| Fixed axis to yaw around.
SceneNode * | mAutoTrackTarget
| Auto tracking target.
Vector3 | mAutoTrackOffset
| Tracking offset for fine tuning.
Vector3 | mAutoTrackLocalDirection
| Local 'normal' direction vector.
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
CustomParameterMap | mCustomParameters

## Static Protected Attributes

unsigned long | msNextGeneratedNameExt = 1
| Incremented count for next name extension.
const PlaneList | msDummyPlaneList

## Detailed Description

Specialisation of SceneNode for the BspSceneManager.

Remarks:
  This specialisation of SceneNode is to enable information about the leaf node in which any attached objects are held is stored for use in the visibility determination.

  Do not confuse this class with BspNode, which reflects nodes in the BSP tree itself. This class is just like a regular SceneNode, except that it should be locating BspNode leaf elements which objects should be included in. Note that because objects are movable, and thus may very well be overlapping the boundaries of more than one leaf, that it is possible that an object attached to one BspSceneNode may actually be associated with more than one BspNode.

Definition at line 46 of file OgreBspSceneNode.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.

typedef MapIterator<ObjectMap> Ogre::SceneNode::ObjectIterator`[inherited]`

| Definition at line 49 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::getAttachedObjectIterator().

typedef HashMap<String, MovableObject*> Ogre::SceneNode::ObjectMap`[inherited]`

| Definition at line 48 of file OgreSceneNode.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::BspSceneNode::BspSceneNode | ( | SceneManager * | creator | ) |

| Definition at line 49 of file OgreBspSceneNode.h.

Ogre::BspSceneNode::BspSceneNode | ( | SceneManager * | creator,
|  | const String & | name
| ) |

| Definition at line 50 of file OgreBspSceneNode.h. References Ogre::String.

## Member Function Documentation

void Ogre::SceneNode::_addBoundingBoxToQueue | ( | RenderQueue * | queue | ) | `[virtual, inherited]`

| Add the bounding box to the rendering queue. Definition at line 282 of file OgreSceneNode.cpp. References Ogre::RenderQueue::addRenderable(), Ogre::SceneNode::mWireBoundingBox, Ogre::SceneNode::mWorldAABB, and Ogre::WireBoundingBox::setupBoundingBox(). Referenced by Ogre::SceneNode::_findVisibleObjects(), Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::OctreeSceneManager::walkOctree().

void Ogre::SceneNode::_autoTrack | ( | void |  | ) | `[inherited]`

| Internal method used by OGRE to update auto-tracking cameras. Definition at line 514 of file OgreSceneNode.cpp. References Ogre::Node::_getDerivedPosition(), Ogre::SceneNode::_update(), Ogre::SceneNode::lookAt(), Ogre::SceneNode::mAutoTrackLocalDirection, Ogre::SceneNode::mAutoTrackOffset, Ogre::SceneNode::mAutoTrackTarget, and Ogre::Node::TS_WORLD.

void Ogre::SceneNode::_findVisibleObjects | ( | Camera * | cam,
|  | RenderQueue * | queue,
|  | bool | includeChildren = true,
|  | bool | displayNodes = false,
|  | bool | onlyShadowCasters = false
| ) | `[virtual, inherited]`

Internal method which locates any visible objects attached to this node and adds them to the passed in queue.

Remarks:
  Should only be called by a SceneManager implementation, and only after the _updat method has been called to ensure transforms and world bounds are up to date. SceneManager implementations can choose to let the search cascade automatically, or choose to prevent this and select nodes themselves based on some other criteria.

Parameters:

  cam | The active camera
  queue | The SceneManager's rendering queue
  includeChildren | If true, the call is cascaded down to all child nodes automatically.
  displayNodes | If true, the nodes themselves are rendered as a set of 3 axes as well as the objects being rendered. For debugging purposes.

Definition at line 233 of file OgreSceneNode.cpp.

References Ogre::SceneNode::_addBoundingBoxToQueue(), Ogre::RenderQueue::addRenderable(), Ogre::SceneManager::getShowBoundingBoxes(), Ogre::Frustum::isVisible(), Ogre::Node::mChildren, Ogre::SceneNode::mCreator, Ogre::SceneNode::mObjectsByName, Ogre::SceneNode::mShowBoundingBox, and Ogre::SceneNode::mWorldAABB.

Referenced by Ogre::SceneManager::_findVisibleObjects(), and Ogre::Overlay::_findVisibleObjects().

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(), Ogre::Bone::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(), Ogre::Bone::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().

AxisAlignedBox Ogre::SceneNode::_getWorldAABB | ( | void |  | ) | const`[virtual, inherited]`

Gets the axis-aligned bounding box of this node (and hence all subnodes).

Remarks:
  Recommended only if you are extending a SceneManager, because the bounding box returned from this method is only up to date after the SceneManager has called _update.

Definition at line 313 of file OgreSceneNode.cpp.

References Ogre::SceneNode::mWorldAABB.

void Ogre::BspSceneNode::_update | ( | bool | updateChildren,
|  | bool | parentHasChanged
| ) | `[virtual]`

| Overridden from Node. Reimplemented from Ogre::SceneNode. Definition at line 31 of file OgreBspSceneNode.cpp. References Ogre::Node::mNeedParentUpdate, and Ogre::SceneNode::mObjectsByName.

void Ogre::SceneNode::_updateBounds | ( | void |  | ) | `[protected, virtual, inherited]`

| Tells the SceneNode to update the world bound info it stores. Reimplemented in Ogre::OctreeNode. Definition at line 210 of file OgreSceneNode.cpp. References Ogre::Node::mChildren, Ogre::AxisAlignedBox::merge(), Ogre::SceneNode::mObjectsByName, Ogre::SceneNode::mWorldAABB, and Ogre::AxisAlignedBox::setNull(). Referenced by Ogre::SceneNode::_update().

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(), Ogre::Bone::createChild(), Ogre::SkeletonInstance::createTagPointOnBone(), and Ogre::SkeletonSerializer::readBoneParent().

void Ogre::SceneNode::attachObject | ( | MovableObject * | obj | ) | `[virtual, inherited]`

Adds an instance of a scene object to this node.

Remarks:
  Scene objects can include Entity objects, Camera objects, Light objects, ParticleSystem objects etc. Anything that subclasses from MovableObject.

Definition at line 80 of file OgreSceneNode.cpp.

References Ogre::MovableObject::_notifyAttached(), Ogre::MovableObject::getName(), Ogre::SceneNode::mObjectsByName, and Ogre::Node::needUpdate().

Referenced by Ogre::TerrainPageSource::buildPage(), Ogre::OverlayManager::parseNewMesh(), Ogre::SceneManager::setSkyBox(), Ogre::SceneManager::setSkyDome(), and Ogre::SceneManager::setSkyPlane().

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

Node * Ogre::SceneNode::createChildImpl | ( | const String & | name | ) | `[protected, virtual, inherited]`

| See Node. Implements Ogre::Node. Definition at line 307 of file OgreSceneNode.cpp. References Ogre::SceneManager::createSceneNode(), Ogre::SceneNode::mCreator, and Ogre::String.

Node * Ogre::SceneNode::createChildImpl | ( | void |  | ) | `[protected, virtual, inherited]`

| See Node. Implements Ogre::Node. Definition at line 301 of file OgreSceneNode.cpp. References Ogre::SceneManager::createSceneNode(), and Ogre::SceneNode::mCreator.

SceneNode * Ogre::SceneNode::createChildSceneNode | ( | const String & | name,
|  | const Vector3 & | translate = Vector3::ZERO,
|  | const Quaternion & | rotate = Quaternion::IDENTITY
| ) | `[virtual, inherited]`

Creates a new named SceneNode 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 367 of file OgreSceneNode.cpp.

References Ogre::Node::createChild(), and Ogre::String.

SceneNode * Ogre::SceneNode::createChildSceneNode | ( | const Vector3 & | translate = Vector3::ZERO,
|  | const Quaternion & | rotate = Quaternion::IDENTITY
| ) | `[virtual, inherited]`

Creates an unnamed new SceneNode 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 361 of file OgreSceneNode.cpp.

References Ogre::Node::createChild().

Referenced by Ogre::TerrainPageSource::buildPage().

void Ogre::BspSceneNode::detachAllObjects | ( | void |  | ) | `[virtual]`

| Detaches all objects attached to this node. Reimplemented from Ogre::SceneNode. Definition at line 76 of file OgreBspSceneNode.cpp. References Ogre::SceneNode::mObjectsByName.

void Ogre::SceneNode::detachObject | ( | MovableObject * | obj | ) | `[virtual, inherited]`

| Detaches an object by pointer. Definition at line 177 of file OgreSceneNode.cpp. References Ogre::MovableObject::_notifyAttached(), Ogre::SceneNode::mObjectsByName, and Ogre::Node::needUpdate().

MovableObject * Ogre::BspSceneNode::detachObject | ( | const String & | name | ) | `[virtual]`

| Detaches the named object from this node and returns a pointer to it. Reimplemented from Ogre::SceneNode. Definition at line 69 of file OgreBspSceneNode.cpp. References Ogre::String.

MovableObject * Ogre::BspSceneNode::detachObject | ( | unsigned short | index | ) | `[virtual]`

Detaches the indexed object from this scene node.

Remarks:
  Detaches by index, see the alternate version to detach by name. Object indexes may change as other objects are added / removed.

Reimplemented from Ogre::SceneNode.

Definition at line 61 of file OgreBspSceneNode.cpp.

const LightList & Ogre::SceneNode::findLights | ( | Real | radius | ) | const`[inherited]`

Allows retrieval of the nearest lights to the centre of this SceneNode.

Remarks:
  This method allows a list of lights, ordered by proximity to the centre of this SceneNode, to be retrieved. Multiple access to this method when neither the node nor the lights have moved will result in the same list being returned without recalculation. Can be useful when implementing Renderable::getLights.

Parameters:

  radius | Optional parameter to specify lights intersecting a given radius of this SceneNode's centre.

Definition at line 373 of file OgreSceneNode.cpp.

References Ogre::SceneManager::_populateLightList(), Ogre::LightList, Ogre::SceneNode::mCreator, Ogre::SceneNode::mLightList, Ogre::SceneNode::mLightListDirty, and Ogre::Real.

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

void Ogre::SceneNode::flipVisibility | ( | bool | cascade = true | ) | `[inherited]`

Inverts the visibility of all objects attached to this node.

Remarks:
  This is a shortcut to calling setVisible(!isVisible()) on the objects attached to this node, and optionally to all objects attached to child nodes.

Parameters:

  cascade | If true, this setting cascades into child nodes too.

Definition at line 551 of file OgreSceneNode.cpp.

References Ogre::Node::mChildren, and Ogre::SceneNode::mObjectsByName.

MovableObject * Ogre::SceneNode::getAttachedObject | ( | const String & | name | ) | `[virtual, inherited]`

Retrieves a pointer to an attached object.

Remarks:
  Retrieves by object name, see alternate version to retrieve by index.

Definition at line 116 of file OgreSceneNode.cpp.

References Except, Ogre::SceneNode::mObjectsByName, and Ogre::String.

MovableObject * Ogre::SceneNode::getAttachedObject | ( | unsigned short | index | ) | `[virtual, inherited]`

Retrieves a pointer to an attached object.

Remarks:
  Retrieves by index, see alternate version to retrieve by name. The index of an object may change as other objects are added / removed.

Definition at line 99 of file OgreSceneNode.cpp.

References Except, and Ogre::SceneNode::mObjectsByName.

SceneNode::ObjectIterator Ogre::SceneNode::getAttachedObjectIterator | ( | void |  | ) | `[virtual, inherited]`

Retrieves an iterator which can be used to efficiently step through the objects attached to this node.

Remarks:
  This is a much faster way to go through all the objects attached to the node than using getAttachedObject. But the iterator returned is only valid until a change is made to the collection (ie an addition or removal) so treat the returned iterator as transient, and don't add / remove items as you go through the iterator, save changes until the end, or retrieve a new iterator after making the change. Making changes to the object returned through the iterator is OK though.

Definition at line 318 of file OgreSceneNode.cpp.

References Ogre::SceneNode::mObjectsByName, and Ogre::SceneNode::ObjectIterator.

const Vector3& Ogre::SceneNode::getAutoTrackLocalDirection | ( | void |  | ) | `[inherited]`

| Get the auto tracking local direction for this node, if it is auto tracking. Definition at line 366 of file OgreSceneNode.h.

const Vector3& Ogre::SceneNode::getAutoTrackOffset | ( | void |  | ) | `[inherited]`

| Get the auto tracking offset for this node, if the node is auto tracking. Definition at line 364 of file OgreSceneNode.h.

SceneNode* Ogre::SceneNode::getAutoTrackTarget | ( | void |  | ) | `[inherited]`

| Get the auto tracking target for this node, if any. Definition at line 362 of file OgreSceneNode.h. Referenced by Ogre::SceneManager::destroySceneNode().

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

SceneManager * Ogre::SceneNode::getCreator | ( | void |  | ) | const`[inherited]`

Gets the creator of this scene node.

Remarks:
  This method returns the SceneManager which created this node. This can be useful for destroying this node.

Definition at line 323 of file OgreSceneNode.cpp.

References Ogre::SceneNode::mCreator.

Referenced by Ogre::SceneNode::removeAndDestroyAllChildren(), and Ogre::SceneNode::removeAndDestroyChild().

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.

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

SceneNode * Ogre::SceneNode::getParentSceneNode | ( | void |  | ) | const`[inherited]`

| Gets the parent of this SceneNode. Definition at line 526 of file OgreSceneNode.cpp. References Ogre::Node::getParent().

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

bool Ogre::SceneNode::getShowBoundingBox | ( |  | ) | const`[virtual, inherited]`

This allows scene managers to determine if the node's bounding box should be added to the rendering queue.

Remarks:
  Scene Managers that implement their own _findVisibleObjects will have to check this flag and then use _addBoundingBoxToQueue to add the bounding box wireframe.

Definition at line 295 of file OgreSceneNode.cpp.

References Ogre::SceneNode::mShowBoundingBox.

Referenced by Ogre::BspSceneManager::processVisibleLeaf(), and Ogre::OctreeSceneManager::walkOctree().

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

void Ogre::SceneNode::lookAt | ( | const Vector3 & | targetPoint,
|  | TransformSpace | relativeTo,
|  | const Vector3 & | localDirectionVector = Vector3::NEGATIVE_UNIT_Z
| ) | `[inherited]`

Points the local -Z direction of this node at a point in space.

Parameters:

  targetPoint | A vector specifying the look at point.
  relativeTo | The space in which the point resides
  localDirectionVector | The vector which normally describes the natural direction of the node, usually -Z

Definition at line 507 of file OgreSceneNode.cpp.

References Ogre::Node::_getDerivedPosition(), and Ogre::SceneNode::setDirection().

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

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 Ogre::Bone::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::SceneNode::numAttachedObjects | ( | void |  | ) | const`[virtual, inherited]`

| Reports the number of objects attached to this node. Definition at line 94 of file OgreSceneNode.cpp. References Ogre::SceneNode::mObjectsByName.

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

void Ogre::SceneNode::removeAndDestroyAllChildren | ( | void |  | ) | `[virtual, inherited]`

Removes and destroys all children of this node.

Remarks:
  Use this to destroy all child nodes of this node and remove them from the scene graph. Note that all objects attached to this node will be detached but will not be destroyed.

Definition at line 347 of file OgreSceneNode.cpp.

References Ogre::SceneManager::destroySceneNode(), Ogre::SceneNode::getCreator(), Ogre::Node::getName(), Ogre::Node::mChildren, and Ogre::Node::needUpdate().

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

void Ogre::SceneNode::removeAndDestroyChild | ( | unsigned short | index | ) | `[virtual, inherited]`

This method removes and destroys the child and all of its children.

Remarks:
  Unlike removeChild, which removes a single named child from this node but does not destroy it, this method destroys the child and all of it's children.

  Use this if you wish to recursively destroy a node as well as detaching it from it's parent. Note that any objects attached to the nodes will be detached but will not themselves be destroyed.

Definition at line 338 of file OgreSceneNode.cpp.

References Ogre::SceneManager::destroySceneNode(), Ogre::Node::getChild(), Ogre::SceneNode::getCreator(), Ogre::Node::getName(), Ogre::SceneNode::removeAndDestroyAllChildren(), and Ogre::Node::removeChild().

void Ogre::SceneNode::removeAndDestroyChild | ( | const String & | name | ) | `[virtual, inherited]`

This method removes and destroys the named child and all of its children.

Remarks:
  Unlike removeChild, which removes a single named child from this node but does not destroy it, this method destroys the child and all of it's children.

  Use this if you wish to recursively destroy a node as well as detaching it from it's parent. Note that any objects attached to the nodes will be detached but will not themselves be destroyed.

Definition at line 328 of file OgreSceneNode.cpp.

References Ogre::SceneManager::destroySceneNode(), Ogre::Node::getChild(), Ogre::SceneNode::getCreator(), Ogre::SceneNode::removeAndDestroyAllChildren(), Ogre::Node::removeChild(), and Ogre::String.

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::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 Ogre::Bone::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(), Ogre::Bone::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::SceneNode::setAutoTracking | ( | bool | enabled,
|  | SceneNode * | target = 0,
|  | const Vector3 & | localDirectionVector = Vector3::NEGATIVE_UNIT_Z,
|  | const Vector3 & | offset = Vector3::ZERO
| ) | `[inherited]`

Enables / disables automatic tracking of another SceneNode.

Remarks:
  If you enable auto-tracking, this SceneNode will automatically rotate to point it's -Z at the target SceneNode every frame, no matter how it or the other SceneNode move. Note that by default the -Z points at the origin of the target SceneNode, if you want to tweak this, provide a vector in the 'offset' parameter and the target point will be adjusted.

Parameters:

  enabled | If true, tracking will be enabled and the next parameter cannot be null. If false tracking will be disabled and the current orientation will be maintained.
  target | Pointer to the SceneNode to track. Make sure you don't delete this SceneNode before turning off tracking (e.g. SceneManager::clearScene will delete it so be careful of this). Can be null if and only if the enabled param is false.
  localDirectionVector | The local vector considered to be the usual 'direction' of the node; normally the local -Z but can be another direction.
  offset | If supplied, this is the target point in local space of the target node instead of the origin of the target node. Good for fine tuning the look at point.

Definition at line 391 of file OgreSceneNode.cpp.

References Ogre::SceneManager::_notifyAutotrackingSceneNode(), Ogre::SceneNode::mAutoTrackLocalDirection, Ogre::SceneNode::mAutoTrackOffset, Ogre::SceneNode::mAutoTrackTarget, and Ogre::SceneNode::mCreator.

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

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::SceneNode::setDirection | ( | const Vector3 & | vec,
|  | TransformSpace | relativeTo = TS_LOCAL,
|  | const Vector3 & | localDirectionVector = Vector3::NEGATIVE_UNIT_Z
| ) | `[inherited]`

Sets the node's direction vector ie it's local -z.

Remarks:
  Note that the 'up' vector for the orientation will automatically be recalculated based on the current 'up' vector (i.e. the roll will remain the same). If you need more control, use setOrientation.

Parameters:

  vec | The direction vector
  relativeTo | The space in which this direction vector is expressed
  localDirectionVector | The vector which normally describes the natural direction of the node, usually -Z

Definition at line 436 of file OgreSceneNode.cpp.

References Ogre::Node::_getDerivedOrientation(), Ogre::Vector3::crossProduct(), Ogre::Quaternion::FromAngleAxis(), Ogre::Quaternion::FromAxes(), Ogre::Node::getOrientation(), Ogre::Vector3::getRotationTo(), Ogre::Quaternion::Inverse(), Ogre::Node::mOrientation, Ogre::Node::mParent, Ogre::SceneNode::mYawFixedAxis, Ogre::Vector3::normalise(), Ogre::Quaternion::ToAxes(), Ogre::Node::TS_LOCAL, Ogre::Node::TS_PARENT, and Ogre::Node::TS_WORLD.

void Ogre::SceneNode::setDirection | ( | Real | x,
|  | Real | y,
|  | Real | z,
|  | TransformSpace | relativeTo = TS_LOCAL,
|  | const Vector3 & | localDirectionVector = Vector3::NEGATIVE_UNIT_Z
| ) | `[inherited]`

Sets the node's direction vector ie it's local -z.

Remarks:
  Note that the 'up' vector for the orientation will automatically be recalculated based on the current 'up' vector (i.e. the roll will remain the same). If you need more control, use setOrientation.

Parameters:

  x,y,z | The components of the direction vector
  relativeTo | The space in which this direction vector is expressed
  localDirectionVector | The vector which normally describes the natural direction of the node, usually -Z

Definition at line 429 of file OgreSceneNode.cpp.

References Ogre::Real.

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

void Ogre::SceneNode::setFixedYawAxis | ( | bool | useFixed,
|  | const Vector3 & | fixedAxis = Vector3::UNIT_Y
| ) | `[inherited]`

Tells the node whether to yaw around it's own local Y axis or a fixed axis of choice.

Remarks:
  This method allows you to change the yaw behaviour of the node - by default, it yaws around it's own local Y axis when told to yaw with TS_LOCAL, this makes it yaw around a fixed axis. You only really need this when you're using auto tracking (see setAutoTracking, because when you're manually rotating a node you can specify the TransformSpace in which you wish to work anyway.

Parameters:

  useFixed | If true, the axis passed in the second parameter will always be the yaw axis no matter what the node orientation. If false, the node returns to it's default behaviour.
  fixedAxis | The axis to use if the first parameter is true.

Definition at line 409 of file OgreSceneNode.cpp.

References Ogre::SceneNode::mYawFixed, and Ogre::SceneNode::mYawFixedAxis.

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 Ogre::Bone::setBindingPose().

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::SceneNode::setVisible | ( | bool | visible,
|  | bool | cascade = true
| ) | `[inherited]`

Makes all objects attached to this node become visible / invisble.

Remarks:
  This is a shortcut to calling setVisible() on the objects attached to this node, and optionally to all objects attached to child nodes.

Parameters:

  visible | Whether the objects are to be made visible or invisible
  cascade | If true, this setting cascades into child nodes too.

Definition at line 531 of file OgreSceneNode.cpp.

References Ogre::Node::mChildren, and Ogre::SceneNode::mObjectsByName.

void Ogre::SceneNode::showBoundingBox | ( | bool | bShow | ) | `[virtual, inherited]`

Allows the showing of the node's bounding box.

Remarks:
  Use this to show or hide the bounding box of the node.

Definition at line 291 of file OgreSceneNode.cpp.

References Ogre::SceneNode::mShowBoundingBox.

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(), Ogre::Bone::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::SceneNode::yaw | ( | const Radian & | angle,
|  | TransformSpace | relativeTo = TS_LOCAL
| ) | `[virtual, inherited]`

| Rotate the node around the Y-axis. Reimplemented from Ogre::Node. Definition at line 416 of file OgreSceneNode.cpp. References Ogre::SceneNode::mYawFixedAxis, and 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().

Vector3 Ogre::SceneNode::mAutoTrackLocalDirection`[protected, inherited]`

| Local 'normal' direction vector. Definition at line 87 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_autoTrack(), and Ogre::SceneNode::setAutoTracking().

Vector3 Ogre::SceneNode::mAutoTrackOffset`[protected, inherited]`

| Tracking offset for fine tuning. Definition at line 85 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_autoTrack(), and Ogre::SceneNode::setAutoTracking().

SceneNode* Ogre::SceneNode::mAutoTrackTarget`[protected, inherited]`

| Auto tracking target. Definition at line 83 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_autoTrack(), and Ogre::SceneNode::setAutoTracking().

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

SceneManager* Ogre::SceneNode::mCreator`[protected, inherited]`

| SceneManager which created this node. Definition at line 62 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_findVisibleObjects(), Ogre::SceneNode::createChildImpl(), Ogre::SceneNode::findLights(), Ogre::SceneNode::getCreator(), and Ogre::SceneNode::setAutoTracking().

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

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

LightList Ogre::SceneNode::mLightList`[protected, inherited]`

| Definition at line 53 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::findLights().

bool Ogre::SceneNode::mLightListDirty`[protected, inherited]`

| Definition at line 54 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_update(), and Ogre::SceneNode::findLights().

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(), _update(), and Ogre::Node::needUpdate().

ObjectMap Ogre::SceneNode::mObjectsByName`[protected, inherited]`

Definition at line 52 of file OgreSceneNode.h.

Referenced by Ogre::OctreeNode::_addToRenderQueue(), Ogre::SceneNode::_findVisibleObjects(), _update(), Ogre::SceneNode::_updateBounds(), Ogre::OctreeNode::_updateBounds(), Ogre::SceneNode::attachObject(), Ogre::SceneNode::detachAllObjects(), detachAllObjects(), Ogre::SceneNode::detachObject(), Ogre::SceneNode::flipVisibility(), Ogre::SceneNode::getAttachedObject(), Ogre::SceneNode::getAttachedObjectIterator(), Ogre::SceneNode::numAttachedObjects(), Ogre::SceneNode::setVisible(), and Ogre::SceneNode::~SceneNode().

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.

bool Ogre::SceneNode::mShowBoundingBox`[protected, inherited]`

| Flag that determines if the bounding box of the node should be displayed. Definition at line 59 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_findVisibleObjects(), Ogre::SceneNode::getShowBoundingBox(), and Ogre::SceneNode::showBoundingBox().

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

WireBoundingBox* Ogre::SceneNode::mWireBoundingBox`[protected, inherited]`

| Pointer to a Wire Bounding Box for this Node. Definition at line 57 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_addBoundingBoxToQueue(), and Ogre::SceneNode::~SceneNode().

AxisAlignedBox Ogre::SceneNode::mWorldAABB`[protected, inherited]`

| World-Axis aligned bounding box, updated only through _update. Definition at line 65 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::_addBoundingBoxToQueue(), Ogre::SceneNode::_findVisibleObjects(), Ogre::SceneNode::_getWorldAABB(), Ogre::OctreeNode::_isIn(), Ogre::SceneNode::_updateBounds(), and Ogre::OctreeNode::_updateBounds().

bool Ogre::SceneNode::mYawFixed`[protected, inherited]`

| Whether to yaw around a fixed axis. Definition at line 78 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::setFixedYawAxis().

Vector3 Ogre::SceneNode::mYawFixedAxis`[protected, inherited]`

| Fixed axis to yaw around. Definition at line 80 of file OgreSceneNode.h. Referenced by Ogre::SceneNode::setDirection(), Ogre::SceneNode::setFixedYawAxis(), and Ogre::SceneNode::yaw().

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

- OgreBspSceneNode.h
- OgreBspSceneNode.cpp

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