TSpriteWorld Class Reference

CLASS TSpriteWorld, wrapping SpriteWorldPtr. More...

#include <SpriteWorld.hpp>

Inheritance diagram for TSpriteWorld:

List of all members.

Public Member Functions
SpriteWorldPtr	ptr () throw ()
	TSpriteWorld () throw ()
	TSpriteWorld (SpriteWorldPtr inWorld) throw ()
	TSpriteWorld (const TSpriteWorld &inWorld) throw ()
	~TSpriteWorld () throw ()
const TSpriteWorld &	operator= (const TSpriteWorld &inWorld) throw ()
void	dispose () throw ()
void	lock () throw ()
void	unlock () throw ()
void	copyBackgroundToWorkArea () throw ()
void	update (bool inUpdateWindow) throw ()
void	process () throw ()
void	animate () throw ()
void	maxFps (short inFramesPerSec) throw ()
void	add (TSpriteLayer &inLayer) throw ()
void	remove (TSpriteLayer &inLayer) throw ()
void	swap (TSpriteLayer &inSrcLayer, TSpriteLayer &inDsTSpriteLayer) throw ()
TSpriteLayer	next (TSpriteLayer &inLayer) throw ()
TSprite	createSpriteFromFile (const char *file, long inMaxFrames) throw (std::runtime_error)
DrawDataPtr	createDrawData () throw ()
void	collide (TSpriteLayer &inLayerSrc, TSpriteLayer &inLayerDst) throw ()
const short	pixelDepth () const throw ()
const unsigned long	milliSeconds () const throw ()
TFrame	workFrame () const throw ()
const SWRect &	backRect () const throw ()
const bool	frameHasOccurred () const throw ()
Static Public Member Functions
static unsigned long	GetSpriteWorldVersion () throw ()
static void	Enter (bool shouldInit) throw (std::runtime_error)
static void	Exit () throw ()
static TSpriteWorld	CreateSpriteWorld (int w, int h, int depth, bool fullscreen, bool opengl) throw (std::runtime_error)
static TSpriteWorld	CreateSpriteWorldFromVideoSurface (SDL_Surface *surface, SWRect &world, SWRect &back, int maxDepth) throw (std::runtime_error)
static TSpriteWorld	CreateSpriteWorldFromSWSurface (SDL_Surface *surface, SWRectPtr world=NULL, SWRectPtr back=NULL, int maxDepth=0) throw (std::runtime_error)
static TSpriteWorld	CreateSpriteWorldFromGLContext (void *glContext, SWRect &world, GLCallBackPtr glMakeCurrent, GLCallBackPtr glSwapBuffers) throw (std::runtime_error)
static TSpriteWorld	CreateSpriteWorldFromFrames (TFrame &screen, TFrame &back, TFrame &work) throw (std::runtime_error)
Protected Attributes
SpriteWorldPtr	mWorld

---

Detailed Description

CLASS TSpriteWorld, wrapping SpriteWorldPtr.

---

Constructor & Destructor Documentation

TSpriteWorld::TSpriteWorld (   )  throw () [inline]

TSpriteWorld::TSpriteWorld (  SpriteWorldPtr  inWorld  )  throw () [inline]

TSpriteWorld::TSpriteWorld (  const TSpriteWorld &  inWorld  )  throw () [inline]

TSpriteWorld::~TSpriteWorld (   )  throw () [inline]

---

Member Function Documentation

void TSpriteWorld::add (  TSpriteLayer &  inLayer  )  throw () [inline]

void TSpriteWorld::animate (   )  throw () [inline]

See also: SWAnimateSpriteWorld Reimplemented in TSpriteWorldScrolling.

const SWRect & TSpriteWorld::backRect (   )  const throw () [inline]

void TSpriteWorld::collide (  TSpriteLayer &  inLayerSrc, TSpriteLayer &  inLayerDst )  throw () [inline]

