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

#include <SpriteBatchItem.h>

Inheritance diagram for SpriteBatchItem:

Classes

struct  DrawDatType
struct  LogicalPosition

Public Types

typedef struct SpriteBatchItem::DrawDatType drawData

Public Member Functions

 SpriteBatchItem ()
virtual ~SpriteBatchItem ()
virtual void resetState (void)
SpriteBatch * getBatchParent (void) const
U32 getBatchId (void) const
S32 getProxyId (void) const
StringTableEntry getName (void) const
void setLogicalPosition (const LogicalPosition &logicalPosition)
const LogicalPosition & getLogicalPosition (void) const
void setVisible (const bool visible)
bool getVisible (void) const
void setExplicitMode (const bool explicitMode)
bool getExplicitMode (void) const
void setTriangleRun (const bool usesTriangles)
bool getTriangleRun (void) const
drawData * getDrawData (void)
void setLocalPosition (const Vector2 &localPosition)
Vector2 getLocalPosition (void) const
void setExplicitVertices (const F32 *vertices, const F32 *uvs=0)
void setLocalAngle (const F32 localAngle)
F32 getLocalAngle (void) const
void setSize (const Vector2 &size)
Vector2 getSize (void) const
const b2AABB & getLocalAABB (void)
void setDepth (const F32 depth)
F32 getDepth (void) const
void setFlipX (const bool flipX)
bool getFlipX (void) const
void setFlipY (const bool flipY)
bool getFlipY (void) const
void setSortPoint (const Vector2 &sortPoint)
Vector2 getSortPoint (void) const
void setRenderGroup (const char *pRenderGroup)
StringTableEntry getRenderGroup (void) const
void setBlendMode (const bool blendMode)
bool getBlendMode (void) const
void setSrcBlendFactor (GLenum srcBlendFactor)
GLenum getSrcBlendFactor (void) const
void setDstBlendFactor (GLenum dstBlendFactor)
GLenum getDstBlendFactor (void) const
void setBlendColor (const ColorF &blendColor)
const ColorF & getBlendColor (void) const
void setBlendAlpha (const F32 alpha)
F32 getBlendAlpha (void) const
void setUseComplexColor (const bool complexColor)
bool getUseComplexColor (void) const
void setComplexColor (const ColorF &blendColor0, const ColorF &blendColor1, const ColorF &blendColor2, const ColorF &blendColor3)
const ColorF & getComplexColor (const S8 cornerID)
void setAlphaTest (const F32 alphaTest)
F32 getAlphaTest (void) const
void setDataObject (SimObject *pDataObject)
SimObject * getDataObject (void) const
void setUserData (void *pUserData)
void * getUserData (void) const
template<class T>
T * getUserData (void) const
void setSpriteBatchQueryKey (const U32 key)
U32 getSpriteBatchQueryKey (void) const
virtual void copyTo (SpriteBatchItem *pSpriteBatchItem) const
const Vector2 * getLocalOOBB (void) const
const Vector2 * getRenderOOBB (void) const
void prepareRender (SceneRenderRequest *pSceneRenderRequest, const U32 batchTransformId)
void render (BatchRender *pBatchRenderer, const SceneRenderRequest *pSceneRenderRequest, const U32 batchTransformId)
Public Member Functions inherited from ImageFrameProvider
 ImageFrameProvider ()
virtual ~ImageFrameProvider ()
Public Member Functions inherited from ImageFrameProviderCore
 ImageFrameProviderCore ()
virtual ~ImageFrameProviderCore ()
void allocateAssets (AssetPtr< ImageAsset > *pImageAssetPtr, AssetPtr< AnimationAsset > *pAnimationAssetPtr)
void deallocateAssets (void)
virtual void copyTo (ImageFrameProviderCore *pImageFrameProviderCore) const
virtual bool update (const F32 elapsedTime)
 Integration.
