1. Home
  2. Documentation
  3. API
  4. ObjectSpriteContainer Class Reference

ObjectSpriteContainer Class Reference

#include <ObjectSpriteContainer.h>

Inheritance diagram for ObjectSpriteContainer:
Sprite

# Public Member Functions

void constructor ()
 Class' constructor.
override ClassPointer getBasicType ()
override int16 doRender (int16 index)
override int32 getTotalPixels ()

# Additional Inherited Members

- Private Types inherited from Sprite
typedef const SpriteSpec SpriteROMSpec
- Private Member Functions inherited from Sprite
void constructor (Entity owner, const SpriteSpec *spriteSpec)
override void releaseResources ()
 Called to release the component's resources.
override RightBox getRightBox ()
override void createAnimationController ()
 Create an animation controller for this sprite.
override void forceChangeOfFrame (int16 actualFrame)
void transform ()
 Compute the sprite's transformation.
int16 render (int16 index, bool updateAnimation)
Texture getTexture ()
int16 getIndex ()
uint16 getHead ()
int32 getHalfWidth ()
int32 getHalfHeight ()
uint32 getEffectiveHead ()
uint16 getEffectiveWidth ()
uint16 getEffectiveHeight ()
int16 getEffectiveX ()
int16 getEffectiveY ()
int16 getEffectiveP ()
int16 getEffectiveMX ()
int16 getEffectiveMY ()
int16 getEffectiveMP ()
bool isVisible ()
bool isHidden ()
bool isBgmap ()
bool isObject ()
bool isAffine ()
bool isHBias ()
void setPosition (const PixelVector *position)
const PixelVector * getPosition ()
 Retrieve the position cache.
void setDisplacement (const PixelVector *displacement)
const PixelVector * getDisplacement ()
PixelVector getDisplacedPosition ()
void addChar (const Point *texturePoint, const uint32 *newChar)
void putChar (const Point *texturePoint, const uint32 *newChar)
void putPixel (const Point *texturePixel, const Pixel *charSetPixel, BYTE newPixelColor)
void invalidateRendering ()
 Invalidate the flags that determine if the sprite requires rendering.
virtual void loadTexture (ClassPointer textureClass, bool listenForRewriting)
virtual void releaseTexture ()
 Release the sprite's texture(s)
virtual bool hasSpecialEffects ()
virtual void updateAnimation ()
 Update the animation.
virtual void processEffects (int32 maximumParamTableRowsToComputePerCall)
virtual void setMultiframe (uint16 frame)
virtual void forceShow ()
 Forcefully show the sprite.
virtual void forceHide ()
 Forcefully hide the sprite.
virtual void setRotation (const Rotation *rotation)
virtual void setScale (const PixelScale *scale)
virtual void print (int32 x, int32 y)
- Private Attributes inherited from Sprite
bool checkIfWithinScreenSpace
 Flag to check if rendered even if outside the screen.
PixelVector position
 Position cache.
PixelVector displacement
 Displacement added to the sprite's position.
Rotation rotation
 Rotation cache.
int16 index
PixelScale scale
 Scale cache.
uint16 head
 Head flags for DRAM entries.
int16 halfWidth
 Cache of the texture's half width.
int16 halfHeight
 Cache of the texture's half height.
Texture texture
 Texture to display.
bool hasTextures
 Flag for special sprites.

# Detailed Description

Class ObjectSpriteContainer

Inherits from Sprite

Manages ObjectSprites that are displayed in the same SPT.

Definition at line 34 of file ObjectSpriteContainer.h.

# Member Function Documentation

# constructor()

void ObjectSpriteContainer::constructor ( )

Class' constructor.

Definition at line 47 of file ObjectSpriteContainer.c.

# doRender()

int16 ObjectSpriteContainer::doRender ( int16 index)
virtual

Render the sprite by configuring the DRAM assigned to it by means of the provided index.

Parameters
indexDetermines the region of DRAM that this sprite is allowed to configure
Returns
The index that determines the region of DRAM that this sprite manages

Implements Sprite.

Definition at line 75 of file ObjectSpriteContainer.c.

# getBasicType()

ClassPointer ObjectSpriteContainer::getBasicType ( )
virtual

Retrieve the basic class of this kind of sprite.

Returns
ClassPointer the basic class

Implements Sprite.

Definition at line 68 of file ObjectSpriteContainer.c.

# getTotalPixels()

int32 ObjectSpriteContainer::getTotalPixels ( )
virtual

Retrieve the total number of pixels actually displayed by all the managed sprites.

Returns
Total number of pixels displayed by all the managed sprites

Implements Sprite.

Definition at line 84 of file ObjectSpriteContainer.c.


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