ScummVM API documentation
Sword25::Text Class Reference
Inheritance diagram for Sword25::Text:
Sword25::RenderObject

Public Member Functions

bool setFont (const Common::String &font)
 Setzt den Font mit dem der Text dargestellt werden soll. More...
 
void setText (const Common::String &text)
 Setzt den darzustellenden Text. More...
 
void setAlpha (int alpha)
 Setzt den Alphawert des Textes. More...
 
void setAutoWrap (bool autoWrap)
 Legt fest, ob der Text automatisch umgebrochen werden soll. More...
 
void setAutoWrapThreshold (uint32 autoWrapThreshold)
 Legt die Längengrenze des Textes in Pixeln fest, ab der ein automatischer Zeilenumbruch vorgenommen wird. More...
 
const Common::StringgetText ()
 Gibt den dargestellten Text zurück.
 
const Common::StringgetFont ()
 Gibt den Namen das momentan benutzten Fonts zurück.
 
void setColor (uint32 modulationColor)
 Setzt die Farbe des Textes. More...
 
int getAlpha () const
 Gibt den Alphawert des Textes zurück. More...
 
int getColor () const
 Gibt die Farbe des Textes zurück. More...
 
bool isAutoWrapActive () const
 Gibt zurück, ob die automatische Formatierung aktiviert ist.
 
uint32 getAutoWrapThreshold () const
 Gibt die Längengrenze des Textes in Pixeln zurück, ab der eine automatische Formatierung vorgenommen wird.
 
bool persist (OutputPersistenceBlock &writer) override
 
bool unpersist (InputPersistenceBlock &reader) override
 
- Public Member Functions inherited from Sword25::RenderObject
RenderObjectPtr< BitmapaddBitmap (const Common::String &fileName)
 Erzeugt ein Bitmap als Kinderobjekt des Renderobjektes. More...
 
RenderObjectPtr< BitmapaddDynamicBitmap (uint width, uint height)
 Erzeugt ein veränderbares Bitmap als Kinderobjekt des Renderobjektes. More...
 
RenderObjectPtr< AnimationaddAnimation (const Common::String &fileName)
 Erzeugt eine Animation auf Basis einer Animationsdatei als Kinderobjekt des Renderobjektes. More...
 
RenderObjectPtr< AnimationaddAnimation (const AnimationTemplate &animationTemplate)
 Erzeugt eine Animation auf Basis eines Animationstemplate als Kinderobjekt des Renderobjektes. More...
 
RenderObjectPtr< PaneladdPanel (int width, int height, uint color=BS_RGB(0, 0, 0))
 Erzeugt ein neues Farbpanel als Kinderobjekt des Renderobjektes. More...
 
RenderObjectPtr< TextaddText (const Common::String &font, const Common::String &text="")
 Erzeugt ein Textobjekt als Kinderobjekt des Renderobjektes. More...
 
RenderObjectPtr< BitmaptoBitmap ()
 Castet das Objekt zu einem BS_Bitmap-Objekt wenn zulässig. More...
 
RenderObjectPtr< AnimationtoAnimation ()
 Castet das Objekt zu einem BS_Animation-Objekt wenn zulässig. More...
 
RenderObjectPtr< PaneltoPanel ()
 Castet das Objekt zu einem BS_Panel-Objekt wenn zulässig. More...
 
RenderObjectPtr< TexttoText ()
 Castet das Object zu einem BS_Text-Objekt wenn zulässig. More...
 
 RenderObject (RenderObjectPtr< RenderObject > pParent, TYPES type, uint handle=0)
 Erzeugt ein neues BS_RenderObject. More...
 
void preRender (RenderObjectQueue *renderQueue)
 
bool render (RectangleList *updateRects, const Common::Array< int > &updateRectsMinZ)
 Rendert des Objekt und alle seine Unterobjekte. More...
 
bool updateObjectState ()
 Bereitet das Objekt und alle seine Unterobjekte auf einen Rendervorgang vor. Hierbei werden alle Dirty-Rectangles berechnet und die Renderreihenfolge aktualisiert. More...
 
