目录

AnimationComponent

Class Info

class AnimationComponent : public IComponent

动画组件类,主要提供动画组件的播放、暂停、停止及每帧更新,设置动画播放速度及播放模式等功能。

Public Constructor Summary

Constructor Name

AnimationComponent(SceneObject* object)

构造函数。

Public Destructor Summary

Destructor Name

virtual ~AnimationComponent()

析构函数。

Public Method Summary

Qualifier and Type

Method Name and Description

bool

Play(const String& name)

播放指定名称的动画。

void

Pause()

暂停动画。

void

Stop()

停止动画。

virtual void

Update(f32 deltaTime) override

更新动画。

void

SetSpeed(f32 speed)

设置播放速度。

f32

GetSpeed() const

获取播放速度。

void

SetPlayMode(const AnimationPlayMode mode)

设置播放模式。

AnimationPlayMode

GetPlayMode() const

获取播放模式。

Public Constructors

[h2]AnimationComponent

Constructor

AnimationComponent(SceneObject* object)

构造函数。

Parameters

Name

Description

object

指定初始化的场景对象。

Public Destructors

[h2]~AnimationComponent

Destructor

virtual ~AnimationComponent()

析构函数。

Public Methods

[h2]Play

Method

bool Play(const String& name)

播放指定名称的动画。如果找不到指定名称的动画,则会播放文件中第一个动画。

Parameters

Name

Description

name

需要指定播放的动画名称。

Returns

Type

Description

bool

  • true:找到指定名称的动画。
  • false:未找到指定名称的动画。

[h2]Pause

Method

void Pause()

暂停动画,维持动画当前帧的状态。

[h2]Stop

Method

void Stop()

停止动画,维持动画第0帧的状态。

[h2]Update

Method

virtual void Update(f32 deltaTime) override

更新动画。

Parameters

Name

Description

deltaTime

帧间隔时间,单位为秒。

[h2]SetSpeed

Method

void SetSpeed(f32 speed)

设置播放速度。

Parameters

Name

Description

speed

需要设置的播放速度,要求大于零。

[h2]GetSpeed

Method

f32 GetSpeed()

获取播放速度。

Returns

Type

Description

f32

获取到的播放速度。

[h2]SetPlayMode

Method

void SetPlayMode(const AnimationPlayMode mode)

设置播放模式。

Parameters

Name

Description

mode

播放模式。默认值为ANIMATION_PLAY_MODE_LOOP。

[h2]GetPlayMode

Method

AnimationPlayMode GetPlayMode() const

获取播放模式。

Returns

Type

Description

AnimationPlayMode

获取到的播放模式。具体请参见AnimationPlayMode。