SCR_ImageFrameAnimationComponent Interface Reference

This component implements animation by switching textures, like in a movie. More...

Inheritance diagram for SCR_ImageFrameAnimationComponent:

Public Member Functions
void	Start ()
	PUBLIC API.
void	Stop ()
override bool	OnUpdate (Widget w)

Protected Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
void	OnEachFrame ()
void	ShowFrame (int id)

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.

Member Function Documentation

HandlerAttached()

override void SCR_ImageFrameAnimationComponent.HandlerAttached ( Widget w )

protected

HandlerDeattached()

override void SCR_ImageFrameAnimationComponent.HandlerDeattached ( Widget w )

protected

OnEachFrame()

void SCR_ImageFrameAnimationComponent.OnEachFrame ( )

protected

OnUpdate()

override bool SCR_ImageFrameAnimationComponent.OnUpdate

(

Widget

w

)

ShowFrame()

void SCR_ImageFrameAnimationComponent.ShowFrame ( int id )

protected

Start()

void SCR_ImageFrameAnimationComponent.Start

(

)

PUBLIC API.

Stop()

void SCR_ImageFrameAnimationComponent.Stop

(

)

Member Data Documentation

m_fCounterMs

float SCR_ImageFrameAnimationComponent.m_fCounterMs

protected

m_fFramesPerSecond

float SCR_ImageFrameAnimationComponent.m_fFramesPerSecond

protected

m_fMsPerFrame

float SCR_ImageFrameAnimationComponent.m_fMsPerFrame

protected

m_iFrameId

int SCR_ImageFrameAnimationComponent.m_iFrameId

protected

m_iIntToStringLen

int SCR_ImageFrameAnimationComponent.m_iIntToStringLen

protected

m_iNumFrames

int SCR_ImageFrameAnimationComponent.m_iNumFrames

protected

m_iStartFrameId

int SCR_ImageFrameAnimationComponent.m_iStartFrameId

protected

m_sImageNameFormat

string SCR_ImageFrameAnimationComponent.m_sImageNameFormat

protected

m_sImageSet

ResourceName SCR_ImageFrameAnimationComponent.m_sImageSet

protected

m_wRoot

ImageWidget SCR_ImageFrameAnimationComponent.m_wRoot

protected

---

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

• Game/Components/SCR_ImageFrameAnimationComponent.c