eve::animation::IAnimPoseSource类 参考

Borrowed pose provider consumed by AnimLayerMixer. 更多...

#include <AnimPoseSource.h>

类 eve::animation::IAnimPoseSource 继承关系图:

Public 成员函数
virtual	~IAnimPoseSource ()=default
	Releases IAnimPoseSource resources.
virtual AnimSkeleton *	getSkeleton () const =0
	Skeleton this source evaluates against; never null while attached. @ownership Borrowed @lifetime Valid while the owning animation object remains alive; do not retain across destruction.
virtual AnimPose *	getPose ()=0
	Most recent local pose; valid after a successful advance. @ownership Borrowed @lifetime Valid while the owning animation object remains alive; do not retain across destruction.
virtual eve::Result< void >	advance (const eve::SimulationStep &step)=0
	Consume one scheduler step and refresh getPose().
virtual bool	hasCurrentTick () const noexcept=0
	Whether advance has consumed at least one checked step.
virtual eve::SimulationTick	currentTick () const noexcept=0
	Last scheduler tick consumed by advance.
virtual int	getEventCount () const
	Events emitted by the most recent advance; default is none.
virtual std::string	getEventName (int) const
virtual std::string	getEventPayload (int) const

详细描述

Borrowed pose provider consumed by AnimLayerMixer.

Implementations are not owned by the mixer. Callers must keep the source alive for as long as it remains attached as a base or layer. advance must be invoked by the mixer (or an equivalent evaluation owner); do not also advance the same source with the same tick elsewhere.

在文件 AnimPoseSource.h 第 20 行定义.

构造及析构函数说明

~IAnimPoseSource()

virtual eve::animation::IAnimPoseSource::~IAnimPoseSource ( )

virtualdefault

Releases IAnimPoseSource resources.

成员函数说明

advance()

virtual eve::Result< void > eve::animation::IAnimPoseSource::advance ( const eve::SimulationStep &  step )

pure virtual

Consume one scheduler step and refresh getPose().

在 eve::animation::AnimGraph, eve::animation::AnimLayerMixer, eve::animation::AnimPlayer , 以及 eve::animation::AnimStateMachine 内被实现.

被这些函数引用 eve::animation::AnimLayerMixer::advance().

currentTick()

virtual eve::SimulationTick eve::animation::IAnimPoseSource::currentTick ( ) const

pure virtualnoexcept

Last scheduler tick consumed by advance.

在 eve::animation::AnimGraph, eve::animation::AnimLayerMixer, eve::animation::AnimPlayer , 以及 eve::animation::AnimStateMachine 内被实现.

被这些函数引用 eve::animation::AnimLayerMixer::advance().

getEventCount()

virtual int eve::animation::IAnimPoseSource::getEventCount ( ) const

inlinevirtual

Events emitted by the most recent advance; default is none.

被 eve::animation::AnimLayerMixer , 以及 eve::animation::AnimPlayer 重载.

在文件 AnimPoseSource.h 第 49 行定义.

getEventName()

virtual std::string eve::animation::IAnimPoseSource::getEventName ( int  ) const

inlinevirtual

被 eve::animation::AnimLayerMixer , 以及 eve::animation::AnimPlayer 重载.

在文件 AnimPoseSource.h 第 50 行定义.

getEventPayload()

virtual std::string eve::animation::IAnimPoseSource::getEventPayload ( int  ) const

inlinevirtual

被 eve::animation::AnimLayerMixer , 以及 eve::animation::AnimPlayer 重载.

在文件 AnimPoseSource.h 第 51 行定义.

getPose()

virtual AnimPose * eve::animation::IAnimPoseSource::getPose ( )

pure virtual

Most recent local pose; valid after a successful advance. @ownership Borrowed @lifetime Valid while the owning animation object remains alive; do not retain across destruction.

在 eve::animation::AnimGraph, eve::animation::AnimLayerMixer, eve::animation::AnimPlayer , 以及 eve::animation::AnimStateMachine 内被实现.

getSkeleton()

virtual AnimSkeleton * eve::animation::IAnimPoseSource::getSkeleton ( ) const

pure virtual

Skeleton this source evaluates against; never null while attached. @ownership Borrowed @lifetime Valid while the owning animation object remains alive; do not retain across destruction.

在 eve::animation::AnimGraph, eve::animation::AnimLayerMixer, eve::animation::AnimPlayer , 以及 eve::animation::AnimStateMachine 内被实现.

hasCurrentTick()

virtual bool eve::animation::IAnimPoseSource::hasCurrentTick ( ) const

pure virtualnoexcept

Whether advance has consumed at least one checked step.

在 eve::animation::AnimGraph, eve::animation::AnimLayerMixer, eve::animation::AnimPlayer , 以及 eve::animation::AnimStateMachine 内被实现.

被这些函数引用 eve::animation::AnimLayerMixer::advance().

---

该类的文档由以下文件生成:

• src/modules/animation/AnimPoseSource.h