Referencia de la Clase Yukino::Sprite

Clase para almacenar una sprite animado. Más...

#include <Sprite.h>

Diagrama de herencias de Yukino::Sprite

Yukino::Surface Lista de todos los miembros.

Métodos públicos

 Sprite ()
 Constructor de la clase Sprite.
 Sprite (int w, int h, int bpp, dword fps, int cols, int rows=1)
 Constructor de la clase Sprite.
 Sprite (int w, int h, int bpp, dword fps, vector< RectAux > &frames)
 Constructor de la clase Sprite.
 Sprite (const string &file)
 Constructor de la clase Sprite.
 Sprite (const char *file)
 Constructor de la clase Sprite.
 Sprite (const Sprite &obj)
 Constructor copia de la clase Sprite.
virtual Spriteoperator= (Sprite &obj)
 Operador = de la clase Sprite.
 ~Sprite ()
 Destructor de la clase Sprite.
UINT Create (int w, int h, int bpp, dword fps, int cols, int rows=1)
 Función para crear un sprite en blanco en el Sprite.
UINT Create (int w, int h, int bpp, dword fps, vector< RectAux > &frames)
 Función para crear un sprite en blanco en el Sprite.
virtual UINT Load (const char *file)
 Función para cargar un sprite de un fichero.
virtual UINT Load (const string &file)
 Función para cargar un sprite de un fichero.
virtual UINT Save (const char *file, const char *texture)
 Función para salvar un sprite en un fichero.
virtual UINT Save (const string &file, const string &texture)
 Función para salvar un sprite en un fichero.
virtual void Free (void)
 Función para liberar los datos del objeto Sprite.
dword GetFPS (void)
 Función para obtener el número de frames por segundo.
void SetFPS (dword fps)
 Función para cambiar el número de frames por segundo.
bool SetNumFrames (int cols, int rows)
 Función para cambiar el número de frames de la animación.
bool SetNumFrames (int numframes)
 Función para cambiar el número de frames de la animación.
int GetNumFrames (void) const
 Función para obtener el número de frames de la animación.
void SetFrames (vector< RectAux > &frames)
 Función para cambiar los frames de la animación.
void SetFrame (word i, sword x, sword y, word w, word h)
 Función para cambiar un frame de la animación.
void SetFrame (word i, const Rect *frame)
 Función para cambiar un frame de la animación.
void GetFrame (word i, Rect *frame) const
 Función para obtener un frame de la animación.
void SetActFrame (dword frame)
 Función para cambiar el frame actual de la animación.
dword GetActFrame (void) const
 Función para obtener el frame actual de la animación.
void NextActFrame (void)
 Función para pasar al siguiente frame de la animación.
void Update (dword time)
 Función para actualizar el frame actual de la animación.
void ResetTime (void)
 Función para poner a cero el tiempo trancurrido.

Descripción detallada

Clase para almacenar una sprite animado.

La clase Sprite sirve para almacenar en memoria un sprite animado, contenida la información de este en dos ficheros. Uno de especificación de los frames de la animación, y otro con la imagen donde están los frames.


Documentación del constructor y destructor

Yukino::Sprite::Sprite (  ) 

Constructor de la clase Sprite.

Constructor por defecto de la clase Sprite.

Ver también:
operator=(), ~Sprite().

Yukino::Sprite::Sprite ( int  w,
int  h,
int  bpp,
dword  fps,
int  cols,
int  rows = 1 
)

Constructor de la clase Sprite.

Constructor de la clase Sprite, que crea un sprite en blanco.

Parámetros:
w Ancho del sprite.
h Alto del sprite.
bpp Profundidad de color del sprite.
fps Frames por segundo del sprite.
cols Columnas del sprite.
rows Filas del sprite.
Ver también:
operator=(), ~Sprite().

Yukino::Sprite::Sprite ( int  w,
int  h,
int  bpp,
dword  fps,
vector< RectAux > &  frames 
)

Constructor de la clase Sprite.

Constructor de la clase Sprite, que crea un sprite en blanco.

