TextObjectSprite Class Reference
#include <TextObjectSprite.h>
# Public Types | |
| typedef const TextObjectSpriteSpec | TextObjectSpriteROMSpec |
# Public Member Functions | |
| void | constructor (Entity owner, const TextObjectSpriteSpec *textObjectSpriteSpec) |
| override int16 | doRender (int16 index) |
# Protected Attributes | |
| const char * | text |
| Pointer to the text to display. | |
| const char * | font |
| Pointer to the font name to use. | |
| uint16 | palette |
| Palette to apply when rendering the text. | |
| bool | printed |
| Flag to avoid printing the text every frame cycle if not necessary. | |
# Additional Inherited Members | |
 Private Types inherited from ObjectSprite | |
| typedef const ObjectSpriteSpec | ObjectSpriteROMSpec |
| Private Member Functions inherited from ObjectSprite | |
| void | constructor (Entity owner, const ObjectSpriteSpec *objectSpriteSpec) |
| override ClassPointer | getBasicType () |
| override void | loadTexture (ClassPointer textureClass, bool listenForRewriting) |
| override void | setMultiframe (uint16 frame) |
| override void | setRotation (const Rotation *rotation) |
| override int32 | getTotalPixels () |
| void | resetTotalObjects () |
| Force the computation of the number of OBJECTs that the sprite uses. | |
| int16 | getTotalObjects () |
| Private Attributes inherited from ObjectSprite | |
| int16 | totalObjects |
| The number of OBJECTs that the sprite uses. | |
| ObjectTextureSource | objectTextureSource |
| Texture's displacement in the map array. | |
| uint16 | fourthWordValue |
| Cache the computed value for the 4th entry of OBJECTs. | |
| uint8 | cols |
| Cache of the number of cols for the sprite's texture. | |
| uint8 | rows |
| Cache of the number of cols for the sprite's texture. | |
| int8 | xDisplacementIncrement |
| Cache of the x displacamente used to flip horizontally the image. | |
| int8 | yDisplacementIncrement |
| Cache of the y displacamente used to flip vertically the image. | |
| int8 | xDisplacementDelta |
| int8 | yDisplacementDelta |
# Detailed Description
Class TextObjectSprite
Inherits from Sprite
Displays a text in OBJECT space.
Definition at line 54 of file TextObjectSprite.h.
# Member Typedef Documentation
# TextObjectSpriteROMSpec
| typedef const TextObjectSpriteSpec TextObjectSpriteROMSpec |
A TextObjectSprite spec that is stored in ROM
Definition at line 43 of file TextObjectSprite.h.
# Member Function Documentation
# constructor()
| void TextObjectSprite::constructor | ( | Entity | owner, |
| const TextObjectSpriteSpec * | textObjectSpriteSpec ) |
Class' constructor
- Parameters
-
owner Entity to which the sprite attaches to textObjectSpriteSpec Specification that determines how to configure the sprite
Definition at line 36 of file TextObjectSprite.c.
# doRender()
Render the sprite by configuring the DRAM assigned to it by means of the provided index.
- Parameters
-
index Determines the region of DRAM that this sprite is allowed to configure
- Returns
- The index that determines the region of DRAM that this sprite manages
Reimplemented from ObjectSprite.
Definition at line 62 of file TextObjectSprite.c.
# Member Data Documentation
# font
|
protected |
Pointer to the font name to use.
Definition at line 62 of file TextObjectSprite.h.
# palette
|
protected |
Palette to apply when rendering the text.
Definition at line 65 of file TextObjectSprite.h.
# printed
|
protected |
Flag to avoid printing the text every frame cycle if not necessary.
Definition at line 68 of file TextObjectSprite.h.
# text
|
protected |
Pointer to the text to display.
Definition at line 59 of file TextObjectSprite.h.
The documentation for this class was generated from the following files:
- VUEngine-Core/source/Component/VisualComponent/Sprite/ObjectSprite/TextObjectSprite/TextObjectSprite.h
- VUEngine-Core/source/Component/VisualComponent/Sprite/ObjectSprite/TextObjectSprite/TextObjectSprite.c