Public Member Functions | List of all members
sdf::v9::Animation Class Reference

Animation in Actor. More...

#include <Actor.hh>

Public Member Functions

 Animation ()
 Default constructor. More...
 
 Animation (const Animation &_animation)
 Copy constructor. More...
 
 Animation (Animation &&_animation) noexcept
 Move constructor. More...
 
 ~Animation ()
 Destructor. More...
 
void CopyFrom (const Animation &_animation)
 Copy animation from an Animation instance. More...
 
const std::string & Filename () const
 Get the animation filename. More...
 
const std::string & FilePath () const
 The path to the file where this element was loaded from. More...
 
bool InterpolateX () const
 Get whether the animation is interpolated on X. More...
 
Errors Load (ElementPtr _sdf)
 Load the animation based on a element pointer. More...
 
const std::string & Name () const
 Get the name of the animation. More...
 
Animationoperator= (Animation &&_animation)
 Move assignment operator. More...
 
Animationoperator= (const Animation &_animation)
 Assignment operator. More...
 
double Scale () const
 Get the scale for the animation skeleton. More...
 
void SetFilename (const std::string &_filename)
 Set the filename of the animation. More...
 
void SetFilePath (const std::string &_filePath)
 Set the path to the file where this element was loaded from. More...
 
void SetInterpolateX (bool _interpolateX)
 Set whether the animation is interpolated on X. More...
 
void SetName (const std::string &_name)
 Set the name of the animation. More...
 
void SetScale (double _scale)
 Set the scale of the animation skeleton. More...
 

Detailed Description

Animation in Actor.

Constructor & Destructor Documentation

◆ Animation() [1/3]

sdf::v9::Animation::Animation ( )

Default constructor.

◆ Animation() [2/3]

sdf::v9::Animation::Animation ( const Animation _animation)

Copy constructor.

Parameters
[in]_animationAnimation to copy.

◆ Animation() [3/3]

sdf::v9::Animation::Animation ( Animation &&  _animation)
noexcept

Move constructor.

Parameters
[in]_animationAnimation to move.

◆ ~Animation()

sdf::v9::Animation::~Animation ( )

Destructor.

Member Function Documentation

◆ CopyFrom()

void sdf::v9::Animation::CopyFrom ( const Animation _animation)

Copy animation from an Animation instance.

Parameters
[in]_animationThe animation to set values from.

◆ Filename()

const std::string& sdf::v9::Animation::Filename ( ) const

Get the animation filename.

Returns
Filename of the animation.

◆ FilePath()

const std::string& sdf::v9::Animation::FilePath ( ) const

The path to the file where this element was loaded from.

Returns
Full path to the file on disk.

◆ InterpolateX()

bool sdf::v9::Animation::InterpolateX ( ) const

Get whether the animation is interpolated on X.

Returns
True if interpolated on X.

◆ Load()

Errors sdf::v9::Animation::Load ( ElementPtr  _sdf)

Load the animation based on a element pointer.

This is not the usual entry point. Typical usage of the SDF DOM is through the Root object.

Parameters
[in]_sdfThe SDF Element pointer
Returns
Errors, which is a vector of Error objects. Each Error includes an error code and message. An empty vector indicates no error.

◆ Name()

const std::string& sdf::v9::Animation::Name ( ) const

Get the name of the animation.

Returns
Name of the animation.

◆ operator=() [1/2]

Animation& sdf::v9::Animation::operator= ( Animation &&  _animation)

Move assignment operator.

Parameters
[in]_animationAnimation to move.
Returns
Reference to this.

◆ operator=() [2/2]

Animation& sdf::v9::Animation::operator= ( const Animation _animation)

Assignment operator.

Parameters
[in]_animationThe animation to set values from.
Returns
*this

◆ Scale()

double sdf::v9::Animation::Scale ( ) const

Get the scale for the animation skeleton.

Returns
Scale of the animation skeleton.

◆ SetFilename()

void sdf::v9::Animation::SetFilename ( const std::string &  _filename)

Set the filename of the animation.

Parameters
[in]_filenamePath to animation file.

◆ SetFilePath()

void sdf::v9::Animation::SetFilePath ( const std::string &  _filePath)

Set the path to the file where this element was loaded from.

[in] _filePath Full path to the file on disk.

◆ SetInterpolateX()

void sdf::v9::Animation::SetInterpolateX ( bool  _interpolateX)

Set whether the animation is interpolated on X.

Parameters
[in]_interpolateXTrue to indicate interpolation on X.

◆ SetName()

void sdf::v9::Animation::SetName ( const std::string &  _name)

Set the name of the animation.

Parameters
[in]_nameName of the animation.

◆ SetScale()

void sdf::v9::Animation::SetScale ( double  _scale)

Set the scale of the animation skeleton.

Parameters
[in]_scaleScale for animation skeleton.

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