Atoms Crowd  4.1.0
Atoms::Locomotions Class Reference

Locomotions manager. More...

#include <Locomotions.h>

Public Member Functions

LocomotionCPtr locomotion (const std::string &name) const
 Return a locomotion. More...
 
LocomotionPtr locomotion (const std::string &name)
 Return a locomotion. More...
 
void addLocomotion (const std::string &name, const Atoms::Locomotion &locomotion, bool replace=true)
 Add a locomotion to the map. More...
 
void addLocomotion (const std::string &name, LocomotionPtr &locomotionPtr, bool replace=true)
 Add a locomotion to the map. More...
 
void removeLocomotion (const std::string &name)
 Remove a locomotion from the map. More...
 
std::vector< std::string > locomotionNames ()
 Get all locomotion names. More...
 
bool locomotionExists (const std::string &name)
 Check if a locomotion exists. More...
 
unsigned int numLocomotions ()
 Get number of locomotions.
 
void clear ()
 Remove all locomotions.
 

Static Public Member Functions

static Locomotionsinstance ()
 Singleton access.
 

Detailed Description

Locomotions manager.

This class store locomotions.

Member Function Documentation

◆ addLocomotion() [1/2]

void Atoms::Locomotions::addLocomotion ( const std::string &  name,
const Atoms::Locomotion locomotion,
bool  replace = true 
)

Add a locomotion to the map.

Parameters
namelocomotion name \patam filePath path to clip file

◆ addLocomotion() [2/2]

void Atoms::Locomotions::addLocomotion ( const std::string &  name,
LocomotionPtr locomotionPtr,
bool  replace = true 
)

Add a locomotion to the map.

Parameters
namelocomotion name \patam filePath path to clip file

◆ locomotion() [1/2]

LocomotionPtr Atoms::Locomotions::locomotion ( const std::string &  name)

Return a locomotion.

Parameters
locomotionlocomotion name
Returns
Pointer to the locomotion stored inside this class

◆ locomotion() [2/2]

LocomotionCPtr Atoms::Locomotions::locomotion ( const std::string &  name) const

Return a locomotion.

Parameters
locomotionlocomotion name
Returns
Pointer to the locomotion stored inside this class

◆ locomotionExists()

bool Atoms::Locomotions::locomotionExists ( const std::string &  name)

Check if a locomotion exists.

Parameters
namelocomotion name
Returns
Return true if the locomotion exists

◆ locomotionNames()

std::vector<std::string> Atoms::Locomotions::locomotionNames ( )

Get all locomotion names.

Returns
List of all locomotion names

◆ removeLocomotion()

void Atoms::Locomotions::removeLocomotion ( const std::string &  name)

Remove a locomotion from the map.

Parameters
nameanination clip name

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