PPL6-Icon Patrick's Programming Library Version 6.4.21 - Dokumentation
Aufstellung aller Elemente | Öffentliche Methoden | Private Methoden | Private Attribute
ppl6::grafix::CSprite Klassenreferenz
Grafik

Klasse zum Anzeigen von Sprites. Mehr ...

Öffentliche Methoden

 CSprite ()
 Konstruktor der Klasse. Mehr ...
 
 ~CSprite ()
 Destruktor der Klasse. Mehr ...
 
void clear ()
 Speicherbereiche der Klasse wieder freigeben. Mehr ...
 
int draw (CSurface &target, int x, int y, int id) const
 Sprite darstellen. Mehr ...
 
int draw (CDrawable &target, int x, int y, int id) const
 Sprite darstellen. Mehr ...
 
int load (const CString &filename, CSurface::SurfaceFlags flags)
 Laden einer Textur-Datei. Mehr ...
 
int load (CFileObject &ff, CSurface::SurfaceFlags flags)
 Laden einer Textur-Datei. Mehr ...
 
int numSprites () const
 Anzahl Sprites in der Klasse. Mehr ...
 
int numTextures () const
 Anzahl Texturen in der Klasse. Mehr ...
 

Private Methoden

CSurface * findTexture (int id)
 Textur anhand ihrer ID finden. Mehr ...
 
int loadIndex (PFPChunk *chunk)
 Laden des Sprite-Index. Mehr ...
 
int loadTexture (PFPChunk *chunk, CSurface::SurfaceFlags flags)
 Laden eines Texture-Chunks. Mehr ...
 

Private Attribute

CTree SpriteList
 Liste aller Sprites. Mehr ...
 
CList TextureList
 Liste aller Texturen. Mehr ...
 

Ausführliche Beschreibung

Beschreibung:
Diese Klasse kann zum Laden und Anzeigen von Sprites verwendet werden, die im PFP-Sprite-Texture-Format vorliegen.
Seit
Die Klasse wurde mit Version 6.2.4 eingeführt.

Beschreibung der Konstruktoren und Destruktoren

ppl6::grafix::CSprite::CSprite ( )
Beschreibung:
Dies ist der Konstruktor der Klasse. Gegenwärtig werden hier jedoch keinerlei Daten initialisiert.
ppl6::grafix::CSprite::~CSprite ( )
Beschreibung:
Dies ist der Destruktor der Klasse. Er ruft die Clear-Funktion auf, um sicherzustellen, dass sämtliche Texturen und Speicherbereiche der Klasse wieder freigegeben werden.

Dokumentation der Elementfunktionen

