Lysa Nodes  0.0
Lysa Nodes — Scene Graph for the Lysa Engine
Classes | Public Member Functions | List of all members
AnimationPlayer Class Reference

Detailed Description

A node used for animation playback.

+ Inheritance diagram for AnimationPlayer:

Classes

struct  Playback
 
struct  TrackInitialValues
 

Public Member Functions

 AnimationPlayer (const std::string &name=TypeNames[ANIMATION_PLAYER])
 
 AnimationPlayer (const AnimationPlayer &animationPlayer)
 
const auto & getCurrentLibraryName () const
 
const auto & getCurrentAnimationName () const
 
void setCurrentLibrary (const std::string &name)
 
void setCurrentAnimation (const std::string &name)
 
void add (const std::shared_ptr< AnimationLibrary > &library, const std::string &name="")
 
std::shared_ptr< Animation > getCurrentAnimation ()
 
auto getCurrentLibrary ()
 
void play (const std::string &name="")
 
void seek (float duration)
 
void playBackwards (const std::string &name="")
 
void stop (bool keepState=false)
 
auto isPlaying () const
 
auto setAutoStart (const bool autoStart)
 
void setTargetPath (const std::string &path)
 
void setLuaThis () override
 
- Public Member Functions inherited from Node
 Node (const Node &node)
 
 Node (const std::string &name=TypeNames[NODE], Type type=NODE)
 
virtual ~Node () = default
 
auto getId () const
 
virtual void onReady ()
 
virtual void onEnterScene ()
 
virtual void onExitScene ()
 
virtual void onProcess (const float alpha)
 
virtual void onPhysicsProcess (const float delta)
 
virtual bool onInput (const InputEvent &inputEvent)
 
const float4x4 & getTransform () const
 
void setTransform (const float4x4 &transform)
 
const float4x4 & getTransformGlobal () const
 
virtual void setPosition (const float3 &position)
 
virtual void setPosition (const float x, const float y, const float z)
 
float3 getPosition () const
 
void translate (const float3 &localOffset)
 
void translate (const float x, const float y, const float z)
 
virtual void setPositionGlobal (const float3 &position)
 
virtual void setPositionGlobal (const float x, const float y, const float z)
 
float3 getPositionGlobal () const
 
void rotate (const quaternion &quaternion)
 
void rotateX (float angle)
 
void rotateY (float angle)
 
void rotateZ (float angle)
 
void rotateGlobalX (float angle)
 
void rotateGlobalY (float angle)
 
void rotateGlobalZ (float angle)
 
quaternion getRotation () const
 
quaternion getRotationGlobal () const
 
float3 getRotationEulerAngles () const
 
float3 getRotationEulerAnglesGlobal () const
 
virtual void scale (float scale)
 
void setScale (const float3 &scale)
 
void setRotation (const quaternion &quat)
 
void setRotationGlobal (const quaternion &quat)
 
void setRotation (const float3 &rot)
 
void setRotationX (float angle)
 
void setRotationY (float angle)
 
void setRotationZ (float angle)
 
float getRotationX () const
 
float getRotationY () const
 
float getRotationZ () const
 
float getRotationGlobalX () const
 
float getRotationGlobalY () const
 
float getRotationGlobalZ () const
 
void setRotationGlobalX (float angle)
 
void setRotationGlobalY (float angle)
 
void setRotationGlobalZ (float angle)
 
float3 getScale () const
 
float3 getScaleGlobal () const
 
template<typename T = Node>
const std::shared_ptr< T > & addChild (const std::shared_ptr< T > &child, bool async=false)
 
template<typename T = Node>
bool removeChild (const std::shared_ptr< T > &child)
 
void removeAllChildren (bool async=false)
 
void lookAt (const float3 &target)
 
template<typename T = Node>
std::list< std::shared_ptr< T > > findAllChildrenByGroup (const std::string &groupName, const bool recursive=true) const
 
const std::list< std::string > & getGroups () const
 
void addToGroup (const std::string &group)
 
void removeFromGroup (const std::string &group)
 
virtual bool isVisible () const
 
virtual void setVisible (bool visible=true)
 
bool isInGroup (const std::string &group) const
 
void setProcessMode (const ProcessMode mode)
 
bool isProcessed () const
 
auto getType () const
 
std::string getPath () const
 
virtual void setProperty (const std::string &property, const std::string &value)
 
void printTree (int tab=0) const
 
