![]() |
OGRE
1.10.12
Object-Oriented Graphics Rendering Engine
|
A tagged point on a skeleton, which can be used to attach entities to on specific other entities. More...
#include <OgreTagPoint.h>
Public Types | |
typedef VectorIterator< ChildNodeMap > | ChildNodeIterator |
typedef vector< Node * >::type | ChildNodeMap |
typedef ConstVectorIterator< ChildNodeMap > | ConstChildNodeIterator |
enum | TransformSpace { TS_LOCAL, TS_PARENT, TS_WORLD } |
Enumeration denoting the spaces which a transform can be relative to. More... | |
Public Member Functions | |
TagPoint (unsigned short handle, Skeleton *creator) | |
const Quaternion & | _getBindingPoseInverseOrientation (void) const |
Gets the inverted binding pose orientation. More... | |
const Vector3 & | _getBindingPoseInversePosition (void) const |
Gets the inverted binding pose position. More... | |
const Vector3 & | _getBindingPoseInverseScale (void) const |
Gets the inverted binding pose scale. More... | |
const Quaternion & | _getDerivedOrientation (void) const |
Gets the orientation of the node as derived from all parents. More... | |
const Vector3 & | _getDerivedPosition (void) const |
Gets the position of the node as derived from all parents. More... | |
const Vector3 & | _getDerivedScale (void) const |
Gets the scaling factor of the node as derived from all parents. More... | |
const Matrix4 & | _getFullLocalTransform (void) const |
Gets the transform of this node just for the skeleton (not entity) More... | |
const Matrix4 & | _getFullTransform (void) const |
Gets the full transformation matrix for this node. More... | |
void | _getOffsetTransform (Matrix4 &m) const |
Gets the transform which takes bone space to current from the binding pose. More... | |
void | _setDerivedOrientation (const Quaternion &q) |
Sets the final world orientation of the node directly. More... | |
void | _setDerivedPosition (const Vector3 &pos) |
Sets the final world position of the node directly. More... | |
virtual void | _update (bool updateChildren, bool parentHasChanged) |
Internal method to update the Node. More... | |
void | addChild (Node *child) |
Adds a (precreated) child scene node to this node. More... | |
void | cancelUpdate (Node *child) |
Called by children to notify their parent that they no longer need an update. More... | |
Vector3 | convertLocalToWorldDirection (const Vector3 &localDir, bool useScale) |
Gets the world direction of a point in the node local space useful for simple transforms that don't require a child node. More... | |
Quaternion | convertLocalToWorldOrientation (const Quaternion &localOrientation) |
Gets the world orientation of an orientation in the node local space useful for simple transforms that don't require a child node. More... | |
Vector3 | convertLocalToWorldPosition (const Vector3 &localPos) |
Gets the world position of a point in the node local space useful for simple transforms that don't require a child node. More... | |
Vector3 | convertWorldToLocalDirection (const Vector3 &worldDir, bool useScale) |
Gets the local direction, relative to this node, of the given world-space direction. More... | |
Quaternion | convertWorldToLocalOrientation (const Quaternion &worldOrientation) |
Gets the local orientation, relative to this node, of the given world-space orientation. More... | |
Vector3 | convertWorldToLocalPosition (const Vector3 &worldPos) |
Gets the local position, relative to this node, of the given world-space position. More... | |
Bone * | createChild (unsigned short handle, const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY) |
Creates a new Bone as a child of this bone. More... | |
virtual Node * | createChild (const Vector3 &translate=Vector3::ZERO, const Quaternion &rotate=Quaternion::IDENTITY) |
Creates an unnamed new Node as a child of this node. More... | |
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. More... | |
Node * | getChild (unsigned short index) const |
Gets a pointer to a child node. More... | |
Node * | getChild (const String &name) const |
Gets a pointer to a named child node. More... | |
ChildNodeIterator | getChildIterator (void) |
Retrieves an iterator for efficiently looping through all children of this node. More... | |
ConstChildNodeIterator | getChildIterator (void) const |
MovableObject * | getChildObject (void) const |
const ChildNodeMap & | getChildren () const |
List of sub-nodes of this Node. More... | |
DebugRenderable * | getDebugRenderable (Real scaling) |
Get a debug renderable for rendering the Node. More... | |
unsigned short | getHandle (void) const |
Gets the numeric handle for this bone (unique within the skeleton). More... | |
bool | getInheritOrientation (void) const |
Returns true if this node is affected by orientation applied to the parent node. More... | |
bool | getInheritParentEntityOrientation (void) const |
Returns true if this TagPoint is affected by orientation applied to the parent entity. More... | |
bool | getInheritParentEntityScale (void) const |
Returns true if this TagPoint is affected by scaling factors applied to the parent entity. More... | |
bool | getInheritScale (void) const |
Returns true if this node is affected by scaling factors applied to the parent node. More... | |
const Quaternion & | getInitialOrientation (void) const |
Gets the initial orientation of this node, see setInitialState for more info. More... | |
const Vector3 & | getInitialPosition (void) const |
Gets the initial position of this node, see setInitialState for more info. More... | |
const Vector3 & | getInitialScale (void) const |
Gets the initial position of this node, see setInitialState for more info. More... | |
const LightList & | getLights (void) const |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
Listener * | getListener (void) const |
Gets the current listener for this Node. More... | |
Matrix3 | getLocalAxes (void) const |
Gets a matrix whose columns are the local axes based on the nodes orientation relative to it's parent. More... | |
const String & | getName (void) const |
Returns the name of the node. More... | |
const Quaternion & | getOrientation () const |
Returns a quaternion representing the nodes orientation. More... | |
Node * | getParent (void) const |
Gets this node's parent (NULL if this is the root). More... | |
Entity * | getParentEntity (void) const |
const Matrix4 & | getParentEntityTransform (void) const |
Gets the transform of parent entity. More... | |
const Vector3 & | getPosition (void) const |
Gets the position of the node relative to it's parent. More... | |
const Vector3 & | getScale (void) const |
Gets the scaling factor of this node. More... | |
Real | getSquaredViewDepth (const Camera *cam) const |
Helper function, get the squared view depth. More... | |
const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
bool | isManuallyControlled () const |
Getter for mManuallyControlled Flag. More... | |
void | needUpdate (bool forceParentUpdate=false) |
To be called in the event of transform changes to this node that require it's recalculation. More... | |
uint16 | numChildren (void) const |
Reports the number of child nodes under this one. More... | |
virtual void | pitch (const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the node around the X-axis. More... | |
virtual void | removeAllChildren (void) |
Removes all child Nodes attached to this node. More... | |
virtual Node * | removeChild (unsigned short index) |
Drops the specified child from this node. More... | |
virtual Node * | removeChild (Node *child) |
virtual Node * | removeChild (const String &name) |
Drops the named child from this node. More... | |
void | requestUpdate (Node *child, bool forceParentUpdate=false) |
Called by children to notify their parent that they need an update. More... | |
void | reset (void) |
Resets the position and orientation of this Bone to the original binding position. More... | |
void | resetOrientation (void) |
Resets the nodes orientation (local axes as world axes, no rotation). More... | |
void | resetToInitialState (void) |
Resets the position / orientation / scale of this node to it's initial state, see setInitialState for more info. More... | |
virtual void | roll (const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the node around the Z-axis. More... | |
void | rotate (const Vector3 &axis, const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the node around an arbitrary axis. More... | |
void | rotate (const Quaternion &q, TransformSpace relativeTo=TS_LOCAL) |
Rotate the node around an aritrary axis using a Quarternion. More... | |
void | scale (const Vector3 &scale) |
Scales the node, combining it's current scale with the passed in scaling factor. More... | |
void | scale (Real x, Real y, Real z) |
void | setBindingPose (void) |
Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh. More... | |
void | setChildObject (MovableObject *pObject) |
void | setInheritOrientation (bool inherit) |
Tells the node whether it should inherit orientation from it's parent node. More... | |
void | setInheritParentEntityOrientation (bool inherit) |
Tells the TagPoint whether it should inherit orientation from it's parent entity. More... | |
void | setInheritParentEntityScale (bool inherit) |
Tells the TagPoint whether it should inherit scaling factors from it's parent entity. More... | |
void | setInheritScale (bool inherit) |
Tells the node whether it should inherit scaling factors from it's parent node. More... | |
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. More... | |
void | setListener (Listener *listener) |
Sets a listener for this Node. More... | |
void | setManuallyControlled (bool manuallyControlled) |
Sets whether or not this bone is manually controlled. More... | |
void | setOrientation (const Quaternion &q) |
Sets the orientation of this node via a quaternion. More... | |
void | setOrientation (Real w, Real x, Real y, Real z) |
void | setParentEntity (Entity *pEntity) |
void | setPosition (const Vector3 &pos) |
Sets the position of the node relative to it's parent. More... | |
void | setPosition (Real x, Real y, Real z) |
void | setScale (const Vector3 &scale) |
Sets the scaling factor applied to this node. More... | |
void | setScale (Real x, Real y, Real z) |
void | setUserAny (const Any &anything) |
void | translate (const Vector3 &d, TransformSpace relativeTo=TS_PARENT) |
Moves the node along the Cartesian axes. More... | |
void | translate (Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT) |
void | translate (const Matrix3 &axes, const Vector3 &move, TransformSpace relativeTo=TS_PARENT) |
Moves the node along arbitrary axes. More... | |
void | translate (const Matrix3 &axes, Real x, Real y, Real z, TransformSpace relativeTo=TS_PARENT) |
void | updateFromParentImpl (void) const |
Overridden from Node in order to include parent Entity transform. More... | |
virtual void | yaw (const Radian &angle, TransformSpace relativeTo=TS_LOCAL) |
Rotate the node around the Y-axis. More... | |
Static Public Member Functions | |
static void | processQueuedUpdates (void) |
Process queued 'needUpdate' calls. More... | |
static void | queueNeedUpdate (Node *n) |
Queue a 'needUpdate' call to a node safely. More... | |
A tagged point on a skeleton, which can be used to attach entities to on specific other entities.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Ogre::TagPoint::TagPoint | ( | unsigned short | handle, |
Skeleton * | creator | ||
) |
Entity* Ogre::TagPoint::getParentEntity | ( | void | ) | const |
MovableObject* Ogre::TagPoint::getChildObject | ( | void | ) | const |
void Ogre::TagPoint::setParentEntity | ( | Entity * | pEntity | ) |
void Ogre::TagPoint::setChildObject | ( | MovableObject * | pObject | ) |
void Ogre::TagPoint::setInheritParentEntityOrientation | ( | bool | inherit | ) |
bool Ogre::TagPoint::getInheritParentEntityOrientation | ( | void | ) | const |
Returns true if this TagPoint is affected by orientation applied to the parent entity.
void Ogre::TagPoint::setInheritParentEntityScale | ( | bool | inherit | ) |
bool Ogre::TagPoint::getInheritParentEntityScale | ( | void | ) | const |
Returns true if this TagPoint is affected by scaling factors applied to the parent entity.
const Matrix4& Ogre::TagPoint::getParentEntityTransform | ( | void | ) | const |
Gets the transform of parent entity.
const Matrix4& Ogre::TagPoint::_getFullLocalTransform | ( | void | ) | const |
Gets the transform of this node just for the skeleton (not entity)
|
virtual |
To be called in the event of transform changes to this node that require it's recalculation.
forceParentUpdate | Even if the node thinks it has already told it's parent, tell it anyway |
Reimplemented from Ogre::Bone.
|
virtual |
Overridden from Node in order to include parent Entity transform.
Reimplemented from Ogre::Node.
const LightList& Ogre::TagPoint::getLights | ( | void | ) | const |
Gets a list of lights, ordered relative to how close they are to this renderable.
|
inherited |
Creates a new Bone as a child of this bone.
handle | The numeric handle to give the new bone; must be unique within the Skeleton. |
translate | Initial translation offset of child relative to parent |
rotate | Initial rotation relative to parent |
|
virtualinherited |
Creates an unnamed new Node as a child of this node.
translate | Initial translation offset of child relative to parent |
rotate | Initial rotation relative to parent |
|
virtualinherited |
Creates a new named Node as a child of this node.
translate | Initial translation offset of child relative to parent |
rotate | Initial rotation relative to parent |
|
inherited |
Gets the numeric handle for this bone (unique within the skeleton).
|
inherited |
Sets the current position / orientation to be the 'binding pose' ie the layout in which bones were originally bound to a mesh.
|
inherited |
Resets the position and orientation of this Bone to the original binding position.
|
inherited |
Sets whether or not this bone is manually controlled.
|
inherited |
Getter for mManuallyControlled Flag.
|
inherited |
Gets the transform which takes bone space to current from the binding pose.
|
inlineinherited |
Gets the inverted binding pose scale.
|
inlineinherited |
Gets the inverted binding pose position.
|
inlineinherited |
Gets the inverted binding pose orientation.
|
inlineinherited |
Returns the name of the node.
|
inlineinherited |
Gets this node's parent (NULL if this is the root).
|
inlineinherited |
Returns a quaternion representing the nodes orientation.
|
inherited |
Sets the orientation of this node via a quaternion.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inherited |
Resets the nodes orientation (local axes as world axes, no rotation).
|
inherited |
Sets the position of the node relative to it's parent.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inlineinherited |
Gets the position of the node relative to it's parent.
|
inherited |
Sets the scaling factor applied to this node.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inlineinherited |
Gets the scaling factor of this node.
|
inherited |
Tells the node whether it should inherit orientation from it's parent node.
inherit | If true, this node's orientation will be affected by its parent's orientation. If false, it will not be affected. |
|
inlineinherited |
Returns true if this node is affected by orientation applied to the parent node.
|
inherited |
Tells the node whether it should inherit scaling factors from it's parent node.
inherit | If true, this node's scale will be affected by its parent's scale. If false, it will not be affected. |
|
inlineinherited |
Returns true if this node is affected by scaling factors applied to the parent node.
References Ogre::Quaternion::IDENTITY, and Ogre::Vector3::ZERO.
|
inherited |
Scales the node, combining it's current scale with the passed in scaling factor.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inherited |
Moves the node along the Cartesian axes.
d | Vector with x,y,z values representing the translation. |
relativeTo | The space which this transform is relative to. |
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inherited |
Moves the node 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. |
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
virtualinherited |
Rotate the node around the Z-axis.
|
virtualinherited |
Rotate the node around the X-axis.
|
virtualinherited |
Rotate the node around the Y-axis.
Reimplemented in Ogre::SceneNode.
|
inherited |
Rotate the node around an arbitrary axis.
|
inherited |
Rotate the node around an aritrary axis using a Quarternion.
|
inherited |
Gets a matrix whose columns are the local axes based on the nodes orientation relative to it's parent.
|
inherited |
Adds a (precreated) child scene node to this node.
If it is attached to another node, it must be detached first.
child | The Node which is to become a child node of this one |
|
inlineinherited |
Reports the number of child nodes under this one.
|
inherited |
Gets a pointer to a child node.
Gets a pointer to a named child node.
|
inherited |
Retrieves an iterator for efficiently looping through all children of this node.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inlineinherited |
List of sub-nodes of this Node.
|
virtualinherited |
Drops the specified child from this node.
Reimplemented in Ogre::OctreeNode.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Reimplemented in Ogre::OctreeNode.
Drops the named child from this node.
Reimplemented in Ogre::OctreeNode.
|
virtualinherited |
Removes all child Nodes attached to this node.
Does not delete the nodes, just detaches them from this parent, potentially to be reattached elsewhere.
Reimplemented in Ogre::OctreeNode.
|
inherited |
Sets the final world position of the node directly.
|
inherited |
Sets the final world orientation of the node directly.
|
inherited |
Gets the orientation of the node as derived from all parents.
|
inherited |
Gets the position of the node as derived from all parents.
|
inherited |
Gets the scaling factor of the node as derived from all parents.
|
inherited |
Gets the full transformation matrix for this node.
|
virtualinherited |
Internal method to update the Node.
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. |
Reimplemented in Ogre::SceneNode, Ogre::PCZSceneNode, and Ogre::BspSceneNode.
|
inlineinherited |
Sets a listener for this Node.
|
inlineinherited |
Gets the current listener for this Node.
|
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.
|
inherited |
Resets the position / orientation / scale of this node to it's initial state, see setInitialState for more info.
|
inlineinherited |
Gets the initial position of this node, see setInitialState for more info.
Gets the local position, relative to this node, of the given world-space position.
Gets the world position of a point in the node local space useful for simple transforms that don't require a child node.
|
inherited |
Gets the local direction, relative to this node, of the given world-space direction.
|
inherited |
Gets the world direction of a point in the node local space useful for simple transforms that don't require a child node.
|
inherited |
Gets the local orientation, relative to this node, of the given world-space orientation.
|
inherited |
Gets the world orientation of an orientation in the node local space useful for simple transforms that don't require a child node.
|
inlineinherited |
Gets the initial orientation of this node, see setInitialState for more info.
|
inlineinherited |
Gets the initial position of this node, see setInitialState for more info.
Helper function, get the squared view depth.
|
inherited |
Called by children to notify their parent that they need an update.
forceParentUpdate | Even if the node thinks it has already told it's parent, tell it anyway |
|
inherited |
Called by children to notify their parent that they no longer need an update.
|
inherited |
Get a debug renderable for rendering the Node.
Referenced by Ogre::SceneNode::getAutoTrackLocalDirection().
|
staticinherited |
Queue a 'needUpdate' call to a node safely.
|
staticinherited |
Process queued 'needUpdate' calls.
|
inlineinherited |
Sets any kind of user value on this object.
|
inlineinherited |
Retrieves the custom user value associated with this object.
|
inlineinherited |
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.
|
inlineinherited |
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.