Loading...
Searching...
No Matches
irr::scene::IBoneSceneNode Class Referenceabstract

Interface for bones used for skeletal animation. More...

`#include <IBoneSceneNode.h>`

Inheritance diagram for irr::scene::IBoneSceneNode:

## Public Member Functions

| IBoneSceneNode (ISceneNode *parent, ISceneManager *mgr, s32 id=-1)
virtual E_BONE_ANIMATION_MODE | getAnimationMode () const =0
| Gets the current animation mode of the bone.
virtual u32 | getBoneIndex () const =0
| Get the index of the bone.
virtual _IRR_DEPRECATED_ const c8 * | getBoneName () const
| Get the name of the bone.
virtual const core::aabbox3d< f32 > & | getBoundingBox () const =0
| Get the axis aligned bounding box of this node.
virtual E_BONE_SKINNING_SPACE | getSkinningSpace () const =0
| How the relative transformation of the bone is used.
virtual void | OnAnimate (u32 timeMs)=0
| Returns the relative transformation of the scene node.
virtual void | render ()
| The render method.
virtual bool | setAnimationMode (E_BONE_ANIMATION_MODE mode)=0
| Sets the animation mode of the bone.
virtual void | setSkinningSpace (E_BONE_SKINNING_SPACE space)=0
| How the relative transformation of the bone is used.
virtual void | updateAbsolutePositionOfAllChildren ()=0
| Updates the absolute position based on the relative and the parents position.
Public Member Functions inherited from irr::scene::ISceneNode
| ISceneNode (ISceneNode *parent, ISceneManager *mgr, s32 id=-1, const core::vector3df &position=core::vector3df(0, 0, 0), const core::vector3df &rotation=core::vector3df(0, 0, 0), const core::vector3df &scale=core::vector3df(1.0f, 1.0f, 1.0f))
| Constructor.
virtual | ~ISceneNode ()
| Destructor.
virtual void | addAnimator (ISceneNodeAnimator *animator)
| Adds an animator which should animate this node.
virtual void | addChild (ISceneNode *child)
| Adds a child to this scene node.
virtual ISceneNode * | clone (ISceneNode *newParent=0, ISceneManager *newManager=0)
| Creates a clone of this scene node and its children.
virtual void | deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
| Reads attributes of the scene node.
virtual core::vector3df | getAbsolutePosition () const
| Gets the absolute position of the node in world coordinates.
virtual const core::matrix4 & | getAbsoluteTransformation () const
| Get the absolute transformation of the node. Is recalculated every OnAnimate()-call.
const core::list< ISceneNodeAnimator * > & | getAnimators () const
| Get a list of all scene node animators.
u32 | getAutomaticCulling () const
| Gets the automatic culling state.
const core::list< ISceneNode * > & | getChildren () const
| Returns a const reference to the list of all children.
virtual s32 | getID () const
| Get the id of the scene node.
virtual video::SMaterial & | getMaterial (u32 num)
| Returns the material based on the zero based index i.
virtual u32 | getMaterialCount () const
| Get amount of materials used by this scene node.
virtual const c8 * | getName () const
| Returns the name of the node.
scene::ISceneNode * | getParent () const
| Returns the parent of this scene node.
virtual const core::vector3df & | getPosition () const
| Gets the position of the node relative to its parent.
virtual core::matrix4 | getRelativeTransformation () const
| Returns the relative transformation of the scene node.
virtual const core::vector3df & | getRotation () const
| Gets the rotation of the node relative to its parent.
virtual const core::vector3df & | getScale () const
| Gets the scale of the scene node relative to its parent.
virtual ISceneManager * | getSceneManager (void) const
| Retrieve the scene manager for this node.
virtual const core::aabbox3d< f32 > | getTransformedBoundingBox () const
| Get the axis aligned, transformed and animated absolute bounding box of this node.
virtual ITriangleSelector * | getTriangleSelector () const
| Returns the triangle selector attached to this scene node.
virtual ESCENE_NODE_TYPE | getType () const
| Returns type of the scene node.
u32 | isDebugDataVisible () const
| Returns if debug data like bounding boxes are drawn.
bool | isDebugObject () const
| Returns if this scene node is a debug object.
virtual bool | isTrulyVisible () const
| Check whether the node is truly visible, taking into accounts its parents' visibility.
virtual bool | isVisible () const
| Returns whether the node should be visible (if all of its parents are visible).
virtual void | OnRegisterSceneNode ()
| This method is called just before the rendering process of the whole scene.
virtual void | remove ()
| Removes this scene node from the scene.
virtual void | removeAll ()
| Removes all children of this scene node.
virtual void | removeAnimator (ISceneNodeAnimator *animator)
| Removes an animator from this scene node.
virtual void | removeAnimators ()
| Removes all animators from this scene node.
virtual bool | removeChild (ISceneNode *child)
| Removes a child from this scene node.
virtual void | serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
| Writes attributes of the scene node.
void | setAutomaticCulling (u32 state)
| Enables or disables automatic culling based on the bounding box.
virtual void | setDebugDataVisible (u32 state)
| Sets if debug data like bounding boxes should be drawn.
virtual void | setID (s32 id)
| Sets the id of the scene node.
void | setIsDebugObject (bool debugObject)
| Sets if this scene node is a debug object.
void | setMaterialFlag (video::E_MATERIAL_FLAG flag, bool newvalue)
| Sets all material flags at once to a new value.
void | setMaterialTexture (u32 textureLayer, video::ITexture *texture)
| Sets the texture of the specified layer in all materials of this scene node to the new texture.
void | setMaterialType (video::E_MATERIAL_TYPE newType)
| Sets the material type of all materials in this scene node to a new material type.
virtual void | setName (const c8 *name)
| Sets the name of the node.
virtual void | setName (const core::stringc &name)
| Sets the name of the node.
virtual void | setParent (ISceneNode *newParent)
| Changes the parent of the scene node.
virtual void | setPosition (const core::vector3df &newpos)
| Sets the position of the node relative to its parent.
virtual void | setRotation (const core::vector3df &rotation)
| Sets the rotation of the node relative to its parent.
virtual void | setScale (const core::vector3df &scale)
| Sets the relative scale of the scene node.
virtual void | setTriangleSelector (ITriangleSelector *selector)
| Sets the triangle selector of the scene node.
virtual void | setVisible (bool isVisible)
| Sets if the node should be visible or not.
virtual void | updateAbsolutePosition ()
| Updates the absolute position based on the relative and the parents position.
Public Member Functions inherited from irr::IReferenceCounted
| IReferenceCounted ()
| Constructor.
virtual | ~IReferenceCounted ()
| Destructor.
bool | drop () const
| Drops the object. Decrements the reference counter by one.
const c8 * | getDebugName () const
| Returns the debug name of the object.
s32 | getReferenceCount () const
| Get the reference count.
void | grab () const
| Grabs the object. Increments the reference counter by one.

