Sprite Class Reference

#include <Sprite.h>

Inheritance diagram for Sprite:

[legend]Collaboration diagram for Sprite:

[legend]List of all members.

Public Member Functions
	Sprite ()
virtual	~Sprite ()
virtual bool	EarlyAbortDraw ()
virtual void	DrawPrimitives ()
virtual void	Update (float fDeltaTime)
virtual void	GainFocus (float fRate, bool bRewindMovie, bool bLoop)
virtual void	LoseFocus ()
void	UpdateAnimationState ()
virtual bool	LoadBG (RageTextureID ID)
virtual bool	Load (RageTextureID ID)
void	UnloadTexture ()
RageTexture *	GetTexture ()
virtual void	EnableAnimation (bool bEnable)
virtual int	GetNumStates () const
virtual void	SetState (int iNewState)
virtual float	GetAnimationLengthSeconds () const
virtual void	SetSecondsIntoAnimation (float fSeconds)
CString	GetTexturePath () const
void	SetCustomTextureRect (const RectF &new_texcoord_frect)
void	SetCustomTextureCoords (float fTexCoords[8])
void	SetCustomSourceRect (const RectF &rectSourceCoords)
void	SetCustomImageRect (RectF rectImageCoords)
void	SetCustomImageCoords (float fImageCoords[8])
const RectF *	GetCurrentTextureCoordRect () const
void	StopUsingCustomCoords ()
void	GetActiveTextureCoords (float fTexCoordsOut[8]) const
void	StretchTexCoords (float fX, float fY)
void	SetPosition (float f)
void	SetLooping (bool b)
void	SetPlaybackRate (float f)
void	SetTexCoordVelocity (float fVelX, float fVelY)
void	ScaleToClipped (float fWidth, float fHeight)
virtual void	PushSelf (lua_State *L)
Static Public Member Functions
RageTextureID	SongBGTexture (RageTextureID ID)
RageTextureID	SongBannerTexture (RageTextureID ID)
bool	IsDiagonalBanner (int iWidth, int iHeight)
Protected Member Functions
virtual bool	LoadFromTexture (RageTextureID ID)
virtual bool	LoadFromSpriteFile (RageTextureID ID)
void	DrawTexture (const TweenState *state)
Protected Attributes
CString	m_sSpritePath
RageTexture *	m_pTexture
bool	m_bDrawIfTextureNull
vector< State >	m_States
int	m_iCurState
float	m_fSecsIntoState
bool	m_bUsingCustomTexCoords
bool	m_bSkipNextUpdate
float	m_CustomTexCoords [8]
float	m_fRememberedClipWidth
float	m_fRememberedClipHeight
float	m_fTexCoordVelocityX
float	m_fTexCoordVelocityY

---

Constructor & Destructor Documentation

Sprite::Sprite (   )

Sprite::~Sprite (   )  [virtual]

---

Member Function Documentation

void Sprite::DrawPrimitives (   )  [virtual]

Reimplemented from Actor. Reimplemented in GradeDisplay.

void Sprite::DrawTexture (  const TweenState *  state  )  [protected]

bool Sprite::EarlyAbortDraw (   )  [virtual]

Reimplemented from Actor. Reimplemented in DifficultyIcon, HoldGhostArrow, and WheelNotifyIcon.

void Sprite::EnableAnimation (  bool  bEnable  )  [virtual]

Reimplemented from Actor.

void Sprite::GainFocus (  float  fRate, bool  bRewindMovie, bool  bLoop )  [virtual]

Reimplemented from Actor.

void Sprite::GetActiveTextureCoords (  float  fTexCoordsOut[8]  )  const

float Sprite::GetAnimationLengthSeconds (   )  const [virtual]

Reimplemented from Actor.

const RectF * Sprite::GetCurrentTextureCoordRect (   )  const

int Sprite::GetNumStates (   )  const [virtual]

Reimplemented from Actor.

RageTexture* Sprite::GetTexture (   )  [inline]

CString Sprite::GetTexturePath (   )  const

bool Sprite::IsDiagonalBanner (  int  iWidth, int  iHeight )  [static]

bool Sprite::Load (  RageTextureID  ID  )  [virtual]

Reimplemented in Banner, and GradeDisplay.

bool Sprite::LoadBG (  RageTextureID  ID  )  [virtual]

bool Sprite::LoadFromSpriteFile (  RageTextureID  ID  )  [protected, virtual]

bool Sprite::LoadFromTexture (  RageTextureID  ID  )  [protected, virtual]

void Sprite::LoseFocus (   )  [virtual]

Reimplemented from Actor.

void Sprite::PushSelf (  lua_State *  L  )  [virtual]

Reimplemented from Actor.

void Sprite::ScaleToClipped (  float  fWidth, float  fHeight )

void Sprite::SetCustomImageCoords (  float  fImageCoords[8]  )

void Sprite::SetCustomImageRect (  RectF  rectImageCoords  )

void Sprite::SetCustomSourceRect (  const RectF &  rectSourceCoords  )

void Sprite::SetCustomTextureCoords (  float  fTexCoords[8]  )

void Sprite::SetCustomTextureRect (  const RectF &  new_texcoord_frect  )

void Sprite::SetLooping (  bool  b  )

void Sprite::SetPlaybackRate (  float  f  )

void Sprite::SetPosition (  float  f  )

void Sprite::SetSecondsIntoAnimation (  float  fSeconds  )  [virtual]

Reimplemented from Actor.

void Sprite::SetState (  int  iNewState  )  [virtual]

Reimplemented from Actor.

void Sprite::SetTexCoordVelocity (  float  fVelX, float  fVelY )  [inline]

RageTextureID Sprite::SongBannerTexture (  RageTextureID  ID  )  [static]

RageTextureID Sprite::SongBGTexture (  RageTextureID  ID  )  [static]

void Sprite::StopUsingCustomCoords (   )

void Sprite::StretchTexCoords (  float  fX, float  fY )

void Sprite::UnloadTexture (   )

void Sprite::Update (  float  fDeltaTime  )  [virtual]

Reimplemented from Actor. Reimplemented in Banner, CharacterHead, GradeDisplay, HoldGhostArrow, and WheelNotifyIcon.

void Sprite::UpdateAnimationState (   )

---

Member Data Documentation

bool Sprite::m_bDrawIfTextureNull [protected]

bool Sprite::m_bSkipNextUpdate [protected]

bool Sprite::m_bUsingCustomTexCoords [protected]

float Sprite::m_CustomTexCoords[8] [protected]

float Sprite::m_fRememberedClipHeight [protected]

float Sprite::m_fRememberedClipWidth [protected]

float Sprite::m_fSecsIntoState [protected]

float Sprite::m_fTexCoordVelocityX [protected]

float Sprite::m_fTexCoordVelocityY [protected]

int Sprite::m_iCurState [protected]

RageTexture* Sprite::m_pTexture [protected]

CString Sprite::m_sSpritePath [protected]

vector<State> Sprite::m_States [protected]

---

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

• Sprite.h
• Sprite.cpp

---