载入中...
搜索中...
未找到
Public 成员函数 | 友元 | 所有成员列表
eve::animation::SpriteAnim类 参考

2D sprite-sheet clip player. 更多...

#include <SpriteAnim.h>

Public 成员函数

 SpriteAnim ()
 
 ~SpriteAnim ()
 
 SpriteAnim (const SpriteAnim &)=delete
 
SpriteAnim & operator= (const SpriteAnim &)=delete
 
void setSheet (SpriteSheet *sheet)
 Optional sheet used by applyToQuad / bindQuad.
 
SpriteSheet * getSheet () const
 
void play (SpriteClip *clip)
 
void stop ()
 
void pause ()
 
void resume ()
 
void setSpeed (float speed)
 
float getSpeed () const
 
void setTime (float seconds)
 
float getTime () const
 
void setLoop (bool loop)
 
bool getLoop () const
 
bool isPlaying () const
 
bool isPaused () const
 
bool isFinished () const
 
SpriteClip * getClip () const
 
int getClipFrame () const
 Index inside the current clip (0..clipFrameCount-1), or -1.
 
int getSheetFrame () const
 Sheet frame index for the current cell, or -1.
 
void bindQuad (graphics::Quad *quad)
 Keep this Quad's viewport updated each update/play.
 
void unbindQuad ()
 
graphics::Quad * getBoundQuad () const
 
void applyToQuad (graphics::Quad *quad) const
 Write current sheet frame into quad (requires sheet).
 
bool update (float dt)
 Advance playback. Returns true while still active (playing or paused). Auto-applies to boundQuad when sheet is set.
 

友元

class Animation
 

详细描述

2D sprite-sheet clip player.

Advances frame time, optionally keeps a bound Quad in sync with the current sheet cell. Register with Animation for module-level anim.update(dt). Script type: SpriteAnim.

在文件 SpriteAnim.h 第 23 行定义.

构造及析构函数说明

◆ SpriteAnim() [1/2]

eve::animation::SpriteAnim::SpriteAnim ( )
default

◆ ~SpriteAnim()

eve::animation::SpriteAnim::~SpriteAnim ( )

在文件 SpriteAnim.cpp 第 15 行定义.

◆ SpriteAnim() [2/2]

eve::animation::SpriteAnim::SpriteAnim ( const SpriteAnim &  )
delete

成员函数说明

◆ applyToQuad()

void eve::animation::SpriteAnim::applyToQuad ( graphics::Quad *  quad) const

Write current sheet frame into quad (requires sheet).

在文件 SpriteAnim.cpp 第 81 行定义.

引用了 eve::animation::SpriteSheet::applyToQuad() , 以及 getSheetFrame().

◆ bindQuad()

void eve::animation::SpriteAnim::bindQuad ( graphics::Quad *  quad)

Keep this Quad's viewport updated each update/play.

在文件 SpriteAnim.cpp 第 74 行定义.

◆ getBoundQuad()

graphics::Quad * eve::animation::SpriteAnim::getBoundQuad ( ) const
inline

在文件 SpriteAnim.h 第 60 行定义.

◆ getClip()

SpriteClip * eve::animation::SpriteAnim::getClip ( ) const
inline

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

◆ getClipFrame()

int eve::animation::SpriteAnim::getClipFrame ( ) const
inline

Index inside the current clip (0..clipFrameCount-1), or -1.

在文件 SpriteAnim.h 第 53 行定义.

◆ getLoop()

bool eve::animation::SpriteAnim::getLoop ( ) const

在文件 SpriteAnim.cpp 第 65 行定义.

引用了 eve::animation::SpriteClip::getLoop().

被这些函数引用 update().

◆ getSheet()

SpriteSheet * eve::animation::SpriteAnim::getSheet ( ) const
inline

在文件 SpriteAnim.h 第 33 行定义.

◆ getSheetFrame()

int eve::animation::SpriteAnim::getSheetFrame ( ) const

Sheet frame index for the current cell, or -1.

在文件 SpriteAnim.cpp 第 69 行定义.

引用了 eve::animation::SpriteClip::getSheetFrame().

被这些函数引用 applyToQuad().

◆ getSpeed()

float eve::animation::SpriteAnim::getSpeed ( ) const
inline

在文件 SpriteAnim.h 第 41 行定义.

◆ getTime()

float eve::animation::SpriteAnim::getTime ( ) const
inline

在文件 SpriteAnim.h 第 43 行定义.

◆ isFinished()

bool eve::animation::SpriteAnim::isFinished ( ) const
inline

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

◆ isPaused()

bool eve::animation::SpriteAnim::isPaused ( ) const
inline

在文件 SpriteAnim.h 第 48 行定义.

◆ isPlaying()

bool eve::animation::SpriteAnim::isPlaying ( ) const
inline

在文件 SpriteAnim.h 第 47 行定义.

◆ operator=()

SpriteAnim & eve::animation::SpriteAnim::operator= ( const SpriteAnim &  )
delete

◆ pause()

void eve::animation::SpriteAnim::pause ( )

在文件 SpriteAnim.cpp 第 40 行定义.

◆ play()

void eve::animation::SpriteAnim::play ( SpriteClip *  clip)

在文件 SpriteAnim.cpp 第 21 行定义.

◆ resume()

void eve::animation::SpriteAnim::resume ( )

在文件 SpriteAnim.cpp 第 44 行定义.

◆ setLoop()

void eve::animation::SpriteAnim::setLoop ( bool  loop)

在文件 SpriteAnim.cpp 第 60 行定义.

◆ setSheet()

void eve::animation::SpriteAnim::setSheet ( SpriteSheet *  sheet)

Optional sheet used by applyToQuad / bindQuad.

在文件 SpriteAnim.cpp 第 19 行定义.

◆ setSpeed()

void eve::animation::SpriteAnim::setSpeed ( float  speed)

在文件 SpriteAnim.cpp 第 48 行定义.

◆ setTime()

void eve::animation::SpriteAnim::setTime ( float  seconds)

在文件 SpriteAnim.cpp 第 53 行定义.

◆ stop()

void eve::animation::SpriteAnim::stop ( )

在文件 SpriteAnim.cpp 第 32 行定义.

◆ unbindQuad()

void eve::animation::SpriteAnim::unbindQuad ( )

在文件 SpriteAnim.cpp 第 79 行定义.

◆ update()

bool eve::animation::SpriteAnim::update ( float  dt)

Advance playback. Returns true while still active (playing or paused). Auto-applies to boundQuad when sheet is set.

在文件 SpriteAnim.cpp 第 131 行定义.

引用了 eve::animation::SpriteClip::getDuration() , 以及 getLoop().

友元及相关函数文档

◆ Animation

friend class Animation
friend

在文件 SpriteAnim.h 第 72 行定义.

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