virtual void processTick ()
virtual void interpolateTick (F32 delta)
virtual void advanceTime (F32 timeDelta)
virtual void setProcessTicks (bool tick)
bool updateAnimation (const F32 elapsedTime)
virtual bool validRender (void) const
virtual void render (const bool flipX, const bool flipY, const Vector2 &vertexPos0, const Vector2 &vertexPos1, const Vector2 &vertexPos2, const Vector2 &vertexPos3, BatchRender *pBatchRenderer) const
virtual void render (const bool flipX, const bool flipY, const Vector2 &vertexPos0, const Vector2 &vertexPos1, const Vector2 &vertexPos2, const Vector2 &vertexPos3, const Vector2 &uvPos0, const Vector2 &uvPos1, const Vector2 &uvPos2, const Vector2 &uvPos3, BatchRender *pBatchRenderer) const
void render (const U32 vertexCount, const Vector2 *vertexArray, const Vector2 *textureArray, const ColorF *colorArray, BatchRender *pBatchRenderer) const
void renderComplex (const bool flipX, const bool flipY, const Vector2 &vertexPos0, const Vector2 &vertexPos1, const Vector2 &vertexPos2, const Vector2 &vertexPos3, BatchRender *pBatchRenderer, const ColorF &colorTL, const ColorF &colorTR, const ColorF &colorBR, const ColorF &colorBL) const
void renderGui (GuiControl &owner, Point2I offset, const RectI &updateRect) const
bool setImage (const char *pImageAssetId)
 Static-Image Frame.
virtual bool setImage (const char *pImageAssetId, const U32 frame)
virtual bool setImage (const char *pImageAssetId, const char *pNamedFrame)
StringTableEntry getImage (void) const
virtual bool setImageFrame (const U32 frame)
U32 getImageFrame (void) const
virtual bool setNamedImageFrame (const char *frame)
StringTableEntry getNamedImageFrame (void) const
virtual bool setAnimation (const char *pAnimationAssetId)
 Animated-Image Frame.
StringTableEntry getAnimation (void) const
void setAnimationFrame (const U32 frameIndex)
S32 getAnimationFrame (void) const
void setAnimationTimeScale (const F32 scale)
F32 getAnimationTimeScale (void) const
bool playAnimation (const AssetPtr< AnimationAsset > &animationAsset)
void pauseAnimation (const bool animationPaused)
void stopAnimation (void)
void resetAnimationTime (void)
bool isAnimationPaused (void) const
bool isAnimationFinished (void) const
bool isAnimationValid (void) const
bool isStaticFrameProvider (void) const
 Frame provision.
bool isUsingNamedImageFrame (void) const
TextureHandle & getProviderTexture (void) const
const ImageAsset::FrameArea & getProviderImageFrameArea (void) const
const AnimationAsset * getCurrentAnimation (void) const
const StringTableEntry getCurrentAnimationAssetId (void) const
const U32 getCurrentAnimationFrame (void) const
const char * getCurrentNamedAnimationFrame (void) const
const F32 getCurrentAnimationTime (void) const
void clearAssets (void)
Public Member Functions inherited from Tickable
 Tickable ()
virtual ~Tickable ()
virtual bool isProcessingTicks () const

Static Public Member Functions

static void WriteCustomTamlSchema (const AbstractClassRep *pClassRep, TiXmlElement *pParentElement)
Static Public Member Functions inherited from Tickable
static bool advanceTime (U32 timeDelta)

Protected Member Functions

void setBatchParent (SpriteBatch *pSpriteBatch, const U32 batchId)
void setProxyId (const S32 proxyId)
void setName (const char *pName)
void updateLocalTransform (void)
void updateWorldTransform (const U32 batchTransformId)
void onTamlCustomWrite (TamlCustomNode *pParentNode)
void onTamlCustomRead (const TamlCustomNode *pSpriteNode)
Protected Member Functions inherited from ImageFrameProvider
virtual void onAssetRefreshed (AssetPtrBase *pAssetPtrBase)
Protected Member Functions inherited from ImageFrameProviderCore
virtual void onAnimationEnd (void)

