![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
Class representing a general-purpose OldNode an articulated scene graph. More...
#include <OgreOldNode.h>
Classes | |
class | Listener |
Listener which gets called back on OldNode events. More... | |
Public Types | |
typedef MapIterator< ChildOldNodeMap > | ChildOldNodeIterator |
typedef unordered_map< String, OldNode * >::type | ChildOldNodeMap |
typedef ConstMapIterator< ChildOldNodeMap > | ConstChildOldNodeIterator |
enum | TransformSpace { TS_LOCAL , TS_PARENT , TS_WORLD } |
Enumeration denoting the spaces which a transform can be relative to. More... | |
Public Member Functions | |
OldNode () | |
Constructor, should only be called by parent, not directly. | |
OldNode (const String &name) | |
Constructor, should only be called by parent, not directly. | |
virtual | ~OldNode () |
virtual const Quaternion & | _getDerivedOrientation () const |
Gets the orientation of the OldNode as derived from all parents. | |
virtual const Vector3 & | _getDerivedPosition () const |
Gets the position of the OldNode as derived from all parents. | |
virtual const Vector3 & | _getDerivedScale () const |
Gets the scaling factor of the OldNode as derived from all parents. | |
virtual const Matrix4 & | _getFullTransform () const |
Gets the full transformation matrix for this OldNode. | |
virtual void | _setDerivedOrientation (const Quaternion &q) |
Sets the final world orientation of the OldNode directly. | |
virtual void | _setDerivedPosition (const Vector3 &pos) |
Sets the final world position of the OldNode directly. | |
virtual void | _update (bool updateChildren, bool parentHasChanged) |
Internal method to update the OldNode. | |
virtual void | addChild (OldNode *child) |
Adds a (precreated) child scene OldNode to this OldNode. | |
virtual void | cancelUpdate (OldNode *child) |
Called by children to notify their parent that they no longer need an update. | |
virtual Quaternion | convertLocalToWorldOrientation (const Quaternion &localOrientation) |
Gets the world orientation of an orientation in the OldNode local space useful for simple transforms that don't require a child OldNode. | |
virtual Vector3 | convertLocalToWorldPosition (const Vector3 &localPos) |
Gets the world position of a point in the OldNode local space useful for simple transforms that don't require a child OldNode. | |
virtual Quaternion | convertWorldToLocalOrientation (const Quaternion &worldOrientation) |
Gets the local orientation, relative to this OldNode, of the given world-space orientation. | |
virtual Vector3 | convertWorldToLocalPosition (const Vector3 &worldPos) |
Gets the local position, relative to this OldNode, of the given world-space position. | |
virtual OldNode * | createChild (const String &name, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY) |
Creates a new named OldNode as a child of this OldNode. | |
virtual OldNode * | createChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY) |
Creates an unnamed new OldNode as a child of this OldNode. | |
virtual OldNode * | getChild (const String &name) const |
Gets a pointer to a named child OldNode. | |
virtual OldNode * | getChild (unsigned short index) const |
Gets a pointer to a child OldNode. | |
virtual ChildOldNodeIterator | getChildIterator () |
Retrieves an iterator for efficiently looping through all children of this OldNode. | |
virtual ConstChildOldNodeIterator | getChildIterator () const |
Retrieves an iterator for efficiently looping through all children of this OldNode. | |
virtual bool | getInheritOrientation () const |
Returns true if this OldNode is affected by orientation applied to the parent OldNode. | |
virtual bool | getInheritScale () const |
Returns true if this OldNode is affected by scaling factors applied to the parent OldNode. | |
virtual const Quaternion & | getInitialOrientation () const |
Gets the initial orientation of this OldNode, see setInitialState for more info. | |
virtual const Vector3 & | getInitialPosition () const |
Gets the initial position of this OldNode, see setInitialState for more info. | |
virtual const Vector3 & | getInitialScale () const |
Gets the initial position of this OldNode, see setInitialState for more info. | |
virtual Listener * | getListener () const |
Gets the current listener for this OldNode. | |
virtual Matrix3 | getLocalAxes () const |
Gets a matrix whose columns are the local axes based on the OldNodes orientation relative to it's parent. | |
const String & | getName () const |
Returns the name of the OldNode. | |
virtual const Quaternion & | getOrientation () const |
Returns a quaternion representing the OldNodes orientation. | |
virtual OldNode * | getParent () const |
Gets this OldNode's parent (NULL if this is the root). | |
virtual const Vector3 & | getPosition () const |
Gets the position of the OldNode relative to it's parent. | |
virtual const Vector3 & | getScale () const |
Gets the scaling factor of this OldNode. | |
virtual Real | getSquaredViewDepth (const Camera *cam) const |
Helper function, get the squared view depth. | |
virtual const Any & | getUserAny () const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. | |
virtual void | needUpdate (bool forceParentUpdate=false) |
To be called in the event of transform changes to this OldNode that require it's recalculation. | |
virtual unsigned short | numChildren () const |
Reports the number of child OldNodes under this one. | |
virtual void | pitch (const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the OldNode around the X-axis. | |
virtual void | removeAllChildren () |
Removes all child OldNodes attached to this OldNode. | |
virtual OldNode * | removeChild (const String &name) |
Drops the named child from this OldNode. | |
virtual OldNode * | removeChild (OldNode *child) |
Drops the specified child from this OldNode. | |
virtual OldNode * | removeChild (unsigned short index) |
Drops the specified child from this OldNode. | |
virtual void | requestUpdate (OldNode *child, bool forceParentUpdate=false) |
Called by children to notify their parent that they need an update. | |
virtual void | resetOrientation () |
Resets the OldNodes orientation (local axes as world axes, no rotation). | |
virtual void | resetToInitialState () |
Resets the position / orientation / scale of this OldNode to it's initial state, see setInitialState for more info. | |
virtual void | roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the OldNode around the Z-axis. | |
virtual void | rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL) |
Rotate the OldNode around an arbitrary axis using a Quarternion. | |
virtual void | rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the OldNode around an arbitrary axis. | |
virtual void | scale (const Vector3 &scale) |
Scales the OldNode, combining it's current scale with the passed in scaling factor. | |
virtual void | scale (Real x, Real y, Real z) |
Scales the OldNode, combining it's current scale with the passed in scaling factor. | |
virtual void | setInheritOrientation (bool inherit) |
Tells the OldNode whether it should inherit orientation from it's parent OldNode. | |
virtual void | setInheritScale (bool inherit) |
Tells the OldNode whether it should inherit scaling factors from it's parent OldNode. | |
virtual void | setInitialState () |
Sets the current transform of this OldNode to be the 'initial state' ie that position / orientation / scale to be used as a basis for delta values used in keyframe animation. | |
virtual void | setListener (Listener *listener) |
Sets a listener for this OldNode. | |
virtual void | setOrientation (const Quaternion &q) |
Sets the orientation of this OldNode via a quaternion. | |
virtual void | setOrientation (Real w, Real x, Real y, Real z) |
Sets the orientation of this OldNode via quaternion parameters. | |
virtual void | setPosition (const Vector3 &pos) |
Sets the position of the OldNode relative to it's parent. | |
virtual void | setPosition (Real x, Real y, Real z) |
Sets the position of the OldNode relative to it's parent. | |
virtual void | setScale (const Vector3 &scale) |
Sets the scaling factor applied to this OldNode. | |
virtual void | setScale (Real x, Real y, Real z) |
Sets the scaling factor applied to this OldNode. | |
virtual void | setUserAny (const Any &anything) |
virtual void | translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT) |
Moves the OldNode along arbitrary axes. | |
virtual void | translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT) |
Moves the OldNode along arbitrary axes. | |
virtual void | translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT) |
Moves the OldNode along the Cartesian axes. | |
virtual void | translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT) |
Moves the OldNode along the Cartesian axes. | |
virtual void | yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the OldNode around the Y-axis. | |
Static Public Member Functions | |
static void | processQueuedUpdates () |
Process queued 'needUpdate' calls. | |
static void | queueNeedUpdate (OldNode *n) |
Queue a 'needUpdate' call to a OldNode safely. | |
Class representing a general-purpose OldNode an articulated scene graph.
typedef unordered_map<String,OldNode*>::type Ogre::v1::OldNode::ChildOldNodeMap |
Ogre::v1::OldNode::OldNode | ( | ) |
Constructor, should only be called by parent, not directly.
Referenced by addChild(), cancelUpdate(), createChild(), createChild(), getChild(), getChild(), getParent(), Ogre::v1::OldBone::needUpdate(), Ogre::v1::OldNode::Listener::OldNodeAttached(), Ogre::v1::OldNode::Listener::OldNodeDestroyed(), Ogre::v1::OldNode::Listener::OldNodeDetached(), Ogre::v1::OldNode::Listener::OldNodeUpdated(), queueNeedUpdate(), removeChild(), removeChild(), removeChild(), and requestUpdate().
Ogre::v1::OldNode::OldNode | ( | const String & | name | ) |
Constructor, should only be called by parent, not directly.
|
virtual |
|
virtual |
Gets the orientation of the OldNode as derived from all parents.
|
virtual |
Gets the position of the OldNode as derived from all parents.
|
virtual |
Gets the scaling factor of the OldNode as derived from all parents.
|
virtual |
Gets the full transformation matrix for this OldNode.
|
virtual |
Sets the final world orientation of the OldNode directly.
|
virtual |
Sets the final world position of the OldNode directly.
|
virtual |
Internal method to update the OldNode.
updateChildren | If true , the update cascades down to all children. Specify false if you wish to update children separately, e.g. because of a more selective SceneManager implementation. |
parentHasChanged | This flag indicates that the parent transform has changed, so the child should retrieve the parent's transform and combine it with its own even if it hasn't changed itself. |
|
virtual |
|
virtual |
Called by children to notify their parent that they no longer need an update.
References OldNode().
|
virtual |
|
virtual |
Gets the local orientation, relative to this OldNode, of the given world-space orientation.
Gets the local position, relative to this OldNode, of the given world-space position.
|
virtual |
Creates a new named OldNode as a child of this OldNode.
translate | Initial translation offset of child relative to parent |
rotate | Initial rotation relative to parent |
References OldNode(), Ogre::Quaternion::IDENTITY, rotate(), translate(), and Ogre::Vector3::ZERO.
|
virtual |
Creates an unnamed new OldNode as a child of this OldNode.
translate | Initial translation offset of child relative to parent |
rotate | Initial rotation relative to parent |
References OldNode(), Ogre::Quaternion::IDENTITY, rotate(), translate(), and Ogre::Vector3::ZERO.
|
virtual |
|
virtual |
Retrieves an iterator for efficiently looping through all children of this OldNode.
|
virtual |
Retrieves an iterator for efficiently looping through all children of this OldNode.
|
virtual |
Returns true if this OldNode is affected by orientation applied to the parent OldNode.
|
virtual |
|
virtual |
Gets the initial orientation of this OldNode, see setInitialState for more info.
|
virtual |
Gets the initial position of this OldNode, see setInitialState for more info.
|
virtual |
Gets the initial position of this OldNode, see setInitialState for more info.
|
inlinevirtual |
Gets the current listener for this OldNode.
|
virtual |
Gets a matrix whose columns are the local axes based on the OldNodes orientation relative to it's parent.
|
virtual |
Returns a quaternion representing the OldNodes orientation.
|
virtual |
|
virtual |
Gets the position of the OldNode relative to it's parent.
|
virtual |
Gets the scaling factor of this OldNode.
Helper function, get the squared view depth.
|
inlinevirtual |
References getUserObjectBindings().
|
inline |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
Referenced by getUserAny(), and setUserAny().
|
inline |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
|
virtual |
To be called in the event of transform changes to this OldNode that require it's recalculation.
forceParentUpdate | Even if the OldNode thinks it has already told it's parent, tell it anyway |
Reimplemented in Ogre::v1::OldBone, and Ogre::v1::TagPoint.
|
virtual |
Reports the number of child OldNodes under this one.
|
virtual |
|
static |
Process queued 'needUpdate' calls.
|
static |
Queue a 'needUpdate' call to a OldNode safely.
References OldNode().
|
virtual |
Removes all child OldNodes attached to this OldNode.
Does not delete the OldNodes, just detaches them from this parent, potentially to be reattached elsewhere.
|
virtual |
|
virtual |
|
virtual |
Resets the OldNodes orientation (local axes as world axes, no rotation).
|
virtual |
Resets the position / orientation / scale of this OldNode to it's initial state, see setInitialState for more info.
|
virtual |
|
virtual |
|
virtual |
Rotate the OldNode around an arbitrary axis.
References TS_LOCAL.
Referenced by Ogre::v1::OldBone::createChild(), createChild(), and createChild().
|
virtual |
Scales the OldNode, combining it's current scale with the passed in scaling factor.
References scale().
Referenced by scale(), and setScale().
Scales the OldNode, combining it's current scale with the passed in scaling factor.
|
virtual |
Tells the OldNode whether it should inherit orientation from it's parent OldNode.
inherit | If true, this OldNode's orientation will be affected by its parent's orientation. If false, it will not be affected. |
|
virtual |
Tells the OldNode whether it should inherit scaling factors from it's parent OldNode.
inherit | If true, this OldNode's scale will be affected by its parent's scale. If false, it will not be affected. |
|
virtual |
Sets the current transform of this OldNode to be the 'initial state' ie that position / orientation / scale to be used as a basis for delta values used in keyframe animation.
|
inlinevirtual |
|
virtual |
Sets the orientation of this OldNode via a quaternion.
Sets the orientation of this OldNode via quaternion parameters.
|
virtual |
Sets the position of the OldNode relative to it's parent.
Sets the position of the OldNode relative to it's parent.
|
virtual |
Sets the scaling factor applied to this OldNode.
References scale().
Sets the scaling factor applied to this OldNode.
|
inlinevirtual |
References getUserObjectBindings().
|
virtual |
Moves the OldNode along arbitrary axes.
axes | A 3x3 Matrix containing 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as: 1 0 0 0 1 0 0 0 1i.e. the identity matrix. |
move | Vector relative to the axes above. |
relativeTo | The space which this transform is relative to. |
References TS_PARENT.
|
virtual |
Moves the OldNode along arbitrary axes.
axes | A 3x3 Matrix containing 3 column vectors each representing the axes X, Y and Z respectively. In this format the standard cartesian axes would be expressed as 1 0 0 0 1 0 0 0 1i.e. the identity matrix. |
x | The x translation component relative to the axes above. |
y | The y translation component relative to the axes above. |
z | The z translation component relative to the axes above. |
relativeTo | The space which this transform is relative to. |
References TS_PARENT.
|
virtual |
Moves the OldNode along the Cartesian axes.
d | Vector with x,y,z values representing the translation. |
relativeTo | The space which this transform is relative to. |
References TS_PARENT.
Referenced by Ogre::v1::OldBone::createChild(), createChild(), and createChild().
|
virtual |
Moves the OldNode along the Cartesian axes.
x | Real x value representing the translation. |
y | Real y value representing the translation. |
z | Real z value representing the translation. |
relativeTo | The space which this transform is relative to. |
References TS_PARENT.
|
virtual |