Torque2D Reference
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
SpriteBatch Class Reference

#include <SpriteBatch.h>

Inheritance diagram for SpriteBatch:

Public Member Functions

 SpriteBatch ()
virtual ~SpriteBatch ()
virtual bool onAdd ()
virtual void onRemove ()
void prepareRender (SceneRenderObject *pSceneRenderObject, const SceneRenderState *pSceneRenderState, SceneRenderQueue *pSceneRenderQueue)
void render (const SceneRenderState *pSceneRenderState, const SceneRenderRequest *pSceneRenderRequest, BatchRender *pBatchRenderer)
void setBatchTransformDirty (void)
bool getBatchTransformDirty (void) const
U32 getBatchTransformId (void)
const b2Transform & getBatchTransform (void) const
void setLocalExtentsDirty (void)
bool getLocalExtentsDirty (void) const
const Vector2 & getLocalExtents (void)
const b2AABB & getLocalAABB (void)
void createQueryProxy (SpriteBatchItem *pSpriteBatchItem)
void destroyQueryProxy (SpriteBatchItem *pSpriteBatchItem)
void moveQueryProxy (SpriteBatchItem *pSpriteBatchItem, const b2AABB &localAABB)
SpriteBatchQuery * getSpriteBatchQuery (const bool clearQuery=false)
virtual void copyTo (SpriteBatch *pSpriteBatch) const
U32 getSpriteCount (void)
U32 addSprite (const SpriteBatchItem::LogicalPosition &logicalPosition)
bool removeSprite (void)
virtual void clearSprites (void)
void setBatchSortMode (SceneRenderQueue::RenderSort sortMode)
SceneRenderQueue::RenderSort getBatchSortMode (void) const
void setBatchCulling (const bool batchCulling)
bool getBatchCulling (void) const
void setDefaultSpriteStride (const Vector2 &defaultStride)
const Vector2 & getDefaultSpriteStride (void) const
void setDefaultSpriteSize (const Vector2 &defaultSize)
const Vector2 & getDefaultSpriteSize (void) const
void setDefaultSpriteAngle (const F32 defaultAngle)
F32 getDefaultSpriteAngle (void) const
bool selectSprite (const SpriteBatchItem::LogicalPosition &logicalPosition)
bool selectSpriteId (const U32 batchId)
bool selectSpriteName (const char *pName)
void deselectSprite (void)
bool isSpriteSelected (void) const
U32 getSpriteId (void) const
void setSpriteImage (const char *pAssetId, const U32 imageFrame)
void setSpriteImage (const char *pAssetId, const char *namedFrame)
StringTableEntry getSpriteImage (void) const
void setSpriteImageFrame (const U32 imageFrame)
U32 getSpriteImageFrame (void) const
void setSpriteNamedImageFrame (const char *namedFrame)
StringTableEntry getSpriteNamedImageFrame (void) const
void setSpriteAnimation (const char *pAssetId)
StringTableEntry getSpriteAnimation (void) const
void setSpriteAnimationFrame (const U32 animationFrame)
U32 getSpriteAnimationFrame (void) const
void clearSpriteAsset (void)
void setSpriteVisible (const bool visible)
bool getSpriteVisible (void) const
void setSpriteLocalPosition (const Vector2 &localPosition)
Vector2 getSpriteLocalPosition (void)
const SpriteBatchItem::LogicalPosition getSpriteLogicalPosition (void) const
void setSpriteAngle (const F32 localAngle)
F32 getSpriteAngle (void) const
void setSpriteDepth (const F32 depth)
F32 getSpriteDepth (void) const
void setSpriteSize (const Vector2 &size)
Vector2 getSpriteSize (void) const
void setSpriteFlipX (const bool flipX)
bool getSpriteFlipX (void) const
void setSpriteFlipY (const bool flipY)
bool getSpriteFlipY (void) const
void setSpriteSortPoint (const Vector2 &sortPoint)
Vector2 getSpriteSortPoint (void) const
void setSpriteRenderGroup (const char *pRenderGroup)
StringTableEntry getSpriteRenderGroup (void) const
void setSpriteBlendMode (const bool blendMode)
bool getSpriteBlendMode (void) const
void setSpriteSrcBlendFactor (GLenum srcBlendFactor)
GLenum getSpriteSrcBlendFactor (void) const
void setSpriteDstBlendFactor (GLenum dstBlendFactor)
GLenum getSpriteDstBlendFactor (void) const
void setSpriteBlendColor (const ColorF &blendColor)
const ColorF & getSpriteBlendColor (void) const
void setSpriteBlendAlpha (const F32 alpha)
F32 getSpriteBlendAlpha (void) const
void setSpriteUseComplexColor (const bool complexColor)
bool getSpriteUseComplexColor (void) const
void setSpriteComplexColor (const ColorF &blendColor0, const ColorF &blendColor1, const ColorF &blendColor2, const ColorF &blendColor3)
const ColorF & getSpriteComplexColor (const S8 cornerID) const
void setSpriteAlphaTest (const F32 alphaTestMode)
F32 getSpriteAlphaTest (void) const
void setSpriteDataObject (SimObject *pDataObject)
SimObject * getSpriteDataObject (void) const
void setUserData (void *pUserData)
void * getUserData (void) const
void setSpriteName (const char *pName)
StringTableEntry getSpriteName (void) const