Protected Attributes

SpriteBatch * mSpriteBatch
U32 mBatchId
S32 mProxyId
StringTableEntry mName
LogicalPosition mLogicalPosition
bool mVisible
bool mExplicitMode
Vector2 mLocalPosition
Vector2 mExplicitVerts [4]
Vector2 mExplicitUVs [4]
bool mTriangleRun
drawData mDrawData
F32 mLocalAngle
Vector2 mSize
F32 mDepth
bool mFlipX
bool mFlipY
Vector2 mSortPoint
StringTableEntry mRenderGroup
bool mBlendMode
GLenum mSrcBlendFactor
GLenum mDstBlendFactor
ColorF mBlendColor
F32 mAlphaTest
bool mUseComplexColor
ColorF mComplexColor0
ColorF mComplexColor1
ColorF mComplexColor2
ColorF mComplexColor3
SimObjectPtr< SimObject > mDataObject
Vector2 mLocalOOBB [4]
b2AABB mLocalAABB
bool mLocalTransformDirty
Vector2 mRenderOOBB [4]
b2AABB mRenderAABB
Vector2 mRenderPosition
U32 mLastBatchTransformId
U32 mSpriteBatchQueryKey
void * mUserData
Protected Attributes inherited from ImageFrameProvider
AssetPtr< ImageAsset > mImageAsset
AssetPtr< AnimationAsset > mAnimationAsset
Protected Attributes inherited from ImageFrameProviderCore
bool mSelfTick
bool mStaticProvider
bool mUsingNamedFrame
U32 mImageFrame
StringTableEntry mNamedImageFrame
AssetPtr< ImageAsset > * mpImageAsset
AssetPtr< AnimationAsset > * mpAnimationAsset
S32 mLastFrameIndex
S32 mCurrentFrameIndex
U32 mMaxFrameIndex
F32 mCurrentTime
F32 mPausedTime
F32 mCurrentModTime
F32 mAnimationTimeScale
F32 mTotalIntegrationTime
F32 mFrameIntegrationTime
bool mAnimationPaused
bool mAnimationFinished

Friends

class SpriteBatch

Additional Inherited Members

Static Public Attributes inherited from Tickable
static const U32 smTickShift = 4
 Shift value to control how often Ticks occur.
static const U32 smTickMs = ( 1 << smTickShift )
 Number of milliseconds per tick, 32 in this case.
static const F32 smTickSec = ( F32( Tickable::smTickMs ) / 1000.f )
 Fraction of a second per tick.
static const U32 smTickMask = ( smTickMs - 1 )

Member Typedef Documentation

◆ drawData

typedef struct SpriteBatchItem::DrawDatType drawData

Constructor & Destructor Documentation

◆ SpriteBatchItem()

SpriteBatchItem ( )

◆ ~SpriteBatchItem()

~SpriteBatchItem ( )
virtual

Member Function Documentation

◆ copyTo()

void copyTo ( SpriteBatchItem * pSpriteBatchItem) const
virtual

◆ getAlphaTest()

F32 getAlphaTest ( void ) const
inline

◆ getBatchId()

U32 getBatchId ( void ) const
inline

◆ getBatchParent()

SpriteBatch * getBatchParent ( void ) const
inline

◆ getBlendAlpha()

F32 getBlendAlpha ( void ) const
inline

◆ getBlendColor()

const ColorF & getBlendColor ( void ) const
inline

◆ getBlendMode()

bool getBlendMode ( void ) const
inline

◆ getComplexColor()

const ColorF & getComplexColor ( const S8 cornerID)

◆ getDataObject()

SimObject * getDataObject ( void ) const
inline

◆ getDepth()

F32 getDepth ( void ) const
inline

◆ getDrawData()

drawData * getDrawData ( void )
inline