void deleteAllChildren ()
 Löscht alle Kinderobjekte.
 
virtual void setPos (int x, int y)
 Setzt die Position des Objektes. More...
 
virtual void setX (int x)
 Setzt die Position des Objektes auf der X-Achse. More...
 
virtual void setY (int y)
 Setzt die Position des Objektes auf der Y-Achse. More...
 
virtual void setZ (int z)
 Setzt den Z-Wert des Objektes. More...
 
virtual void setVisible (bool visible)
 Setzt die Sichtbarkeit eine Objektes. More...
 
virtual int getX () const
 Gibt die Position des Objektes auf der X-Achse relativ zum Elternobjekt zurück.
 
virtual int getY () const
 Gibt die Position des Objektes auf der Y-Achse relativ zum Elternobjekt zurück.
 
virtual int getAbsoluteX () const
 Gibt die absolute Position des Objektes auf der X-Achse zurück.
 
virtual int getAbsoluteY () const
 Gibt die absolute Position des Objektes auf der Y-Achse zurück.
 
int getZ () const
 Gibt den Z-Wert des Objektes relativ zum Elternobjekt zurück. More...
 
int getAbsoluteZ () const
 
int getWidth () const
 Gibt die Breite des Objektes zurück.
 
int getHeight () const
 Gibt die Höhe des Objektes zurück.
 
bool isVisible () const
 Gibt den Sichtbarkeitszustand des Objektes zurück. More...
 
TYPES getType () const
 Gibt den Typ des Objektes zurück.
 
bool getInitSuccess () const
 Gibt zurück, ob das Objekt erfolgreich initialisiert wurde. More...
 
const Common::RectgetBbox () const
 Gibt die Bounding-Box des Objektes zurück. More...
 
void forceRefresh ()
 Stellt sicher, dass das Objekt im nächsten Frame neu gezeichnet wird.
 
uint32 getHandle () const
 Gibt das Handle des Objekte zurück.
 
int getVersion () const
 
bool isSolid () const
 
bool persistChildren (OutputPersistenceBlock &writer)
 
bool unpersistChildren (InputPersistenceBlock &reader)
 
RenderObjectPtr< RenderObjectrecreatePersistedRenderObject (InputPersistenceBlock &reader)
 

Protected Member Functions

bool doRender (RectangleList *updateRects) override
 Einschubmethode, die den tatsächlichen Redervorgang durchführt. More...
 
- Protected Member Functions inherited from Sword25::RenderObject
RenderObjectManagergetManager () const
 Gibt einen Pointer auf den BS_RenderObjektManager zurück, der das Objekt verwaltet.
 
bool addObject (RenderObjectPtr< RenderObject > pObject)
 Fügt dem Objekt ein neues Kinderobjekt hinzu. More...
 

Additional Inherited Members

- Public Types inherited from Sword25::RenderObject
enum  TYPES {
  TYPE_ROOT, TYPE_STATICBITMAP, TYPE_DYNAMICBITMAP, TYPE_ANIMATION,
  TYPE_PANEL, TYPE_TEXT, TYPE_UNKNOWN
}
 
- Protected Types inherited from Sword25::RenderObject
typedef Common::List< RenderObjectPtr< RenderObject > > RENDEROBJECT_LIST
 
typedef Common::List< RenderObjectPtr< RenderObject > >::iterator RENDEROBJECT_ITER
 
- Protected Attributes inherited from Sword25::RenderObject
int32 _x
 Die X-Position des Objektes relativ zum Eltern-Objekt.
 
int32 _y
 Die Y-Position des Objektes relativ zum Eltern-Objekt.
 
int32 _z
 Der Z-Wert des Objektes relativ zum Eltern-Objekt.
 
int32 _absoluteX
 Die absolute X-Position des Objektes.
 
int32 _absoluteY
 Die absolute Y-Position des Objektes.
 
int32 _absoluteZ
 
int32 _width
 Die Breite des Objektes.
 