void ppl6::grafix::CSprite::clear ( )
Beschreibung:
Diese Funktion sorgt dafür, dass sämtlicher durch die Klasse allokierter Speicher und Texturen wieder freigegeben werden.
int ppl6::grafix::CSprite::draw ( CSurface &  target,
int  x,
int  y,
int  id 
) const
Beschreibung:
Mit dieser Funktion wird ein beliebiges Sprite auf dem Ziel-Surface angezeigt.
Parameter
[in]targetZiel-Surface
[in]xX-Koordinate, bei der das Sprite gezeichnet werden soll
[in]yY-Koordinate, bei der das Sprite gezeichnet werden soll
[in]idID des anzuzeigenden Sprites
Rückgabe
Bei Erfolg liefert die Funktion 1 zurück, im Fehlerfall 0.
int ppl6::grafix::CSprite::draw ( CDrawable &  target,
int  x,
int  y,
int  id 
) const
Beschreibung:
Mit dieser Funktion wird ein beliebiges Sprite auf dem Ziel-Surface angezeigt.
Parameter
[in]targetZiel-Surface
[in]xX-Koordinate, bei der das Sprite gezeichnet werden soll
[in]yY-Koordinate, bei der das Sprite gezeichnet werden soll
[in]idID des anzuzeigenden Sprites
Rückgabe
Bei Erfolg liefert die Funktion 1 zurück, im Fehlerfall 0.
CSurface * ppl6::grafix::CSprite::findTexture ( int  id)
private
Beschreibung:
Diese Funktion wird intern aufgerufen, um einen Surface-Pointer auf eine bereits geladene Textur zu erhalten.
Parameter
[in]idID der gewünschten Texture
Rückgabe
Ist die Textur-ID vorhanden und bereits geladen, wird ein Pointer auf deren CSurface-Klasse zurückgeliefert, andernfalls NULL.
int ppl6::grafix::CSprite::load ( const CString &  filename,
CSurface::SurfaceFlags  flags 
)
Beschreibung:
Mit dieser Funktion kann eine Textur-Sprite-Datei geladen werden.
Parameter
[in]filenameName der zu ladenden Datei
[in]flagsFlags mit der die Textur-Surfaces erstellt werden sollen. Dies ist eine Kombination der Werte innerhalb der Enumeration ppl6::grafix::Surface::Flags
Rückgabe
Konnte die Datei erfolgreich geladern werden, gibt die Funktion 1 (true) zurück, im Fehlerfall 0 (false). Im Fehlerfall wird ein entsprechender Fehlercode gesetzt.
int ppl6::grafix::CSprite::load ( CFileObject &  ff,
CSurface::SurfaceFlags  flags 
)
Beschreibung:
Mit dieser Funktion kann eine bereits geöffnete Textur-Sprite-Datei geladen werden.
Parameter
[in]ffPointer auf die CFileObject-Klasse, die die Daten enthält.
[in]flagsFlags mit der die Textur-Surfaces erstellt werden sollen. Dies ist eine Kombination der Werte innerhalb der Enumeration ppl6::grafix::Surface::Flags
Rückgabe
Konnte die Datei erfolgreich geladern werden, gibt die Funktion 1 (true) zurück, im Fehlerfall 0 (false). Im Fehlerfall wird ein entsprechender Fehlercode gesetzt.
int ppl6::grafix::CSprite::loadIndex ( PFPChunk *  chunk)
private
Beschreibung:
Diese Funktion wird intern verwendet, um den INDX-Chunk der Sprite-Datei einzulesen. Sie darf erst nach Aufruf von CSprite::LoadTexture verwendet werden.
Parameter
[in]chunkPointer auf den INDX-Chunk
Rückgabe
Konnte der Index erfolgreich eingelesen und alle Texturen zugeordnet werden, liefert die Funktion true (1) zurück, andernfalls false (0).
int ppl6::grafix::CSprite::loadTexture ( PFPChunk *  chunk,
CSurface::SurfaceFlags  flags 
)
private
Beschreibung:
Diese Funktion wird intern verwendet, um einen SURF-Chunk mit einer Textur aus der Sprite-Datei zu laden.
Parameter
[in]chunkPointer auf den zu ladenden SURF-Chunk
[in]flagsFlags, mit dem das Texture-Surfaces erstellt werden soll. Dies ist eine Kombination der Werte innerhalb der Enumeration ppl6::grafix::Surface::Flags
Rückgabe
Konnte die Textur erfolgreich geladen werden, liefert die Funktion true (1) zurück, andernfalls false (0).
int ppl6::grafix::CSprite::numSprites ( ) const
Beschreibung:
Diese Funktion liefert die Anzahl durch die Klasse geladener Sprites zurück.
Rückgabe
Anzahl Sprites oder 0, wenn keine geladen sind.
int ppl6::grafix::CSprite::numTextures ( ) const
Beschreibung:
Diese Funktion liefert die Anzahl durch die Klasse geladener Texturen zurück.
Rückgabe
Anzahl Texturen oder 0, wenn keine geladen sind.

Dokumentation der Datenelemente

ppl6::grafix::CSprite::SpriteList
private
ppl6::grafix::CSprite::TextureList
private
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: