AnimationSystem::Mesh::AnimationPlayer Class Reference

A class responsible for playing animation clips. More...

#include <AnimationPlayer.h>

Inheritance diagram for AnimationSystem::Mesh::AnimationPlayer:

Collaboration diagram for AnimationSystem::Mesh::AnimationPlayer:

Public Member Functions
void	Init (gef::SkeletonPose const &skeletonPose)
	Set the base pose for the skeleton this animator animates.
gef::SkeletonPose	UpdateAnimation (float deltaTime)
PureResult	SetAnimation (AnimationClip const &animation)
PureResult	SetAnimationFromAnimatorCurrentAnimation (AnimationPlayer const &animator)
void	SetAnimationTime (float const animationTime) override
void	SetAnimationTimeAsPercentOfDuration (NormalisedFloat const animationPercent) override
void	SetPlaybackSpeed (float const playbackSpeed) override
void	SetLooping (bool const isLooping) override
void	SetAnimationTimePercent (float percent)
float	GetCurrentAnimationProgressPercent () const override
float	GetCurrentClipDuration () const override
float	GetPercentageSpeedWhereDurationsWillMatch (IAnimationPlayerConfig const &otherAnimator) const override
bool	HasAnimation () const
virtual void	SetAnimationTime (float animationTime)=0
virtual void	SetAnimationTimeAsPercentOfDuration (NormalisedFloat animationPercent)=0
virtual void	SetPlaybackSpeed (float playbackSpeed)=0
virtual void	SetLooping (bool isLooping)=0
virtual float	GetCurrentClipDuration () const =0
virtual float	GetCurrentAnimationProgressPercent () const =0
virtual float	GetPercentageSpeedWhereDurationsWillMatch (IAnimationPlayerConfig const &otherAnimator) const =0

Detailed Description

A class responsible for playing animation clips.

Member Function Documentation

GetCurrentAnimationProgressPercent()

float AnimationSystem::Mesh::AnimationPlayer::GetCurrentAnimationProgressPercent ( ) const

overridevirtual

Returns

The current percent through the animation

Implements AnimationSystem::Mesh::IAnimationPlayerConfig.

GetCurrentClipDuration()

float AnimationSystem::Mesh::AnimationPlayer::GetCurrentClipDuration ( ) const

overridevirtual

Returns

Duration of the current animation in seconds

Implements AnimationSystem::Mesh::IAnimationPlayerConfig.

GetPercentageSpeedWhereDurationsWillMatch()

float AnimationSystem::Mesh::AnimationPlayer::GetPercentageSpeedWhereDurationsWillMatch ( IAnimationPlayerConfig const &  otherAnimator ) const

overridevirtual

Returns

this animation duration divided by provided animator's animation duration

Implements AnimationSystem::Mesh::IAnimationPlayerConfig.

SetAnimationTime()

void AnimationSystem::Mesh::AnimationPlayer::SetAnimationTime ( float const  animationTime )

inlineoverridevirtual

Implements AnimationSystem::Mesh::IAnimationPlayerConfig.

SetAnimationTimeAsPercentOfDuration()

void AnimationSystem::Mesh::AnimationPlayer::SetAnimationTimeAsPercentOfDuration ( NormalisedFloat const  animationPercent )

inlineoverridevirtual

Implements AnimationSystem::Mesh::IAnimationPlayerConfig.

SetLooping()

void AnimationSystem::Mesh::AnimationPlayer::SetLooping ( bool const  isLooping )

inlineoverridevirtual

Implements AnimationSystem::Mesh::IAnimationPlayerConfig.

SetPlaybackSpeed()

void AnimationSystem::Mesh::AnimationPlayer::SetPlaybackSpeed ( float const  playbackSpeed )

inlineoverridevirtual

Implements AnimationSystem::Mesh::IAnimationPlayerConfig.

---

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

• C:/Users/Jay Bretherton/Documents/GitHub/418/Projects/animated_mesh/build/vs2017/AnimationSystemMesh/AnimationPlayer.h
• C:/Users/Jay Bretherton/Documents/GitHub/418/Projects/animated_mesh/build/vs2017/AnimationSystemMesh/AnimationPlayer.cpp