void TSpriteWorld::copyBackgroundToWorkArea (   )  throw () [inline]

DrawDataPtr TSpriteWorld::createDrawData (   )  throw () [inline]

TSprite TSpriteWorld::createSpriteFromFile (  const char *  file, long  inMaxFrames )  throw (std::runtime_error) [inline]

TSpriteWorld TSpriteWorld::CreateSpriteWorld (  int  w, int  h, int  depth, bool  fullscreen, bool  opengl )  throw (std::runtime_error) [inline, static]

See also: SWCreateSpriteWorld

TSpriteWorld TSpriteWorld::CreateSpriteWorldFromFrames (  TFrame &  screen, TFrame &  back, TFrame &  work )  throw (std::runtime_error) [inline, static]

See also: SWCreateSpriteWorldFromFrames

TSpriteWorld TSpriteWorld::CreateSpriteWorldFromGLContext (  void *  glContext, SWRect &  world, GLCallBackPtr  glMakeCurrent, GLCallBackPtr  glSwapBuffers )  throw (std::runtime_error) [inline, static]

See also: SWCreateSpriteWorldFromGLContext

TSpriteWorld TSpriteWorld::CreateSpriteWorldFromSWSurface (  SDL_Surface *  surface, SWRectPtr  world = NULL, SWRectPtr  back = NULL, int  maxDepth = 0 )  throw (std::runtime_error) [inline, static]

See also: SWCreateSpriteWorldFromSWSurface

TSpriteWorld TSpriteWorld::CreateSpriteWorldFromVideoSurface (  SDL_Surface *  surface, SWRect &  world, SWRect &  back, int  maxDepth )  throw (std::runtime_error) [inline, static]

See also: SWCreateSpriteWorldFromVideoSurface

void TSpriteWorld::dispose (   )  throw () [inline]

See also: SWDisposeSpriteWorld

void TSpriteWorld::Enter (  bool  shouldInit  )  throw (std::runtime_error) [inline, static]

See also: SWEnterSpriteWorld

void TSpriteWorld::Exit (   )  throw () [inline, static]

See also: SWExitSpriteWorld

const bool TSpriteWorld::frameHasOccurred (   )  const throw () [inline]

unsigned long TSpriteWorld::GetSpriteWorldVersion (   )  throw () [inline, static]

See also: SWGetSpriteWorldVersion

void TSpriteWorld::lock (   )  throw () [inline]

See also: SWLockSpriteWorld Reimplemented in TSpriteWorldTiling.

void TSpriteWorld::maxFps (  short  inFramesPerSec  )  throw () [inline]

const unsigned long TSpriteWorld::milliSeconds (   )  const throw () [inline]

TSpriteLayer TSpriteWorld::next (  TSpriteLayer &  inLayer  )  throw () [inline]

const TSpriteWorld & TSpriteWorld::operator= (  const TSpriteWorld &  inWorld  )  throw () [inline]

const short TSpriteWorld::pixelDepth (   )  const throw () [inline]

void TSpriteWorld::process (   )  throw () [inline]

See also: SWProcessSpriteWorld Reimplemented in TSpriteWorldScrolling.

SpriteWorldPtr TSpriteWorld::ptr (   )  throw () [inline]

void TSpriteWorld::remove (  TSpriteLayer &  inLayer  )  throw () [inline]

void TSpriteWorld::swap (  TSpriteLayer &  inSrcLayer, TSpriteLayer &  inDsTSpriteLayer )  throw () [inline]

void TSpriteWorld::unlock (   )  throw () [inline]

See also: SWUnlockSpriteWorld Reimplemented in TSpriteWorldTiling.

void TSpriteWorld::update (  bool  inUpdateWindow  )  throw () [inline]

See also: SWUpdateSpriteWorld

TFrame TSpriteWorld::workFrame (   )  const throw () [inline]

---

Member Data Documentation

SpriteWorldPtr TSpriteWorld::mWorld [protected]

---