## Public Attributes

s32 | positionHint
s32 | rotationHint
s32 | scaleHint

## Additional Inherited Members

Protected Member Functions inherited from irr::scene::ISceneNode
void | cloneMembers (ISceneNode *toCopyFrom, ISceneManager *newManager)
| A clone function for the ISceneNode members.
void | setSceneManager (ISceneManager *newManager)
Protected Member Functions inherited from irr::IReferenceCounted
void | setDebugName (const c8 *newName)
| Sets the debug name of the object.
Protected Attributes inherited from irr::scene::ISceneNode
core::matrix4 | AbsoluteTransformation
| Absolute transformation of the node.
core::list< ISceneNodeAnimator * > | Animators
| List of all animator nodes.
u32 | AutomaticCullingState
| Automatic culling state.
core::list< ISceneNode * > | Children
| List of all children of this node.
u32 | DebugDataVisible
| Flag if debug data should be drawn, such as Bounding Boxes.
s32 | ID
| ID of the node.
bool | IsDebugObject
| Is debug object?
bool | IsVisible
| Is the node visible?
core::stringc | Name
| Name of the scene node.
ISceneNode * | Parent
| Pointer to the parent.
core::vector3df | RelativeRotation
| Relative rotation of the scene node.
core::vector3df | RelativeScale
| Relative scale of the scene node.
core::vector3df | RelativeTranslation
| Relative translation of the scene node.
ISceneManager * | SceneManager
| Pointer to the scene manager.
ITriangleSelector * | TriangleSelector
| Pointer to the triangle selector.