Static Public Member Functions

static void WriteCustomTamlSchema (const AbstractClassRep *pClassRep, TiXmlElement *pParentElement)

Static Public Attributes

static const S32 INVALID_SPRITE_PROXY = -1

Protected Types

typedef HashMap< U32, SpriteBatchItem * > typeSpriteBatchHash
typedef HashMap< SpriteBatchItem::LogicalPosition, SpriteBatchItem * > typeSpritePositionHash
typedef HashMap< StringTableEntry, SpriteBatchItem * > typeSpriteNameHash

Protected Member Functions

SpriteBatchItem * createSprite (void)
SpriteBatchItem * createSprite (const Vector2 *explicitVertices)
SpriteBatchItem * findSpritePosition (const SpriteBatchItem::LogicalPosition &logicalPosition)
SpriteBatchItem * findSpriteId (const U32 batchId)
SpriteBatchItem * findSpriteName (const char *pName)
virtual SpriteBatchItem * createSprite (const SpriteBatchItem::LogicalPosition &logicalPosition)
void integrateSprites (const F32 totalTime, const F32 elapsedTime, DebugStats *pDebugStats)
void setBatchTransform (const b2Transform &batchTransform)
void updateLocalExtents (const b2AABB *precalculatedLocalAABB=NULL)
void createSpriteBatchQuery (void)
void destroySpriteBatchQuery (void)
void onTamlCustomWrite (TamlCustomNodes &customNodes)
void onTamlCustomRead (const TamlCustomNodes &customNodes)

Protected Attributes

typeSpriteBatchHash mSprites
typeSpritePositionHash mSpritePositions
typeSpriteNameHash mSpriteNames
SpriteBatchItem * mSelectedSprite
SceneRenderQueue::RenderSort mBatchSortMode
bool mBatchCulling
Vector2 mDefaultSpriteStride
Vector2 mDefaultSpriteSize
F32 mDefaultSpriteAngle

Member Typedef Documentation

◆ typeSpriteBatchHash

typedef HashMap< U32, SpriteBatchItem* > typeSpriteBatchHash
protected

◆ typeSpriteNameHash

typedef HashMap< StringTableEntry, SpriteBatchItem* > typeSpriteNameHash
protected

◆ typeSpritePositionHash

typedef HashMap< SpriteBatchItem::LogicalPosition, SpriteBatchItem* > typeSpritePositionHash
protected

Constructor & Destructor Documentation

◆ SpriteBatch()

