Castor3D 0.16.0
Multiplatform 3D engine
Public Member Functions | List of all members
castor3d::AnimatedSceneNode Class Reference

#include <AnimatedSceneNode.hpp>

Inheritance diagram for castor3d::AnimatedSceneNode:
Inheritance graph
[legend]
Collaboration diagram for castor3d::AnimatedSceneNode:
Collaboration graph
[legend]

Public Member Functions

C3D_API AnimatedSceneNode (AnimatedSceneNode &&rhs) noexcept=default
 
C3D_API AnimatedSceneNodeoperator= (AnimatedSceneNode &&rhs) noexcept=delete
 
C3D_API AnimatedSceneNode (AnimatedSceneNode const &rhs)=delete
 
C3D_API AnimatedSceneNodeoperator= (AnimatedSceneNode const &rhs)=delete
 
C3D_API ~AnimatedSceneNode () noexcept override=default
 
C3D_API AnimatedSceneNode (castor::String const &name, SceneNode &node)
 Constructor.
 
C3D_API void update (castor::Milliseconds const &elapsed) override
 Updates the animations of the object, given the time since the last frame.
 
C3D_API bool isPlayingAnimation () const override
 
SceneNodegetSceneNode () const
 
SceneNodeAnimationInstancegetPlayingAnimation () const
 
- Public Member Functions inherited from castor3d::AnimatedObject
C3D_API AnimatedObject (AnimationType kind, castor::String const &name)
 Constructor.
 
virtual C3D_API ~AnimatedObject () noexcept=default
 Destructor.
 
C3D_API void addAnimation (castor::String const &name)
 adds the animation to the list
 
C3D_API void startAnimation (castor::String const &name)
 Starts the animation identified by the given name.
 
C3D_API void stopAnimation (castor::String const &name)
 Stops the animation identified by the given name.
 
C3D_API void pauseAnimation (castor::String const &name)
 Pauses the animation identified by the given name.
 
C3D_API void startAllAnimations ()
 Starts all animations.
 
C3D_API void stopAllAnimations ()
 Stops all animations.
 
C3D_API void pauseAllAnimations ()
 Pauses all animations.
 
C3D_API AnimationInstancegetAnimation (castor::String const &name)
 Retrieves an animation.
 
C3D_API AnimatedObject (AnimatedObject &&rhs) noexcept=default
 
C3D_API AnimatedObjectoperator= (AnimatedObject &&rhs) noexcept=default
 
C3D_API AnimatedObject (AnimatedObject const &rhs)=delete
 
C3D_API AnimatedObjectoperator= (AnimatedObject const &rhs)=delete
 
bool hasAnimation (castor::String const &name)
 
AnimationInstancesMap const & getAnimations () const
 
AnimationType getKind () const
 
- Public Member Functions inherited from castor::NamedBaseT< T >
 NamedBaseT (T name) noexcept
 Constructor.
 
T const & getName () const noexcept
 Retrieves the name.
 
void rename (T name) noexcept
 

Additional Inherited Members

- Public Types inherited from castor3d::AnimatedObject
using AnimationInstancesMap = castor::StringMap< AnimationInstanceUPtr >
 
- Protected Attributes inherited from castor3d::AnimatedObject
AnimationInstancesMap m_animations
 
- Protected Attributes inherited from castor::NamedBaseT< T >
m_name
 

Constructor & Destructor Documentation

◆ AnimatedSceneNode() [1/3]

C3D_API castor3d::AnimatedSceneNode::AnimatedSceneNode ( AnimatedSceneNode && rhs)
defaultnoexcept

◆ AnimatedSceneNode() [2/3]

C3D_API castor3d::AnimatedSceneNode::AnimatedSceneNode ( AnimatedSceneNode const & rhs)
delete

◆ ~AnimatedSceneNode()

C3D_API castor3d::AnimatedSceneNode::~AnimatedSceneNode ( )
overridedefaultnoexcept

◆ AnimatedSceneNode() [3/3]

C3D_API castor3d::AnimatedSceneNode::AnimatedSceneNode ( castor::String const & name,
SceneNode & node )

Constructor.

Parameters
[in]nameThe object name.
[in]nodeThe scene node.

Member Function Documentation

◆ getPlayingAnimation()

SceneNodeAnimationInstance & castor3d::AnimatedSceneNode::getPlayingAnimation ( ) const
inline

References CU_Require.

◆ getSceneNode()

SceneNode & castor3d::AnimatedSceneNode::getSceneNode ( ) const
inline

name Getters.

◆ isPlayingAnimation()

C3D_API bool castor3d::AnimatedSceneNode::isPlayingAnimation ( ) const
inlineoverridevirtual

Returns
true if the object is playing an animation.

Implements castor3d::AnimatedObject.

◆ operator=() [1/2]

C3D_API AnimatedSceneNode & castor3d::AnimatedSceneNode::operator= ( AnimatedSceneNode && rhs)
deletenoexcept

◆ operator=() [2/2]

C3D_API AnimatedSceneNode & castor3d::AnimatedSceneNode::operator= ( AnimatedSceneNode const & rhs)
delete

◆ update()

C3D_API void castor3d::AnimatedSceneNode::update ( castor::Milliseconds const & elapsed)
overridevirtual

Updates the animations of the object, given the time since the last frame.

Parameters
[in]elapsedTime elapsed since the last frame

Implements castor3d::AnimatedObject.


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