## Detailed Description

Interface for bones used for skeletal animation.

Used with ISkinnedMesh and IAnimatedMeshSceneNode.

Definition at line 55 of file IBoneSceneNode.h.

## Constructor & Destructor Documentation

## IBoneSceneNode()

irr::scene::IBoneSceneNode::IBoneSceneNode | ( | ISceneNode * | parent,
|  | ISceneManager * | mgr,
|  | s32 | id = -1 )

inline

Definition at line 59 of file IBoneSceneNode.h.

References irr::scene::ISceneNode::ISceneNode(), positionHint, rotationHint, and scaleHint.

## Member Function Documentation

## getAnimationMode()

virtual E_BONE_ANIMATION_MODE irr::scene::IBoneSceneNode::getAnimationMode | ( |  | ) | const

pure virtual

Gets the current animation mode of the bone.

## getBoneIndex()

virtual u32 irr::scene::IBoneSceneNode::getBoneIndex | ( |  | ) | const

pure virtual

Get the index of the bone.

## getBoneName()

virtual _IRR_DEPRECATED_ const c8 * irr::scene::IBoneSceneNode::getBoneName | ( |  | ) | const

inline virtual

Get the name of the bone.

Deprecated
  Use getName instead. This method may be removed by Irrlicht 1.9

Definition at line 64 of file IBoneSceneNode.h.

References _IRR_DEPRECATED_, and irr::scene::ISceneNode::getName().

## getBoundingBox()

virtual const core::aabbox3d< f32 > & irr::scene::IBoneSceneNode::getBoundingBox | ( |  | ) | const

pure virtual

Get the axis aligned bounding box of this node.

Implements irr::scene::ISceneNode.

## getSkinningSpace()

virtual E_BONE_SKINNING_SPACE irr::scene::IBoneSceneNode::getSkinningSpace | ( |  | ) | const

pure virtual

How the relative transformation of the bone is used.

## OnAnimate()

virtual void irr::scene::IBoneSceneNode::OnAnimate | ( | u32 | timeMs | ) |

pure virtual

Returns the relative transformation of the scene node.

The animation method.

Reimplemented from irr::scene::ISceneNode.

## render()

virtual void irr::scene::IBoneSceneNode::render | ( |  | ) |

inline virtual

The render method.

Does nothing as bones are not visible.

Implements irr::scene::ISceneNode.

Definition at line 87 of file IBoneSceneNode.h.

## setAnimationMode()

virtual bool irr::scene::IBoneSceneNode::setAnimationMode | ( | E_BONE_ANIMATION_MODE | mode | ) |

pure virtual

Sets the animation mode of the bone.

Returns
  True if successful. (Unused)

## setSkinningSpace()

virtual void irr::scene::IBoneSceneNode::setSkinningSpace | ( | E_BONE_SKINNING_SPACE | space | ) |

pure virtual

How the relative transformation of the bone is used.

## updateAbsolutePositionOfAllChildren()

virtual void irr::scene::IBoneSceneNode::updateAbsolutePositionOfAllChildren | ( |  | ) |

pure virtual

Updates the absolute position based on the relative and the parents position.

## Member Data Documentation

## positionHint

s32 irr::scene::IBoneSceneNode::positionHint

Definition at line 98 of file IBoneSceneNode.h.

Referenced by IBoneSceneNode().

## rotationHint

s32 irr::scene::IBoneSceneNode::rotationHint

Definition at line 100 of file IBoneSceneNode.h.

Referenced by IBoneSceneNode().

## scaleHint

s32 irr::scene::IBoneSceneNode::scaleHint

Definition at line 99 of file IBoneSceneNode.h.

Referenced by IBoneSceneNode().

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

- IBoneSceneNode.h

- Irrlicht Engine Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on for Irrlicht 3D Engine by Doxygen 1.15.0