◆ getDstBlendFactor()

GLenum getDstBlendFactor ( void ) const
inline

◆ getExplicitMode()

bool getExplicitMode ( void ) const
inline

◆ getFlipX()

bool getFlipX ( void ) const
inline

◆ getFlipY()

bool getFlipY ( void ) const
inline

◆ getLocalAABB()

const b2AABB & getLocalAABB ( void )
inline

◆ getLocalAngle()

F32 getLocalAngle ( void ) const
inline

◆ getLocalOOBB()

const Vector2 * getLocalOOBB ( void ) const
inline

◆ getLocalPosition()

Vector2 getLocalPosition ( void ) const
inline

◆ getLogicalPosition()

const LogicalPosition & getLogicalPosition ( void ) const
inline

◆ getName()

StringTableEntry getName ( void ) const
inline

◆ getProxyId()

S32 getProxyId ( void ) const
inline

◆ getRenderGroup()

StringTableEntry getRenderGroup ( void ) const
inline

◆ getRenderOOBB()

const Vector2 * getRenderOOBB ( void ) const
inline

◆ getSize()

Vector2 getSize ( void ) const
inline

◆ getSortPoint()

Vector2 getSortPoint ( void ) const
inline

◆ getSpriteBatchQueryKey()

U32 getSpriteBatchQueryKey ( void ) const
inline

◆ getSrcBlendFactor()

GLenum getSrcBlendFactor ( void ) const
inline

◆ getTriangleRun()

bool getTriangleRun ( void ) const
inline

◆ getUseComplexColor()

bool getUseComplexColor ( void ) const
inline

◆ getUserData() [1/2]

template<class T>
T * getUserData ( void ) const
inline

◆ getUserData() [2/2]

void * getUserData ( void ) const
inline

◆ getVisible()

bool getVisible ( void ) const
inline

◆ onTamlCustomRead()

void onTamlCustomRead ( const TamlCustomNode * pSpriteNode)
protected

◆ onTamlCustomWrite()

void onTamlCustomWrite ( TamlCustomNode * pParentNode)
protected

◆ prepareRender()

void prepareRender ( SceneRenderRequest * pSceneRenderRequest,
const U32 batchTransformId )

◆ render()

void render ( BatchRender * pBatchRenderer,
const SceneRenderRequest * pSceneRenderRequest,
const U32 batchTransformId )

◆ resetState()

void resetState ( void )
virtual

Reimplemented from ImageFrameProviderCore.

◆ setAlphaTest()

void setAlphaTest ( const F32 alphaTest)
inline

◆ setBatchParent()

void setBatchParent ( SpriteBatch * pSpriteBatch,
const U32 batchId )
protected

◆ setBlendAlpha()

void setBlendAlpha ( const F32 alpha)
inline

◆ setBlendColor()

void setBlendColor ( const ColorF & blendColor)
inline

◆ setBlendMode()

void setBlendMode ( const bool blendMode)
inline

◆ setComplexColor()

void setComplexColor ( const ColorF & blendColor0,
const ColorF & blendColor1,
const ColorF & blendColor2,
const ColorF & blendColor3 )
inline

◆ setDataObject()

void setDataObject ( SimObject * pDataObject)
inline

◆ setDepth()

void setDepth ( const F32 depth)
inline

◆ setDstBlendFactor()

void setDstBlendFactor ( GLenum dstBlendFactor)
inline

◆ setExplicitMode()

void setExplicitMode ( const bool explicitMode)
inline

◆ setExplicitVertices()

void setExplicitVertices ( const F32 * vertices,
const F32 * uvs = 0 )

◆ setFlipX()

void setFlipX ( const bool flipX)
inline

◆ setFlipY()

void setFlipY ( const bool flipY)
inline

◆ setLocalAngle()

void setLocalAngle ( const F32 localAngle)
inline

◆ setLocalPosition()

void setLocalPosition ( const Vector2 & localPosition)
inline