Parámetros:
w Ancho del sprite.
h Alto del sprite.
bpp Profundidad de color del sprite.
fps Frames por segundo del sprite.
frames Especificación de los frames.
Ver también:
operator=(), ~Sprite().

Yukino::Sprite::Sprite ( const string &  file  ) 

Constructor de la clase Sprite.

Constructor de la clase Sprite, que carga un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
operator=(), ~Sprite().

Yukino::Sprite::Sprite ( const char *  file  ) 

Constructor de la clase Sprite.

Constructor de la clase Sprite, que carga un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
operator=(), ~Sprite().

Yukino::Sprite::Sprite ( const Sprite obj  ) 

Constructor copia de la clase Sprite.

Parámetros:
obj Objeto Sprite a copiar.
Ver también:
operator=(), ~Sprite().

Yukino::Sprite::~Sprite (  ) 

Destructor de la clase Sprite.

Ver también:
Sprite(), operator=().


Documentación de las funciones miembro

UINT Yukino::Sprite::Create ( int  w,
int  h,
int  bpp,
dword  fps,
vector< RectAux > &  frames 
)

Función para crear un sprite en blanco en el Sprite.

Esta función sirve para crear un sprite en blanco en la Sprite.

Parámetros:
w Ancho de la imagen.
h Alto de la imagen.
bpp Profundidad de color de la imagen.
fps Frames por segundo del sprite.
frames Especificación de los frames.
Ver también:
Load(), Save(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_CREATESURF.

UINT Yukino::Sprite::Create ( int  w,
int  h,
int  bpp,
dword  fps,
int  cols,
int  rows = 1 
)

Función para crear un sprite en blanco en el Sprite.

Esta función sirve para crear un sprite en blanco en la Sprite.

Parámetros:
w Ancho de la imagen.
h Alto de la imagen.
bpp Profundidad de color de la imagen.
fps Frames por segundo del sprite.
cols Columnas del sprite.
rows Filas del sprite.
Ver también:
Load(), Save(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_CREATESURF.

void Yukino::Sprite::Free ( void   )  [virtual]

Función para liberar los datos del objeto Sprite.

Esta función sirve para liberar el contenido del objeto Sprite.

Ver también:
Create(), Load(), Save().

Reimplementado de Yukino::Surface.

dword Yukino::Sprite::GetActFrame ( void   )  const [inline]

Función para obtener el frame actual de la animación.

Esta función sirve para obtener el frame actual de la animación.

Ver también:
SetActFrame().
Devuelve:
El frame actual.

dword Yukino::Sprite::GetFPS ( void   )  [inline]

Función para obtener el número de frames por segundo.

Esta función sirve para obtener la velocidad de la animación.

Ver también:
SetFPS().
Devuelve:
La velocidad de la animación.

void Yukino::Sprite::GetFrame ( word  i,
Rect frame 
) const [inline]

Función para obtener un frame de la animación.

Esta función sirve para obtener un frame de la animación.

Parámetros:
i Número del frame.
frame Propiedades del frame.
Ver también:
SetFrame().

int Yukino::Sprite::GetNumFrames ( void   )  const [inline]

Función para obtener el número de frames de la animación.

Esta función sirve para obtener el número de frames de la animación.

Ver también:
SetNumFrames().
Devuelve:
El número de frames.

virtual UINT Yukino::Sprite::Load ( const string &  file  )  [inline, virtual]

Función para cargar un sprite de un fichero.

Esta función sirve para cargar un sprite de un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
Create(), Save(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SPRITE_ERROR_FOPEN, SPRITE_ERROR_READHEADER, SPRITE_ERROR_WRONGFID, SURFACE_ERROR_RWFROMFILE, SURFACE_ERROR_UNKOWNFORMAT, SURFACE_ERROR_LOADINGFILE.

Reimplementado de Yukino::Surface.

UINT Yukino::Sprite::Load ( const char *  file  )  [virtual]

Función para cargar un sprite de un fichero.

Esta función sirve para cargar un sprite de un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
Create(), Save(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SPRITE_ERROR_FOPEN, SPRITE_ERROR_READHEADER, SPRITE_ERROR_WRONGFID, SURFACE_ERROR_RWFROMFILE, SURFACE_ERROR_UNKOWNFORMAT, SURFACE_ERROR_LOADINGFILE.

Reimplementado de Yukino::Surface.

void Yukino::Sprite::NextActFrame ( void   )  [inline]

Función para pasar al siguiente frame de la animación.

Esta función sirve para pasar al siguiente frame de la animación.

Ver también:
Update().

Sprite & Yukino::Sprite::operator= ( Sprite obj  )  [virtual]

Operador = de la clase Sprite.

Copia el objeto obj en el objeto actual, y este es devuelto.

Ver también:
Sprite(), ~Sprite().

void Yukino::Sprite::ResetTime ( void   )  [inline]

Función para poner a cero el tiempo trancurrido.

Esta función sirve para poner a cero el tiempo trancurrido.

virtual UINT Yukino::Sprite::Save ( const string &  file,
const string &  texture 
) [inline, virtual]

Función para salvar un sprite en un fichero.

Esta función sirve para salvar un sprite en un fichero.

Parámetros:
file Ruta del fichero.
texture Ruta del fichero imagen.
Ver también:
Create(), Load(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SPRITE_ERROR_FOPEN, SPRITE_ERROR_WRITEHEADER, SURFACE_ERROR_SAVINGFILE.

UINT Yukino::Sprite::Save ( const char *  file,
const char *  texture 
) [virtual]

Función para salvar un sprite en un fichero.

Esta función sirve para salvar un sprite en un fichero.

Parámetros:
file Ruta del fichero.
texture Ruta del fichero imagen.
Ver también:
Create(), Load(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SPRITE_ERROR_FOPEN, SPRITE_ERROR_WRITEHEADER, SURFACE_ERROR_SAVINGFILE.

void Yukino::Sprite::SetActFrame ( dword  frame  )  [inline]

Función para cambiar el frame actual de la animación.

Esta función sirve para cambiar el frame actual de la animación.

Parámetros:
frame Frame actual.
Ver también:
GetActFrame().

void Yukino::Sprite::SetFPS ( dword  fps  )  [inline]

Función para cambiar el número de frames por segundo.

Esta función sirve para cambiar la velocidad de la animación.

Parámetros:
fps Frames por segundo del sprite.
Ver también:
GetFPS().

void Yukino::Sprite::SetFrame ( word  i,
const Rect frame 
) [inline]

Función para cambiar un frame de la animación.

Esta función sirve para cambiar un frame de la animación.

Parámetros:
i Número del frame.
frame Propiedades del frame.
Ver también:
GetFrame().

void Yukino::Sprite::SetFrame ( word  i,
sword  x,
sword  y,
word  w,
word  h 
) [inline]

Función para cambiar un frame de la animación.

Esta función sirve para cambiar un frame de la animación.

Parámetros:
i Número del frame.
x Coordenada x del frame.
y Coordenada y del frame.
w Ancho del frame.
h Alto del frame.
Ver también:
GetFrame().

void Yukino::Sprite::SetFrames ( vector< RectAux > &  frames  )  [inline]

Función para cambiar los frames de la animación.

Esta función sirve para cambiar los frames de la animación.

Parámetros:
frames Frames de la animación.

bool Yukino::Sprite::SetNumFrames ( int  numframes  )  [inline]

Función para cambiar el número de frames de la animación.

Esta función sirve para cambiar el número de frames de la animación.

Parámetros:
numframes Número de frames.
Ver también:
GetNumFrames().

bool Yukino::Sprite::SetNumFrames ( int  cols,
int  rows 
) [inline]

Función para cambiar el número de frames de la animación.

Esta función sirve para cambiar el número de frames de la animación.

Parámetros:
cols Columnas del sprite.
rows Filas del sprite.
Ver también:
GetNumFrames().

void Yukino::Sprite::Update ( dword  time  )  [inline]

Función para actualizar el frame actual de la animación.

Esta función sirve para actualizar el frame actual de la animación.

Parámetros:
time Tiempo transcurrido.
Ver también:
NextActFrame().


La documentación para esta clase fué generada a partir de los siguientes archivos:
Generado el Sun Jun 25 03:44:44 2006 para Yukino por  doxygen 1.4.7