SCR_ImageFrameAnimationComponent Class Reference

Inheritance diagram for SCR_ImageFrameAnimationComponent:

Protected Member Functions
void	Start ()
	PUBLIC API.
void	Stop ()
void	HandlerAttached (Widget w)
void	HandlerDeattached (Widget w)
void	OnEachFrame ()
void	ShowFrame (int id)
override bool	OnUpdate (Widget w)

Protected Attributes
float	m_fFramesPerSecond
int	m_iNumFrames
int	m_iStartFrameId
string	m_sImageNameFormat
int	m_iIntToStringLen
ResourceName	m_sImageSet
float	m_fCounterMs
float	m_fMsPerFrame
int	m_iFrameId
ImageWidget	m_wRoot

Detailed Description

This component implements animation by switching textures, like in a movie. Animation frame rate can be separate from game frame rate. Images must be in image set.

You do not have to care about starting/stopping the animation when widget is shown or hidden, it will be performed automatically.

Definition at line 7 of file SCR_ImageFrameAnimationComponent.c.

Member Function Documentation

HandlerAttached()

void SCR_ImageFrameAnimationComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 67 of file SCR_ImageFrameAnimationComponent.c.

HandlerDeattached()

void SCR_ImageFrameAnimationComponent::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 103 of file SCR_ImageFrameAnimationComponent.c.

OnEachFrame()

void SCR_ImageFrameAnimationComponent::OnEachFrame ( )

inlineprotected

Definition at line 111 of file SCR_ImageFrameAnimationComponent.c.

OnUpdate()

override bool SCR_ImageFrameAnimationComponent::OnUpdate ( Widget w )

inlineprotected

Definition at line 144 of file SCR_ImageFrameAnimationComponent.c.

ShowFrame()

void SCR_ImageFrameAnimationComponent::ShowFrame ( int id )

inlineprotected

Definition at line 137 of file SCR_ImageFrameAnimationComponent.c.

Start()

void SCR_ImageFrameAnimationComponent::Start ( )

inlineprotected

PUBLIC API.

Definition at line 46 of file SCR_ImageFrameAnimationComponent.c.

Stop()

void SCR_ImageFrameAnimationComponent::Stop ( )

inlineprotected

Definition at line 61 of file SCR_ImageFrameAnimationComponent.c.

Member Data Documentation

m_fCounterMs

float SCR_ImageFrameAnimationComponent::m_fCounterMs

protected

Definition at line 31 of file SCR_ImageFrameAnimationComponent.c.

m_fFramesPerSecond

float SCR_ImageFrameAnimationComponent::m_fFramesPerSecond

protected

Definition at line 12 of file SCR_ImageFrameAnimationComponent.c.

m_fMsPerFrame

float SCR_ImageFrameAnimationComponent::m_fMsPerFrame

protected

Definition at line 32 of file SCR_ImageFrameAnimationComponent.c.

m_iFrameId

int SCR_ImageFrameAnimationComponent::m_iFrameId

protected

Definition at line 33 of file SCR_ImageFrameAnimationComponent.c.

m_iIntToStringLen

int SCR_ImageFrameAnimationComponent::m_iIntToStringLen

protected

Definition at line 24 of file SCR_ImageFrameAnimationComponent.c.

m_iNumFrames

int SCR_ImageFrameAnimationComponent::m_iNumFrames

protected

Definition at line 15 of file SCR_ImageFrameAnimationComponent.c.

m_iStartFrameId

int SCR_ImageFrameAnimationComponent::m_iStartFrameId

protected

Definition at line 18 of file SCR_ImageFrameAnimationComponent.c.

m_sImageNameFormat

string SCR_ImageFrameAnimationComponent::m_sImageNameFormat

protected

Definition at line 21 of file SCR_ImageFrameAnimationComponent.c.

m_sImageSet

ResourceName SCR_ImageFrameAnimationComponent::m_sImageSet

protected

Definition at line 27 of file SCR_ImageFrameAnimationComponent.c.

m_wRoot

ImageWidget SCR_ImageFrameAnimationComponent::m_wRoot

protected

Definition at line 35 of file SCR_ImageFrameAnimationComponent.c.

---

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

• scripts/Game/Components/SCR_ImageFrameAnimationComponent.c