std::shared_ptr< Node > duplicate (bool recursiveFilter=false) const
 
float3 toGlobal (const float3 &local) const
 
float3 toLocal (const float3 &global) const
 
float3 getRightVector () const
 
float3 getLeftVector () const
 
float3 getFrontVector () const
 
float3 getBackVector () const
 
float3 getUpVector () const
 
float3 getDownVector () const
 
template<typename T >
bool haveChild (const std::shared_ptr< T > &child, const bool recursive=true) const
 
template<typename T = Node>
std::shared_ptr< T > getChild (const std::string &name) const
 
template<typename T = Node>
std::shared_ptr< T > getChildByPath (const std::string &path) const
 
template<typename T = Node>
std::string getRelativePath (const std::shared_ptr< T > &root) const
 
template<typename T = Node>
std::shared_ptr< T > findFirstChild (const std::string &name) const
 
template<typename T >
std::shared_ptr< T > findFirstChild (const bool recursive=true) const
 
template<typename T >
std::list< std::shared_ptr< T > > findAllChildren (const bool recursive=true) const
 
template<typename T = Node>
std::list< std::shared_ptr< T > > findAllChildren (const std::string &name, const bool recursive=true) const
 
const std::list< std::shared_ptr< Node > > & getChildren ()
 
const std::list< std::shared_ptr< Node > > & getChildren () const
 
void setName (const std::string &nodeName)
 
template<typename T = Node>
std::shared_ptr< T > getSharedPtr ()
 
const std::string & getName () const
 
template<typename T = Scene>
T * getScene () const
 
const auto & getParent () const
 
bool haveParent () const
 
void setLuaThis () override
 

Additional Inherited Members

- Public Types inherited from Node
enum  Type {
  ANIMATION_PLAYER, CAMERA, CHARACTER, COLLISION_AREA,
  COLLISION_OBJECT, DIRECTIONAL_LIGHT, ENVIRONMENT, KINEMATIC_BODY,
  LIGHT, MESH_INSTANCE, NODE, OMNI_LIGHT,
  PHYSICS_BODY, RAYCAST, RIGID_BODY, SKYBOX,
  SPOT_LIGHT, STATIC_BODY, VIEWPORT
}
 Node type. More...
 
- Static Public Member Functions inherited from Node
static std::string sanitizeName (const std::string &name)
 
- Static Public Attributes inherited from Node
static constexpr auto TypeNames
 Display names for each node Type value, indexed by the Type enum. More...
 
- Protected Member Functions inherited from Node
virtual void updateGlobalTransform ()
 
- Protected Attributes inherited from Node
float4x4 localTransform {}
 
float4x4 globalTransform {}
 
Scene * scene {nullptr}
 

Constructor & Destructor Documentation

AnimationPlayer ( const std::string &  name = TypeNames[ANIMATION_PLAYER])

Constructor

Parameters
nameThe name of the node
AnimationPlayer ( const AnimationPlayer &  animationPlayer)

Copy constructor — creates an independent animation player node with the same libraries and state.

Member Function Documentation

void add ( const std::shared_ptr< AnimationLibrary > &  library,
const std::string &  name = "" 
)

Adds a library accessible by the name.

Parameters
libraryThe library to add
nameThe name of the library
std::shared_ptr<Animation> getCurrentAnimation ( )

Returns the current animation, if any

const auto& getCurrentAnimationName ( ) const
inline

Returns the current animation name

auto getCurrentLibrary ( )
inline

Returns the current animation library, if any

const auto& getCurrentLibraryName ( ) const
inline

Returns the current library name

auto isPlaying ( ) const
inline

Returns true if the animation is currently playing

void play ( const std::string &  name = "")

Starts an animation by its name

void playBackwards ( const std::string &  name = "")

Starts an animation by its name, playing it backwards

void seek ( float  duration)

Seeks the animation to the point in time (in seconds).

auto setAutoStart ( const bool  autoStart)
inline

Sets the auto start property.

void setCurrentAnimation ( const std::string &  name)

Sets the current animation name (does not start the animation, only useful with auto-starting)

void setCurrentLibrary ( const std::string &  name)

Sets the current library name

void setLuaThis ( )
override
void setTargetPath ( const std::string &  path)

Override all track's target path

void stop ( bool  keepState = false)

Stops the currently playing animation

Parameters
keepStateWhether to keep the current state of the animated objects