Anim 0.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
AnimationSystem::Mesh::AnimationContainer Class Referencefinal
Inheritance diagram for AnimationSystem::Mesh::AnimationContainer:
Collaboration diagram for AnimationSystem::Mesh::AnimationContainer:

Public Member Functions

 AnimationContainer (gef::Platform const &platform)
 
ValueResult< string > LoadAnimations (StringId skinnedMeshOwningAnimation, string const &animationName, std::string const &filepath, std::string const &nameWithinFile, const OptionalConfigOnSetAnimationDelegate &configurationDelegate)
 Load a new animation. More...
 
ValueResult< std::reference_wrapper< AnimationClip > > GetAnimation (StringId skinnedMeshOwningAnimation, string const &name) const override
 Gets an animation. More...
 
virtual ValueResult< std::reference_wrapper< AnimationClip > > GetAnimation (StringId skinnedMeshOwningAnimation, string const &name) const =0
 Gets an animation. More...
 

Member Function Documentation

◆ GetAnimation()

ValueResult< std::reference_wrapper< AnimationClip > > AnimationSystem::Mesh::AnimationContainer::GetAnimation ( StringId  skinnedMeshOwningAnimation,
string const &  name 
) const
overridevirtual

Gets an animation.

Parameters
skinnedMeshOwningAnimationThe skinned mesh that the animation would animate
nameThe name of the animation
Returns
The animation or an ERROR if the animation does not exist

Implements AnimationSystem::Mesh::IReadOnlyAnimationContainer.

◆ LoadAnimations()

ValueResult< string > AnimationSystem::Mesh::AnimationContainer::LoadAnimations ( StringId  skinnedMeshOwningAnimation,
string const &  animationName,
std::string const &  filepath,
std::string const &  nameWithinFile,
const OptionalConfigOnSetAnimationDelegate &  configurationDelegate 
)

Load a new animation.

Parameters
skinnedMeshOwningAnimationThe skinned mesh that the animation would animate
animationNameThe name of the animation
filepathThe full filepath of the animation file
nameWithinFile(Optional) The name of the animation within the file if the file contains multiple animations
configurationDelegate(Optional) A delegate that will be called on the animator running this animation when the animator is set to this animation. Used for initial set-up such as setting the animator to loop on this animation
Returns
The result of the operation

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