SpriteBatch ( )

◆ ~SpriteBatch()

~SpriteBatch ( )
virtual

Member Function Documentation

◆ addSprite()

U32 addSprite ( const SpriteBatchItem::LogicalPosition & logicalPosition)

◆ clearSpriteAsset()

void clearSpriteAsset ( void )

◆ clearSprites()

void clearSprites ( void )
virtual

◆ copyTo()

void copyTo ( SpriteBatch * pSpriteBatch) const
virtual

◆ createQueryProxy()

void createQueryProxy ( SpriteBatchItem * pSpriteBatchItem)

◆ createSprite() [1/3]

SpriteBatchItem * createSprite ( const SpriteBatchItem::LogicalPosition & logicalPosition)
protectedvirtual

Reimplemented in CompositeSprite.

◆ createSprite() [2/3]

SpriteBatchItem * createSprite ( const Vector2 * explicitVertices)
protected

◆ createSprite() [3/3]

SpriteBatchItem * createSprite ( void )
protected

◆ createSpriteBatchQuery()

void createSpriteBatchQuery ( void )
protected

◆ deselectSprite()

void deselectSprite ( void )
inline

◆ destroyQueryProxy()

void destroyQueryProxy ( SpriteBatchItem * pSpriteBatchItem)

◆ destroySpriteBatchQuery()

void destroySpriteBatchQuery ( void )
protected

◆ findSpriteId()

SpriteBatchItem * findSpriteId ( const U32 batchId)
protected

◆ findSpriteName()

SpriteBatchItem * findSpriteName ( const char * pName)
protected

◆ findSpritePosition()

SpriteBatchItem * findSpritePosition ( const SpriteBatchItem::LogicalPosition & logicalPosition)
protected

◆ getBatchCulling()

bool getBatchCulling ( void ) const
inline

◆ getBatchSortMode()

SceneRenderQueue::RenderSort getBatchSortMode ( void ) const
inline

◆ getBatchTransform()

const b2Transform & getBatchTransform ( void ) const
inline

◆ getBatchTransformDirty()

bool getBatchTransformDirty ( void ) const
inline

◆ getBatchTransformId()

U32 getBatchTransformId ( void )
inline

◆ getDefaultSpriteAngle()

F32 getDefaultSpriteAngle ( void ) const
inline

◆ getDefaultSpriteSize()

const Vector2 & getDefaultSpriteSize ( void ) const
inline

◆ getDefaultSpriteStride()

const Vector2 & getDefaultSpriteStride ( void ) const
inline

◆ getLocalAABB()

const b2AABB & getLocalAABB ( void )
inline

◆ getLocalExtents()

const Vector2 & getLocalExtents ( void )
inline

◆ getLocalExtentsDirty()

bool getLocalExtentsDirty ( void ) const
inline

◆ getSpriteAlphaTest()

F32 getSpriteAlphaTest ( void ) const

◆ getSpriteAngle()

F32 getSpriteAngle ( void ) const

◆ getSpriteAnimation()

StringTableEntry getSpriteAnimation ( void ) const

◆ getSpriteAnimationFrame()

U32 getSpriteAnimationFrame ( void ) const

◆ getSpriteBatchQuery()

SpriteBatchQuery * getSpriteBatchQuery ( const bool clearQuery = false)

◆ getSpriteBlendAlpha()

F32 getSpriteBlendAlpha ( void ) const

◆ getSpriteBlendColor()

const ColorF & getSpriteBlendColor ( void ) const

◆ getSpriteBlendMode()

bool getSpriteBlendMode ( void ) const

◆ getSpriteComplexColor()

const ColorF & getSpriteComplexColor ( const S8 cornerID) const

◆ getSpriteCount()

U32 getSpriteCount ( void )
inline

◆ getSpriteDataObject()

SimObject * getSpriteDataObject ( void ) const

◆ getSpriteDepth()

F32 getSpriteDepth ( void ) const

◆ getSpriteDstBlendFactor()

GLenum getSpriteDstBlendFactor ( void ) const

◆ getSpriteFlipX()

bool getSpriteFlipX ( void ) const

◆ getSpriteFlipY()

bool getSpriteFlipY ( void ) const

◆ getSpriteId()

U32 getSpriteId ( void ) const

◆ getSpriteImage()

StringTableEntry getSpriteImage ( void ) const

◆ getSpriteImageFrame()

U32 getSpriteImageFrame ( void ) const

◆ getSpriteLocalPosition()

Vector2 getSpriteLocalPosition ( void )

◆ getSpriteLogicalPosition()

const SpriteBatchItem::LogicalPosition getSpriteLogicalPosition ( void ) const

◆ getSpriteName()

StringTableEntry getSpriteName ( void ) const

◆ getSpriteNamedImageFrame()

StringTableEntry getSpriteNamedImageFrame ( void ) const

◆ getSpriteRenderGroup()

StringTableEntry getSpriteRenderGroup ( void ) const

◆ getSpriteSize()

Vector2 getSpriteSize ( void ) const

◆ getSpriteSortPoint()

Vector2 getSpriteSortPoint ( void ) const

◆ getSpriteSrcBlendFactor()

GLenum getSpriteSrcBlendFactor ( void ) const

◆ getSpriteUseComplexColor()

bool getSpriteUseComplexColor ( void ) const

◆ getSpriteVisible()

bool getSpriteVisible ( void ) const

◆ getUserData()

void * getUserData ( void ) const

◆ integrateSprites()

void integrateSprites ( const F32 totalTime,
const F32 elapsedTime,
DebugStats * pDebugStats )
protected

◆ isSpriteSelected()

bool isSpriteSelected ( void ) const
inline

◆ moveQueryProxy()

void moveQueryProxy ( SpriteBatchItem * pSpriteBatchItem,
const b2AABB & localAABB )

◆ onAdd()

bool onAdd ( void )
virtual

Reimplemented in CompositeSprite.

◆ onRemove()

void onRemove ( )
virtual

Reimplemented in CompositeSprite.

◆ onTamlCustomRead()

void onTamlCustomRead ( const TamlCustomNodes & customNodes)
protected

◆ onTamlCustomWrite()

void onTamlCustomWrite ( TamlCustomNodes & customNodes)
protected

◆ prepareRender()

void prepareRender ( SceneRenderObject * pSceneRenderObject,
const SceneRenderState * pSceneRenderState,
SceneRenderQueue * pSceneRenderQueue )

◆ removeSprite()

bool removeSprite ( void )

◆ render()

void render ( const SceneRenderState * pSceneRenderState,
const SceneRenderRequest * pSceneRenderRequest,
BatchRender * pBatchRenderer )

◆ selectSprite()

bool selectSprite ( const SpriteBatchItem::LogicalPosition & logicalPosition)

◆ selectSpriteId()

bool selectSpriteId ( const U32 batchId)

◆ selectSpriteName()

bool selectSpriteName ( const char * pName)

◆ setBatchCulling()

void setBatchCulling ( const bool batchCulling)

◆ setBatchSortMode()

void setBatchSortMode ( SceneRenderQueue::RenderSort sortMode)
inline

◆ setBatchTransform()

void setBatchTransform ( const b2Transform & batchTransform)
protected

◆ setBatchTransformDirty()

void setBatchTransformDirty ( void )
inline

◆ setDefaultSpriteAngle()

void setDefaultSpriteAngle ( const F32 defaultAngle)
inline

◆ setDefaultSpriteSize()

void setDefaultSpriteSize ( const Vector2 & defaultSize)
inline

◆ setDefaultSpriteStride()

void setDefaultSpriteStride ( const Vector2 & defaultStride)
inline

◆ setLocalExtentsDirty()

void setLocalExtentsDirty ( void )
inline

◆ setSpriteAlphaTest()

void setSpriteAlphaTest ( const F32 alphaTestMode)

◆ setSpriteAngle()

void setSpriteAngle ( const F32 localAngle)

◆ setSpriteAnimation()

void setSpriteAnimation ( const char * pAssetId)

◆ setSpriteAnimationFrame()

void setSpriteAnimationFrame ( const U32 animationFrame)

◆ setSpriteBlendAlpha()

void setSpriteBlendAlpha ( const F32 alpha)

◆ setSpriteBlendColor()

void setSpriteBlendColor ( const ColorF & blendColor)

◆ setSpriteBlendMode()

void setSpriteBlendMode ( const bool blendMode)

◆ setSpriteComplexColor()

void setSpriteComplexColor ( const ColorF & blendColor0,
const ColorF & blendColor1,
const ColorF & blendColor2,
const ColorF & blendColor3 )

◆ setSpriteDataObject()

void setSpriteDataObject ( SimObject * pDataObject)

◆ setSpriteDepth()

void setSpriteDepth ( const F32 depth)

◆ setSpriteDstBlendFactor()

void setSpriteDstBlendFactor ( GLenum dstBlendFactor)

◆ setSpriteFlipX()

void setSpriteFlipX ( const bool flipX)

◆ setSpriteFlipY()

void setSpriteFlipY ( const bool flipY)

◆ setSpriteImage() [1/2]

void setSpriteImage ( const char * pAssetId,
const char * namedFrame )

◆ setSpriteImage() [2/2]

void setSpriteImage ( const char * pAssetId,
const U32 imageFrame )

◆ setSpriteImageFrame()

void setSpriteImageFrame ( const U32 imageFrame)

◆ setSpriteLocalPosition()

void setSpriteLocalPosition ( const Vector2 & localPosition)

◆ setSpriteName()

void setSpriteName ( const char * pName)

◆ setSpriteNamedImageFrame()

void setSpriteNamedImageFrame ( const char * namedFrame)

◆ setSpriteRenderGroup()

void setSpriteRenderGroup ( const char * pRenderGroup)

◆ setSpriteSize()

void setSpriteSize ( const Vector2 & size)

◆ setSpriteSortPoint()

void setSpriteSortPoint ( const Vector2 & sortPoint)

◆ setSpriteSrcBlendFactor()

void setSpriteSrcBlendFactor ( GLenum srcBlendFactor)

◆ setSpriteUseComplexColor()

void setSpriteUseComplexColor ( const bool complexColor)

◆ setSpriteVisible()

void setSpriteVisible ( const bool visible)

◆ setUserData()

void setUserData ( void * pUserData)

◆ updateLocalExtents()

void updateLocalExtents ( const b2AABB * precalculatedLocalAABB = NULL)
protected

◆ WriteCustomTamlSchema()

void WriteCustomTamlSchema ( const AbstractClassRep * pClassRep,
TiXmlElement * pParentElement )
static

Member Data Documentation

◆ INVALID_SPRITE_PROXY

const S32 INVALID_SPRITE_PROXY = -1
static

◆ mBatchCulling

bool mBatchCulling
protected

◆ mBatchSortMode

SceneRenderQueue::RenderSort mBatchSortMode
protected

◆ mDefaultSpriteAngle

F32 mDefaultSpriteAngle
protected

◆ mDefaultSpriteSize

Vector2 mDefaultSpriteSize
protected

◆ mDefaultSpriteStride

Vector2 mDefaultSpriteStride
protected

◆ mSelectedSprite

SpriteBatchItem* mSelectedSprite
protected

◆ mSpriteNames

typeSpriteNameHash mSpriteNames
protected

◆ mSpritePositions

typeSpritePositionHash mSpritePositions
protected

◆ mSprites

typeSpriteBatchHash mSprites
protected
The documentation for this class was generated from the following files:
Generated by doxygen 1.16.1