Duckcpp 2.1.0
Duckcpp is a high-performance c++ graphics engine.
Loading...
Searching...
No Matches
dcpp::scene::IBoneSceneNode Class Referenceabstract

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

#include <duckcpp/core/engine/IBoneSceneNode.hpp>

Inheritance diagram for dcpp::scene::IBoneSceneNode:
Inheritance graph
Collaboration diagram for dcpp::scene::IBoneSceneNode:
Collaboration graph

Public Member Functions

 IBoneSceneNode (ISceneNode *parent, ISceneManager *mgr, dcpp::int32_kt id=-1)
 
virtual DCPP_DEPRECATED const dcpp::char_ktgetBoneName () const
 Get the name of the bone.
 
virtual dcpp::uint32_kt getBoneIndex () const =0
 Get the index of the bone.
 
virtual bool setAnimationMode (E_BONE_ANIMATION_MODE mode)=0
 Sets the animation mode of the bone.
 
virtual E_BONE_ANIMATION_MODE getAnimationMode () const =0
 Gets the current animation mode of the bone.
 
virtual const dcpp::nub::aabbox3dfgetBoundingBox () const override=0
 Get the axis aligned bounding box of this node.
 
virtual void OnAnimate (dcpp::uint32_kt timeMs) override=0
 Returns the relative transformation of the scene node.
 
virtual void render () override
 The render method.
 
virtual void setSkinningSpace (E_BONE_SKINNING_SPACE space)=0
 How the relative transformation of the bone is used.
 
virtual E_BONE_SKINNING_SPACE getSkinningSpace () const =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 dcpp::scene::ISceneNode
 ISceneNode (ISceneNode *parent, ISceneManager *mgr, dcpp::int32_kt id=-1, const dcpp::nub::vector3df &position=dcpp::nub::vector3df(0, 0, 0), const dcpp::nub::vector3df &rotation=dcpp::nub::vector3df(0, 0, 0), const dcpp::nub::vector3df &scale=dcpp::nub::vector3df(1.0f, 1.0f, 1.0f))
 Constructor.
 
virtual ~ISceneNode ()
 Destructor.
 
virtual void OnRegisterSceneNode ()
 This method is called just before the rendering process of the whole scene.
 
virtual const dcpp::char_ktgetName () const
 Returns the name of the node.
 
virtual void setName (const dcpp::char_kt *name)
 Sets the name of the node.
 
virtual void setName (const dcpp::nub::string &name)
 Sets the name of the node.
 
virtual const dcpp::nub::aabbox3df getTransformedBoundingBox () const
 Get the axis aligned, transformed and animated absolute bounding box of this node.
 
virtual void getTransformedBoundingBoxEdges (dcpp::nub::array< dcpp::nub::vector3df > &edges) const
 
virtual const dcpp::nub::matrix4getAbsoluteTransformation () const
 Get the absolute transformation of the node. Is recalculated every OnAnimate()-call.
 
virtual dcpp::nub::matrix4 getRelativeTransformation () const
 Returns the relative transformation of the scene node.
 
virtual bool isVisible () const
 Returns whether the node should be visible (if all of its parents are visible).
 
virtual bool isTrulyVisible () const
 Check whether the node is truly visible, taking into accounts its parents' visibility.
 
virtual void setVisible (bool isVisible)
 Sets if the node should be visible or not.
 
virtual dcpp::int32_kt getID () const
 Get the id of the scene node.
 
virtual void setID (dcpp::int32_kt id)
 Sets the id of the scene node.
 
virtual void addChild (ISceneNode *child)
 Adds a child to this scene node.
 
virtual bool removeChild (ISceneNode *child)
 Removes a child from this scene node.
 
virtual void removeAll ()
 Removes all children of this scene node.
 
virtual void remove ()
 Removes this scene node from the scene.
 
virtual void addAnimator (ISceneNodeAnimator *animator)
 Adds an animator which should animate this node.
 
const dcpp::nub::list< ISceneNodeAnimator * > & getAnimators () const
 Get a list of all scene node animators.
 