int32 _height
 Die Höhe des Objektes.
 
bool _visible
 Ist true, wenn das Objekt sichtbar ist.
 
bool _childChanged
 Ist true, wenn sich ein Kinderobjekt verändert hat.
 
TYPES _type
 Der Objekttyp.
 
bool _initSuccess
 Ist true, wenn Objekt erfolgreich intialisiert werden konnte.
 
Common::Rect _bbox
 Die Bounding-Box des Objektes in Bildschirmkoordinaten.
 
Common::Rect _oldBbox
 
int32 _oldX
 
int32 _oldY
 
int32 _oldZ
 
bool _oldVisible
 
int32 _version
 
bool _isSolid
 
RenderObjectManager_managerPtr
 Ein Pointer auf den BS_RenderObjektManager, der das Objekt verwaltet.
 
RenderObjectPtr< RenderObject_parentPtr
 Ein Pointer auf das Elternobjekt.
 
RENDEROBJECT_LIST _children
 Die Liste der Kinderobjekte nach der Renderreihenfolge geordnet.
 
- Static Protected Attributes inherited from Sword25::RenderObject
static int _nextGlobalVersion
 

Member Function Documentation

◆ setFont()

bool Sword25::Text::setFont ( const Common::String font)

Setzt den Font mit dem der Text dargestellt werden soll.

Parameters
Fontder Dateiname der Fontdatei.
Returns
Gibt false zurück, wenn der Font nicht gefunden wurde.

◆ setText()

void Sword25::Text::setText ( const Common::String text)

Setzt den darzustellenden Text.

Parameters
Textder darzustellende Text

◆ setAlpha()

void Sword25::Text::setAlpha ( int  alpha)

Setzt den Alphawert des Textes.

Parameters
Alphader neue Alphawert des Textes (0 = keine Deckung, 255 = volle Deckung).

◆ setAutoWrap()

void Sword25::Text::setAutoWrap ( bool  autoWrap)

Legt fest, ob der Text automatisch umgebrochen werden soll.

Wenn dieses Attribut auf true gesetzt ist, wird der Text umgebrochen, sofern er länger als GetAutoWrapThreshold() ist.

Parameters
AutoWrapgibt an, ob der automatische Umbruch aktiviert oder deaktiviert werden soll.
Remarks
Dieses Attribut wird mit dem Wert false initialisiert.

◆ setAutoWrapThreshold()

void Sword25::Text::setAutoWrapThreshold ( uint32  autoWrapThreshold)

Legt die Längengrenze des Textes in Pixeln fest, ab der ein automatischer Zeilenumbruch vorgenommen wird.

Remarks
Dieses Attribut wird mit dem Wert 300 initialisiert.
Eine automatische Formatierung wird nur vorgenommen, wenn diese durch einen Aufruf von SetAutoWrap() aktiviert wurde.

◆ setColor()

void Sword25::Text::setColor ( uint32  modulationColor)

Setzt die Farbe des Textes.

Parameters
Coloreine 24-Bit RGB Farbe, die die Farbe des Textes festlegt.

◆ getAlpha()

int Sword25::Text::getAlpha ( ) const
inline

Gibt den Alphawert des Textes zurück.

Returns
Der Alphawert des Textes (0 = keine Deckung, 255 = volle Deckung).

◆ getColor()

int Sword25::Text::getColor ( ) const
inline

Gibt die Farbe des Textes zurück.

Returns
Eine 24-Bit RGB Farbe, die die Farbe des Textes angibt.

◆ doRender()

bool Sword25::Text::doRender ( RectangleList updateRects)
overrideprotectedvirtual

Einschubmethode, die den tatsächlichen Redervorgang durchführt.

Diese Methode wird von Render() aufgerufen um das Objekt darzustellen. Diese Methode sollte von allen Klassen implementiert werden, die von BS_RederObject erben, um das Zeichnen umzusetzen.

Returns
Gibt false zurück, falls das Rendern fehlgeschlagen ist.
Remarks

Implements Sword25::RenderObject.


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