From 47904bc7b2992189bb554833f00a79ff0fea9fb8 Mon Sep 17 00:00:00 2001 From: Eugene Sandulenko Date: Fri, 6 Aug 2010 13:13:25 +0000 Subject: SWORD25: Mass-astyle. svn-id: r53222 --- engines/sword25/gfx/bitmap.h | 139 +++++++++++++++++++++++-------------------- 1 file changed, 75 insertions(+), 64 deletions(-) (limited to 'engines/sword25/gfx/bitmap.h') diff --git a/engines/sword25/gfx/bitmap.h b/engines/sword25/gfx/bitmap.h index c0e490ee47..00d9308ec5 100644 --- a/engines/sword25/gfx/bitmap.h +++ b/engines/sword25/gfx/bitmap.h @@ -23,7 +23,7 @@ * */ -/* +/* * This code is based on Broken Sword 2.5 engine * * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer @@ -48,8 +48,7 @@ namespace Sword25 { // Klassendeklaration // ----------------------------------------------------------------------------- -class BS_Bitmap : public BS_RenderObject -{ +class BS_Bitmap : public BS_RenderObject { protected: BS_Bitmap(BS_RenderObjectPtr ParentPtr, TYPES Type, unsigned int Handle = 0); @@ -58,127 +57,139 @@ public: virtual ~BS_Bitmap(); /** - @brief Setzt den Alphawert des Bitmaps. - @param Alpha der neue Alphawert der Bitmaps (0 = keine Deckung, 255 = volle Deckung). - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsAlphaAllowed() true zurückgibt. + @brief Setzt den Alphawert des Bitmaps. + @param Alpha der neue Alphawert der Bitmaps (0 = keine Deckung, 255 = volle Deckung). + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsAlphaAllowed() true zurückgibt. */ void SetAlpha(int Alpha); /** - @brief Setzt die Modulationfarbe der Bitmaps. - @param Color eine 24-Bit Farbe, die die Modulationsfarbe des Bitmaps festlegt. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsColorModulationAllowed() true zurückgibt. + @brief Setzt die Modulationfarbe der Bitmaps. + @param Color eine 24-Bit Farbe, die die Modulationsfarbe des Bitmaps festlegt. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsColorModulationAllowed() true zurückgibt. */ void SetModulationColor(unsigned int ModulationColor); /** - @brief Setzt den Skalierungsfaktor des Bitmaps. - @param ScaleFactor der Faktor um den das Bitmap in beide Richtungen gestreckt werden soll. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. + @brief Setzt den Skalierungsfaktor des Bitmaps. + @param ScaleFactor der Faktor um den das Bitmap in beide Richtungen gestreckt werden soll. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. */ void SetScaleFactor(float ScaleFactor); /** - @brief Setzt den Skalierungsfaktor der Bitmap auf der X-Achse. - @param ScaleFactor der Faktor um den die Bitmap in Richtungen der X-Achse gestreckt werden soll. Dieser Wert muss positiv sein. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. + @brief Setzt den Skalierungsfaktor der Bitmap auf der X-Achse. + @param ScaleFactor der Faktor um den die Bitmap in Richtungen der X-Achse gestreckt werden soll. Dieser Wert muss positiv sein. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. */ void SetScaleFactorX(float ScaleFactorX); /** - @brief Setzt den Skalierungsfaktor der Bitmap auf der Y-Achse. - @param ScaleFactor der Faktor um den die Bitmap in Richtungen der Y-Achse gestreckt werden soll. Dieser Wert muss positiv sein. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. + @brief Setzt den Skalierungsfaktor der Bitmap auf der Y-Achse. + @param ScaleFactor der Faktor um den die Bitmap in Richtungen der Y-Achse gestreckt werden soll. Dieser Wert muss positiv sein. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. */ void SetScaleFactorY(float ScaleFactorY); /** - @brief Legt fest, ob das Bild an der X-Achse gespiegelt werden soll. + @brief Legt fest, ob das Bild an der X-Achse gespiegelt werden soll. */ void SetFlipH(bool FlipH); /** - @brief Legt fest, ob das Bild an der Y-Achse gespiegelt werden soll. + @brief Legt fest, ob das Bild an der Y-Achse gespiegelt werden soll. */ void SetFlipV(bool FlipV); /** - @brief Gibt den aktuellen Alphawert des Bildes zurück. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsAlphaAllowed() true zurückgibt. + @brief Gibt den aktuellen Alphawert des Bildes zurück. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsAlphaAllowed() true zurückgibt. */ - int GetAlpha() { return m_ModulationColor >> 24; } + int GetAlpha() { + return m_ModulationColor >> 24; + } /** - @brief Gibt die aktuelle 24bit RGB Modulationsfarde des Bildes zurück. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsColorModulationAllowed() true zurückgibt. + @brief Gibt die aktuelle 24bit RGB Modulationsfarde des Bildes zurück. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsColorModulationAllowed() true zurückgibt. */ - int GetModulationColor() { return m_ModulationColor & 0x00ffffff; } + int GetModulationColor() { + return m_ModulationColor & 0x00ffffff; + } /** - @brief Gibt den Skalierungsfakter des Bitmaps auf der X-Achse zurück. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. + @brief Gibt den Skalierungsfakter des Bitmaps auf der X-Achse zurück. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. */ - float GetScaleFactorX() const { return m_ScaleFactorX; } + float GetScaleFactorX() const { + return m_ScaleFactorX; + } /** - @brief Gibt den Skalierungsfakter des Bitmaps auf der Y-Achse zurück. - @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. + @brief Gibt den Skalierungsfakter des Bitmaps auf der Y-Achse zurück. + @remark Diese Methode darf nur aufgerufen werden, wenn die Methode IsScalingAllowed() true zurückgibt. */ - float GetScaleFactorY() const { return m_ScaleFactorY; } + float GetScaleFactorY() const { + return m_ScaleFactorY; + } /** - @brief Gibt zurück, ob das Bild an der X-Achse gespiegelt angezeigt wird. + @brief Gibt zurück, ob das Bild an der X-Achse gespiegelt angezeigt wird. */ - bool IsFlipH() { return m_FlipH; } + bool IsFlipH() { + return m_FlipH; + } /** - @brief Gibt zurück, ob das Bild an der Y-Achse gespiegelt angezeigt wird. + @brief Gibt zurück, ob das Bild an der Y-Achse gespiegelt angezeigt wird. */ - bool IsFlipV() { return m_FlipV; } + bool IsFlipV() { + return m_FlipV; + } // ----------------------------------------------------------------------------- // Die folgenden Methoden müssen alle BS_Bitmap-Klassen implementieren // ----------------------------------------------------------------------------- /** - @brief Liest einen Pixel des Bildes. - @param X die X-Koordinate des Pixels. - @param Y die Y-Koordinate des Pixels - @return Gibt den 32-Bit Farbwert des Pixels an der übergebenen Koordinate zurück. - @remark Diese Methode sollte auf keine Fall benutzt werden um größere Teile des Bildes zu lesen, da sie sehr langsam ist. Sie ist - eher dafür gedacht einzelne Pixel des Bildes auszulesen. + @brief Liest einen Pixel des Bildes. + @param X die X-Koordinate des Pixels. + @param Y die Y-Koordinate des Pixels + @return Gibt den 32-Bit Farbwert des Pixels an der übergebenen Koordinate zurück. + @remark Diese Methode sollte auf keine Fall benutzt werden um größere Teile des Bildes zu lesen, da sie sehr langsam ist. Sie ist + eher dafür gedacht einzelne Pixel des Bildes auszulesen. */ virtual unsigned int GetPixel(int X, int Y) const = 0; /** - @brief Füllt den Inhalt des Bildes mit Pixeldaten. - @param Pixeldata ein Vector der die Pixeldaten enthält. Sie müssen in dem Farbformat des Bildes vorliegen und es müssen genügend Daten - vorhanden sein, um das ganze Bild zu füllen. + @brief Füllt den Inhalt des Bildes mit Pixeldaten. + @param Pixeldata ein Vector der die Pixeldaten enthält. Sie müssen in dem Farbformat des Bildes vorliegen und es müssen genügend Daten + vorhanden sein, um das ganze Bild zu füllen. @param Offset der Offset in Byte im Pixeldata-Vector an dem sich der erste zu schreibende Pixel befindet.
- Der Standardwert ist 0. - @param Stride der Abstand in Byte zwischen dem Zeilenende und dem Beginn einer neuen Zeile im Pixeldata-Vector.
- Der Standardwert ist 0. - @return Gibt false zurück, falls der Aufruf fehlgeschlagen ist. - @remark Ein Aufruf dieser Methode ist nur erlaubt, wenn IsSetContentAllowed() true zurückgibt. + Der Standardwert ist 0. + @param Stride der Abstand in Byte zwischen dem Zeilenende und dem Beginn einer neuen Zeile im Pixeldata-Vector.
+ Der Standardwert ist 0. + @return Gibt false zurück, falls der Aufruf fehlgeschlagen ist. + @remark Ein Aufruf dieser Methode ist nur erlaubt, wenn IsSetContentAllowed() true zurückgibt. */ - virtual bool SetContent(const byte *Pixeldata, unsigned int Offset = 0, unsigned int Stride = 0) = 0; + virtual bool SetContent(const byte *Pixeldata, unsigned int Offset = 0, unsigned int Stride = 0) = 0; - virtual bool IsScalingAllowed() const = 0; - virtual bool IsAlphaAllowed() const = 0; - virtual bool IsColorModulationAllowed() const = 0; - virtual bool IsSetContentAllowed() const = 0; + virtual bool IsScalingAllowed() const = 0; + virtual bool IsAlphaAllowed() const = 0; + virtual bool IsColorModulationAllowed() const = 0; + virtual bool IsSetContentAllowed() const = 0; - virtual bool Persist(BS_OutputPersistenceBlock & Writer); - virtual bool Unpersist(BS_InputPersistenceBlock & Reader); + virtual bool Persist(BS_OutputPersistenceBlock &Writer); + virtual bool Unpersist(BS_InputPersistenceBlock &Reader); protected: - bool m_FlipH; - bool m_FlipV; - float m_ScaleFactorX; - float m_ScaleFactorY; - unsigned int m_ModulationColor; - int m_OriginalWidth; - int m_OriginalHeight; + bool m_FlipH; + bool m_FlipV; + float m_ScaleFactorX; + float m_ScaleFactorY; + unsigned int m_ModulationColor; + int m_OriginalWidth; + int m_OriginalHeight; }; } // End of namespace Sword25 -- cgit v1.2.3