virtual void removeAnimator (ISceneNodeAnimator *animator)
 Removes an animator from this scene node.
 
virtual void removeAnimators ()
 Removes all animators from this scene node.
 
virtual dcpp::video::SMaterialgetMaterial (dcpp::uint32_kt num)
 Returns the material based on the zero based index i.
 
virtual dcpp::uint32_kt getMaterialCount () const
 Get amount of materials used by this scene node.
 
void setMaterialFlag (dcpp::video::E_MATERIAL_FLAG flag, bool newvalue)
 Sets all material flags at once to a new value.
 
void setMaterialTexture (dcpp::uint32_kt textureLayer, dcpp::video::ITexture *texture)
 Sets the texture of the specified layer in all materials of this scene node to the new texture.
 
void setMaterialType (dcpp::video::E_MATERIAL_TYPE newType)
 Sets the material type of all materials in this scene node to a new material type.
 
virtual const dcpp::nub::vector3dfgetScale () const
 Gets the scale of the scene node relative to its parent.
 
virtual void setScale (const dcpp::nub::vector3df &scale)
 Sets the relative scale of the scene node.
 
virtual const dcpp::nub::vector3dfgetRotation () const
 Gets the rotation of the node relative to its parent.
 
virtual void setRotation (const dcpp::nub::vector3df &rotation)
 Sets the rotation of the node relative to its parent.
 
virtual const dcpp::nub::vector3dfgetPosition () const
 Gets the position of the node relative to its parent.
 
virtual void setPosition (const dcpp::nub::vector3df &newpos)
 Sets the position of the node relative to its parent.
 
virtual dcpp::nub::vector3df getAbsolutePosition () const
 Gets the absolute position of the node in world coordinates.
 
void setAutomaticCulling (dcpp::uint32_kt state)
 Set a culling style or disable culling completely.
 
dcpp::uint32_kt getAutomaticCulling () const
 Gets the automatic culling state.
 
void setUpdateAbsolutePosBehavior (ESCENE_NODE_UPDATE_ABS behavior)
 Set how updateAbsolutePosition calculates the absolute transformation matrix.
 
ESCENE_NODE_UPDATE_ABS getUpdateAbsolutePosBehavior () const
 Get how updateAbsolutePosition calculates the absolute transformation matrix.
 
virtual void setDebugDataVisible (dcpp::uint32_kt state)
 Sets if debug data like bounding boxes should be drawn.
 
dcpp::uint32_kt isDebugDataVisible () const
 Returns if debug data like bounding boxes are drawn.
 
void setIsDebugObject (bool debugObject)
 Sets if this scene node is a debug object.
 
bool isDebugObject () const
 Returns if this scene node is a debug object.
 
const dcpp::nub::list< ISceneNode * > & getChildren () const
 Returns a const reference to the list of all children.
 
virtual void setParent (ISceneNode *newParent)
 Changes the parent of the scene node.
 
virtual ITriangleSelectorgetTriangleSelector () const
 Returns the triangle selector attached to this scene node.
 
virtual void setTriangleSelector (ITriangleSelector *selector)
 Sets the triangle selector of the scene node.
 
virtual void updateAbsolutePosition ()
 Updates the absolute tranformation or position based on the relative and the parents transformation.
 
dcpp::scene::ISceneNodegetParent () const
 Returns the parent of this scene node.
 
virtual ESCENE_NODE_TYPE getType () const
 Returns type of the scene node.
 
virtual void serializeAttributes (dcpp::io::IAttributes *out, dcpp::io::SAttributeReadWriteOptions *options=0) const override
 Writes attributes of the scene node.
 
virtual void deserializeAttributes (dcpp::io::IAttributes *in, dcpp::io::SAttributeReadWriteOptions *options=0) override
 Reads attributes of the scene node.
 
virtual ISceneNodeclone (ISceneNode *newParent=0, ISceneManager *newManager=0)
 Creates a clone of this scene node and its children.
 
virtual ISceneManagergetSceneManager (void) const
 Retrieve the scene manager for this node.
 
- Public Member Functions inherited from dcpp::IReferenceCounted
 IReferenceCounted ()
 Constructor.
 
virtual ~IReferenceCounted ()
 Destructor.
 
void grab () const
 Grabs the object. Increments the reference counter by one.
 
bool drop () const
 Drops the object. Decrements the reference counter by one.
 
dcpp::int32_kt getReferenceCount () const
 Get the reference count.
 
const dcpp::char_ktgetDebugName () const
 Returns the debug name of the object.
 

Public Attributes

dcpp::int32_kt positionHint
 
dcpp::int32_kt scaleHint
 
dcpp::int32_kt rotationHint
 

Additional Inherited Members

- Protected Member Functions inherited from dcpp::scene::ISceneNode
void cloneMembers (ISceneNode *toCopyFrom, ISceneManager *newManager)
 A clone function for the ISceneNode members.
 
void setSceneManager (ISceneManager *newManager)
 
- Protected Member Functions inherited from dcpp::IReferenceCounted
void setDebugName (const dcpp::char_kt *newName)
 Sets the debug name of the object.
 
- Protected Attributes inherited from dcpp::scene::ISceneNode
dcpp::nub::string Name
 Name of the scene node.
 
dcpp::nub::matrix4 AbsoluteTransformation
 Absolute transformation of the node.
 
dcpp::nub::vector3df RelativeTranslation
 Relative translation of the scene node.
 
dcpp::nub::vector3df RelativeRotation
 Relative rotation of the scene node.
 
dcpp::nub::vector3df RelativeScale
 Relative scale of the scene node.
 
ISceneNodeParent
 Pointer to the parent.
 
dcpp::nub::list< ISceneNode * > Children
 List of all children of this node.
 
dcpp::nub::list< ISceneNodeAnimator * > Animators
 List of all animator nodes.
 
ISceneManagerSceneManager
 Pointer to the scene manager.
 
ITriangleSelectorTriangleSelector
 Pointer to the triangle selector.
 
dcpp::int32_kt ID
 ID of the node.
 
ESCENE_NODE_UPDATE_ABS UpdateAbsolutePosBehavior
 How updateAbsolutePosition calculates AbsoluteTransformation.
 
dcpp::uint32_kt AutomaticCullingState
 Automatic culling state.
 
dcpp::uint32_kt DebugDataVisible
 Flag if debug data should be drawn, such as Bounding Boxes.
 
bool IsVisible
 Is the node visible?
 
bool IsDebugObject
 Is debug object?
 

Detailed Description

Interface for bones used for skeletal animation.

Used with ISkinnedMesh and IAnimatedMeshSceneNode.

Member Function Documentation

◆ getBoneName()

virtual DCPP_DEPRECATED const dcpp::char_kt * dcpp::scene::IBoneSceneNode::getBoneName ( ) const
inlinevirtual

Get the name of the bone.

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

◆ getBoundingBox()

virtual const dcpp::nub::aabbox3df & dcpp::scene::IBoneSceneNode::getBoundingBox ( ) const
overridepure virtual

Get the axis aligned bounding box of this node.

Implements dcpp::scene::ISceneNode.

◆ OnAnimate()

virtual void dcpp::scene::IBoneSceneNode::OnAnimate ( dcpp::uint32_kt  timeMs)
overridepure virtual

Returns the relative transformation of the scene node.

The animation method.

Reimplemented from dcpp::scene::ISceneNode.

◆ render()

virtual void dcpp::scene::IBoneSceneNode::render ( )
inlineoverridevirtual

The render method.

Does nothing as bones are not visible.

Implements dcpp::scene::ISceneNode.

◆ setAnimationMode()

virtual bool dcpp::scene::IBoneSceneNode::setAnimationMode ( E_BONE_ANIMATION_MODE  mode)
pure virtual

Sets the animation mode of the bone.

Returns
True if successful. (Unused)

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

Duckcpp    @cppfx.xyz