◆ setLogicalPosition()

void setLogicalPosition ( const LogicalPosition & logicalPosition)
inline

◆ setName()

void setName ( const char * pName)
inlineprotected

◆ setProxyId()

void setProxyId ( const S32 proxyId)
inlineprotected

◆ setRenderGroup()

void setRenderGroup ( const char * pRenderGroup)
inline

◆ setSize()

void setSize ( const Vector2 & size)
inline

◆ setSortPoint()

void setSortPoint ( const Vector2 & sortPoint)
inline

◆ setSpriteBatchQueryKey()

void setSpriteBatchQueryKey ( const U32 key)
inline

◆ setSrcBlendFactor()

void setSrcBlendFactor ( GLenum srcBlendFactor)
inline

◆ setTriangleRun()

void setTriangleRun ( const bool usesTriangles)
inline

◆ setUseComplexColor()

void setUseComplexColor ( const bool complexColor)
inline

◆ setUserData()

void setUserData ( void * pUserData)
inline

◆ setVisible()

void setVisible ( const bool visible)
inline

◆ updateLocalTransform()

void updateLocalTransform ( void )
protected

◆ updateWorldTransform()

void updateWorldTransform ( const U32 batchTransformId)
protected

◆ WriteCustomTamlSchema()

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

◆ SpriteBatch

friend class SpriteBatch
friend

Member Data Documentation

◆ mAlphaTest

F32 mAlphaTest
protected

◆ mBatchId

U32 mBatchId
protected

◆ mBlendColor

ColorF mBlendColor
protected

◆ mBlendMode

bool mBlendMode
protected

◆ mComplexColor0

ColorF mComplexColor0
protected

◆ mComplexColor1

ColorF mComplexColor1
protected

◆ mComplexColor2

ColorF mComplexColor2
protected

◆ mComplexColor3

ColorF mComplexColor3
protected

◆ mDataObject

SimObjectPtr<SimObject> mDataObject
protected

◆ mDepth

F32 mDepth
protected

◆ mDrawData

drawData mDrawData
protected

◆ mDstBlendFactor

GLenum mDstBlendFactor
protected

◆ mExplicitMode

bool mExplicitMode
protected

◆ mExplicitUVs

Vector2 mExplicitUVs[4]
protected

◆ mExplicitVerts

Vector2 mExplicitVerts[4]
protected

◆ mFlipX

bool mFlipX
protected

◆ mFlipY

bool mFlipY
protected

◆ mLastBatchTransformId

U32 mLastBatchTransformId
protected

◆ mLocalAABB

b2AABB mLocalAABB
protected

◆ mLocalAngle

F32 mLocalAngle
protected

◆ mLocalOOBB

Vector2 mLocalOOBB[4]
protected

◆ mLocalPosition

Vector2 mLocalPosition
protected

◆ mLocalTransformDirty

bool mLocalTransformDirty
protected

◆ mLogicalPosition

LogicalPosition mLogicalPosition
protected

◆ mName

StringTableEntry mName
protected

◆ mProxyId

S32 mProxyId
protected

◆ mRenderAABB

b2AABB mRenderAABB
protected

◆ mRenderGroup

StringTableEntry mRenderGroup
protected

◆ mRenderOOBB

Vector2 mRenderOOBB[4]
protected

◆ mRenderPosition

Vector2 mRenderPosition
protected

◆ mSize

Vector2 mSize
protected

◆ mSortPoint

Vector2 mSortPoint
protected

◆ mSpriteBatch

SpriteBatch* mSpriteBatch
protected

◆ mSpriteBatchQueryKey

U32 mSpriteBatchQueryKey
protected

◆ mSrcBlendFactor

GLenum mSrcBlendFactor
protected

◆ mTriangleRun

bool mTriangleRun
protected

◆ mUseComplexColor

bool mUseComplexColor
protected

◆ mUserData

void* mUserData
protected

◆ mVisible

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