#include <CompositeSprite.h>

Inheritance diagram for CompositeSprite:

Public Types
enum	BatchLayoutType { INVALID_LAYOUT, NO_LAYOUT, RECTILINEAR_LAYOUT, ISOMETRIC_LAYOUT, CUSTOM_LAYOUT }

Public Member Functions
	CompositeSprite ()

virtual	~CompositeSprite ()

virtual bool	onAdd ()

virtual void	onRemove ()

virtual void	preIntegrate (const F32 totalTime, const F32 elapsedTime, DebugStats *pDebugStats)
	Integration. More...

virtual void	integrateObject (const F32 totalTime, const F32 elapsedTime, DebugStats *pDebugStats)

virtual void	interpolateObject (const F32 timeDelta)

virtual bool	canPrepareRender (void) const
	Render Output. More...

virtual bool	shouldRender (void) const

virtual void	scenePrepareRender (const SceneRenderState pSceneRenderState, SceneRenderQueue pSceneRenderQueue)

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

virtual void	copyTo (SimObject *object)

void	setBatchLayout (const BatchLayoutType &batchLayoutType)

BatchLayoutType	getBatchLayout (void) const

	DECLARE_CONOBJECT (CompositeSprite)
	Declare Console Object. More...

Public Member Functions inherited from SceneObject
	SceneObject ()

virtual	~SceneObject ()

virtual void	onDestroyNotify (SceneObject *pSceneObject)

virtual void	postIntegrate (const F32 totalTime, const F32 elapsedTime, DebugStats *pDebugStats)

bool	getIsEditorTickAllowed (void) const

void	setBatchIsolated (const bool batchIsolated)
	Render batching. More...

virtual bool	getBatchIsolated (void)

virtual bool	isBatchRendered (void)

virtual bool	validRender (void) const

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

virtual void	sceneRenderOverlay (const SceneRenderState *pSceneRenderState)

virtual U32	packUpdate (NetConnection conn, U32 mask, BitStream stream)
	Networking. More...

virtual void	unpackUpdate (NetConnection conn, BitStream stream)

Scene *const	getScene (void) const
	Scene. More...

F32	getSceneTime (void) const

virtual void	setEnabled (const bool enabled)
	Enabled. More...

void	setLifetime (const F32 lifetime)
	Lifetime. More...

F32	getLifetime (void) const

void	updateLifetime (const F32 elapsedTime)

void	setSceneLayer (const U32 sceneLayer)
	Scene layers. More...

U32	getSceneLayer (void) const

U32	getSceneLayerMask (void) const

void	setSceneLayerDepth (const F32 order)
	Scene Layer depth. More...

F32	getSceneLayerDepth (void) const

bool	setSceneLayerDepthFront (void)

bool	setSceneLayerDepthBack (void)

bool	setSceneLayerDepthForward (void)

bool	setSceneLayerDepthBackward (void)

void	setSceneGroup (const U32 sceneGroup)
	Scene groups. More...

U32	getSceneGroup (void) const

U32	getSceneGroupMask (void) const

virtual void	setArea (const Vector2 &corner1, const Vector2 &corner2)
	Area. More...

bool	getAutoSizing (void) const

virtual void	setSize (const Vector2 &size)

void	setSize (const F32 width, const F32 height)

Vector2	getSize (void) const

Vector2	getHalfSize (void) const

b2AABB	getAABB (void) const

RectF	getAABBRectangle (void) const

S32	getWorldProxy (void) const

virtual void	setPosition (const Vector2 &position)
	Position / Angle. More...

Vector2	getPosition (void) const

Vector2	getRenderPosition (void) const

F32	getRenderAngle (void) const

const b2Vec2 *	getRenderOOBB (void) const

const b2Vec2 *	getLocalSizedOOBB (void) const

virtual void	setAngle (const F32 radians)

F32	getAngle (void) const

virtual void	setFixedAngle (const bool fixed)

bool	getFixedAngle (void) const

b2Transform	getTransform (void) const

b2Transform	getRenderTransform (void) const

Vector2	getLocalCenter (void) const

Vector2	getWorldCenter (void) const

Vector2	getLocalPoint (const Vector2 &worldPoint)

Vector2	getWorldPoint (const Vector2 &localPoint)

Vector2	getLocalVector (const Vector2 &worldVector)

Vector2	getWorldVector (const Vector2 &localVector)

bool	getIsPointInOOBB (const Vector2 &worldPoint)

bool	getIsPointInCollisionShape (const U32 shapeIndex, const Vector2 &worldPoint)

virtual ePhysicsProxyType	getPhysicsProxyType (void) const
	Body. More...

b2Body *	getBody (void) const

void	setBodyType (const b2BodyType type)

b2BodyType	getBodyType (void) const

void	setActive (const bool active)

bool	getActive (void) const

void	setAwake (const bool awake)

bool	getAwake (void) const

void	setBullet (const bool bullet)

bool	getBullet (void) const

void	setSleepingAllowed (const bool allowed)

bool	getSleepingAllowed (void) const

F32	getMass (void) const

F32	getInertia (void) const

void	setCollisionAgainst (const SceneObject *pSceneObject, const bool clearMasks)
	Collision control. More...

void	setCollisionGroupMask (const U32 groupMask)

U32	getCollisionGroupMask (void) const

void	setCollisionLayerMask (const U32 layerMask)

U32	getCollisionLayerMask (void) const

void	setDefaultDensity (const F32 density, const bool updateShapes=true)

F32	getDefaultDensity (void) const

void	setDefaultFriction (const F32 friction, const bool updateShapes=true)

F32	getDefaultFriction (void) const

void	setDefaultRestitution (const F32 restitution, const bool updateShapes=true)

F32	getDefaultRestitution (void) const

void	setCollisionSuppress (const bool status)

bool	getCollisionSuppress (void) const

const Scene::typeContactVector *	getCurrentContacts (void) const

U32	getCurrentContactCount (void) const

virtual void	setGatherContacts (const bool gatherContacts)

bool	getGatherContacts (void) const

virtual void	onBeginCollision (const TickContact &tickContact)

virtual void	onEndCollision (const TickContact &tickContact)

void	setLinearVelocity (const Vector2 &velocity)
	Velocities. More...

Vector2	getLinearVelocity (void) const

Vector2	getLinearVelocityFromWorldPoint (const Vector2 &worldPoint)

Vector2	getLinearVelocityFromLocalPoint (const Vector2 &localPoint)

void	setAngularVelocity (const F32 velocity)

F32	getAngularVelocity (void) const

void	setLinearDamping (const F32 damping)

F32	getLinearDamping (void) const

void	setAngularDamping (const F32 damping)

F32	getAngularDamping (void) const

bool	moveTo (const Vector2 &targetWorldPoint, const F32 speed, const bool autoStop=true, const bool warpToTarget=true)
	Move/Rotate to. More...

bool	rotateTo (const F32 targetAngle, const F32 speed, const bool autoStop=true, const bool warpToTarget=true)

void	cancelMoveTo (const bool autoStop=true)

void	cancelRotateTo (const bool autoStop=true)

bool	isMoveToComplete (void) const

bool	isRotateToComplete (void) const

void	applyForce (const Vector2 &worldForce, const bool wake=true)
	Force and impulse. More...

void	applyForce (const Vector2 &worldForce, const Vector2 &worldPoint, const bool wake=true)

void	applyTorque (const F32 torque, const bool wake=true)

void	applyLinearImpulse (const Vector2 &worldImpulse, const bool wake=true)

void	applyLinearImpulse (const Vector2 &worldImpulse, const Vector2 &worldPoint, const bool wake=true)

void	applyAngularImpulse (const F32 impulse, const bool wake=true)

void	setGravityScale (const F32 scale)
	Gravity scaling. More...

F32	getGravityScale (void) const

void	deleteCollisionShape (const U32 shapeIndex)
	General collision shape access. More...

void	clearCollisionShapes (void)

U32	getCollisionShapeCount (void) const

b2Shape::Type	getCollisionShapeType (const U32 shapeIndex) const

S32	getCollisionShapeIndex (const b2Fixture *pFixture) const

void	setCollisionShapeDefinition (const U32 shapeIndex, const b2FixtureDef &fixtureDef)

b2FixtureDef	getCollisionShapeDefinition (const U32 shapeIndex) const

const b2CircleShape *	getCollisionCircleShape (const U32 shapeIndex) const

const b2PolygonShape *	getCollisionPolygonShape (const U32 shapeIndex) const

const b2ChainShape *	getCollisionChainShape (const U32 shapeIndex) const

const b2EdgeShape *	getCollisionEdgeShape (const U32 shapeIndex) const

void	setCollisionShapeDensity (const U32 shapeIndex, const F32 density)

F32	getCollisionShapeDensity (const U32 shapeIndex) const

void	setCollisionShapeFriction (const U32 shapeIndex, const F32 friction)

F32	getCollisionShapeFriction (const U32 shapeIndex) const

void	setCollisionShapeRestitution (const U32 shapeIndex, const F32 restitution)

F32	getCollisionShapeRestitution (const U32 shapeIndex) const

void	setCollisionShapeIsSensor (const U32 shapeIndex, const bool isSensor)

bool	getCollisionShapeIsSensor (const U32 shapeIndex) const

S32	createCircleCollisionShape (const F32 radius)
	Circle collision shape creation. More...

S32	createCircleCollisionShape (const F32 radius, const b2Vec2 &localPosition)

F32	getCircleCollisionShapeRadius (const U32 shapeIndex) const
	Circle collision shape access. More...

Vector2	getCircleCollisionShapeLocalPosition (const U32 shapeIndex) const

S32	createPolygonCollisionShape (const U32 pointCount, const b2Vec2 *localPoints)
	Polygon collision shape creation. More...

S32	createPolygonBoxCollisionShape (const F32 width, const F32 height)

S32	createPolygonBoxCollisionShape (const F32 width, const F32 height, const b2Vec2 &localCentroid)

S32	createPolygonBoxCollisionShape (const F32 width, const F32 height, const b2Vec2 &localCentroid, const F32 rotation)

U32	getPolygonCollisionShapePointCount (const U32 shapeIndex) const
	Polygon collision shape access. More...

Vector2	getPolygonCollisionShapeLocalPoint (const U32 shapeIndex, const U32 pointIndex) const

S32	createChainCollisionShape (const U32 pointCount, const b2Vec2 *localPoints)
	Chain collision shape creation. More...

S32	createChainCollisionShape (const U32 pointCount, const b2Vec2 *localPoints, const bool hasAdjacentLocalPositionStart, const bool hasAdjacentLocalPositionEnd, const b2Vec2 &adjacentLocalPositionStart, const b2Vec2 &adjacentLocalPositionEnd)

U32	getChainCollisionShapePointCount (const U32 shapeIndex) const
	Chain collision shape access. More...

Vector2	getChainCollisionShapeLocalPoint (const U32 shapeIndex, const U32 pointIndex) const

bool	getChainCollisionShapeHasAdjacentStart (const U32 shapeIndex) const

bool	getChainCollisionShapeHasAdjacentEnd (const U32 shapeIndex) const

Vector2	getChainCollisionShapeAdjacentStart (const U32 shapeIndex) const

Vector2	getChainCollisionShapeAdjacentEnd (const U32 shapeIndex) const

S32	createEdgeCollisionShape (const b2Vec2 &localPositionStart, const b2Vec2 &localPositionEnd)
	Edge collision shape creation. More...

S32	createEdgeCollisionShape (const b2Vec2 &localPositionStart, const b2Vec2 &localPositionEnd, const bool hasAdjacentLocalPositionStart, const bool hasAdjacentLocalPositionEnd, const b2Vec2 &adjacentLocalPositionStart, const b2Vec2 &adjacentLocalPositionEnd)

Vector2	getEdgeCollisionShapeLocalPositionStart (const U32 shapeIndex) const
	Edge collision shape access. More...

Vector2	getEdgeCollisionShapeLocalPositionEnd (const U32 shapeIndex) const

bool	getEdgeCollisionShapeHasAdjacentStart (const U32 shapeIndex) const

bool	getEdgeCollisionShapeHasAdjacentEnd (const U32 shapeIndex) const

Vector2	getEdgeCollisionShapeAdjacentStart (const U32 shapeIndex) const

Vector2	getEdgeCollisionShapeAdjacentEnd (const U32 shapeIndex) const

void	setVisible (const bool status)
	Render visibility. More...

bool	getVisible (void) const

void	setBlendMode (const bool blendMode)
	Render blending. More...

bool	getBlendMode (void) const

void	setSrcBlendFactor (const S32 blendFactor)

S32	getSrcBlendFactor (void) const

void	setDstBlendFactor (const S32 blendFactor)

S32	getDstBlendFactor (void) const

void	setBlendColor (const ColorF &blendColor)

const ColorF &	getBlendColor (void) const

void	setBlendAlpha (const F32 alpha)

F32	getBlendAlpha (void) const

void	setAlphaTest (const F32 alpha)

F32	getAlphaTest (void) const

void	setBlendOptions (void)

void	setSortPoint (const Vector2 &pt)
	Render sorting. More...

const Vector2 &	getSortPoint (void) const

void	setRenderGroup (const char *pRenderGroup)

StringTableEntry	getRenderGroup (void) const

void	setUseInputEvents (bool mouseStatus)
	Input events. More...

bool	getUseInputEvents (void) const

virtual void	onInputEvent (StringTableEntry name, const GuiEvent &event, const Vector2 &worldMousePoint)

void	setUpdateCallback (bool status)

bool	getUpdateCallback (void) const

void	setCollisionCallback (const bool status)

bool	getCollisionCallback (void) const

void	setSleepingCallback (bool status)

bool	getSleepingCallback (void) const

void	setDebugOn (const U32 debugMask)
	Debug mode. More...

void	setDebugOff (const U32 debugMask)

U32	getDebugMask (void) const

void	addCameraMountReference (SceneWindow *pAttachedCamera)
	Camera mounting. More...

void	removeCameraMountReference (void)

void	dismountCamera (void)

void	attachGui (GuiControl pGuiControl, SceneWindow pSceneWindow, const bool sizeControl)

void	detachGui (void)

void	updateAttachedGui (void)

void	setPickingAllowed (const bool pickingAllowed)

bool	getPickingAllowed (void) const

virtual void	copyFrom (SceneObject *pSceneObject, const bool copyDynamicFields)
	Cloning. More...

S32	copyCollisionShapes (SceneObject *pSceneObject, const bool clearTargetShapes=true, const S32 shapeIndex=-1)

void	setSafeDelete (const bool status)
	Safe deletion. More...

bool	getSafeDelete (void) const

bool	isBeingDeleted (void) const

virtual void	safeDelete (void)

void	addDestroyNotification (SceneObject *pSceneObject)
	Destroy notifications. More...

void	removeDestroyNotification (SceneObject *pSceneObject)

void	processDestroyNotifications (void)

void	notifyComponentsAddToScene (void)
	Component notifications. More...

void	notifyComponentsRemoveFromScene (void)

void	notifyComponentsUpdate (void)

const char *	scriptThis (void) const
	Miscellaneous. More...

bool	getIsAlwaysInScope (void) const

void	setWorldQueryKey (const U32 key)

U32	getWorldQueryKey (void) const

U32	getSerialId (void) const

virtual bool	writeField (StringTableEntry fieldname, const char *value)

	DECLARE_CONOBJECT (SceneObject)
	Declare Console Object. More...

Public Member Functions inherited from BehaviorComponent
	BehaviorComponent ()

virtual	~BehaviorComponent ()

virtual void	onDeleteNotify (SimObject *object)

BehaviorInstance *	getBehaviorByInstanceId (const U32 behaviorId)
	Behavior interface. More...

virtual bool	addBehavior (BehaviorInstance *bi)

virtual bool	removeBehavior (BehaviorInstance *bi, bool deleteBehavior=true)

virtual void	clearBehaviors ()

virtual U32	getBehaviorCount () const

virtual const SimSet &	getBehaviors () const

virtual BehaviorInstance *	getBehavior (StringTableEntry behaviorTemplateName)

virtual BehaviorInstance *	getBehavior (const U32 index)

virtual bool	reOrder (BehaviorInstance *obj, U32 desiredIndex)

bool	connect (BehaviorInstance pOutputBehavior, BehaviorInstance pInputBehavior, StringTableEntry pOutputName, StringTableEntry pInputName)
	Behavior connectivity. More...

bool	disconnect (BehaviorInstance pOutputBehavior, BehaviorInstance pInputBehavior, StringTableEntry pOutputName, StringTableEntry pInputName)

bool	raise (BehaviorInstance *pOutputBehavior, StringTableEntry pOutputName)

U32	getBehaviorConnectionCount (BehaviorInstance *pOutputBehavior, StringTableEntry pOutputName)

const BehaviorPortConnection *	getBehaviorConnection (BehaviorInstance *pOutputBehavior, StringTableEntry pOutputName, const U32 connectionIndex)

const typePortConnectionVector *	getBehaviorConnections (BehaviorInstance *pOutputBehavior, StringTableEntry pOutputName)

virtual bool	handlesConsoleMethod (const char fname, S32 routingId)
	DynamicConsoleMethodComponent Overrides. More...

virtual const char *	callOnBehaviors (U32 argc, const char *argv[])

virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)
	SimComponent overrides. More...

	DECLARE_CONOBJECT (BehaviorComponent)

Public Member Functions inherited from DynamicConsoleMethodComponent
const char *	callMethod (S32 argc, const char *methodName,...)
	Call Method format string. More...

virtual const char *	callMethodArgList (U32 argc, const char *argv[], bool callThis=true)
	Call Method. More...

	DECLARE_CONOBJECT (DynamicConsoleMethodComponent)

Public Member Functions inherited from SimComponent
	DECLARE_CONOBJECT (SimComponent)

	SimComponent ()

virtual	~SimComponent ()

virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)) More...

bool	hasComponents () const
	Will return true if this object contains components. More...

const SimComponent *	getOwner () const
	The component which owns this object. More...

virtual StringTableEntry	getComponentName ()

virtual bool	addComponent (SimComponent *component)
	Add Component to this one. More...

virtual bool	removeComponent (SimComponent *component)
	Remove Component from this one. More...

virtual bool	clearComponents ()
	Clear Child components of this one. More...

virtual bool	onComponentAdd (SimComponent *target)

virtual void	onComponentRemove (SimComponent *target)

U32	getComponentCount ()

SimComponent *	getComponent (const U32 index)

bool	isEnabled () const

virtual void	onUpdate (void)

virtual void	onAddToScene (void)

virtual void	onRemoveFromScene (void)

bool	callMethodOnComponents (U32 argc, const char argv[], const char *result)

Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const

StringTableEntry	getSuperClassNamespace () const

void	setClassNamespace (const char *classNamespace)

void	setSuperClassNamespace (const char *superClassNamespace)

void	pushScriptCallbackGuard (void)

void	popScriptCallbackGuard (void)

S32	getScriptCallbackGuard (void)

virtual SimObject *	findObject (const char *name)

Namespace *	getNamespace ()
	Return the object's namespace. More...

const char *	tabComplete (const char *prevText, S32 baseLen, bool)

virtual void	dump ()

virtual void	dumpClassHierarchy ()

SimObject *	clone (const bool copyDynamicFields)

template<typename T >
bool	isType (void)

	DECLARE_CONOBJECT (SimObject)

Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list. More...

void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted. More...

void	clearNotify (SimObject *obj)
	Notify an object when we are cleared. More...

void	clearAllNotifications ()
	Remove all notifications for this object. More...

void	processDeleteNotifies ()
	Send out deletion notifications. More...

void	registerReference (SimObject **obj)

void	unregisterReference (SimObject **obj)

const char *	getDataField (StringTableEntry slotName, const char *array)

void	setDataField (StringTableEntry slotName, const char array, const char value)

const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)

void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)

const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)

void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)

StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)

U32	getDataFieldType (StringTableEntry slotName, const char *array)

SimFieldDictionary *	getFieldDictionary ()

void	clearDynamicFields (void)
	Clear all dynamic fields. More...

void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true. More...

bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true. More...

void	setInternalName (const char *newname)

StringTableEntry	getInternalName ()
	Get the internal of of this control. More...

virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File. More...

virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace. More...

SimObjectId	getId (void) const

StringTableEntry	getIdString (void) const

U32	getType () const

const StringTableEntry	getName (void) const

void	setId (SimObjectId id)

void	assignName (const char *name)

SimGroup *	getGroup () const

bool	isChildOfGroup (SimGroup *pGroup)

bool	isProperlyAdded () const

bool	isDeleted () const

bool	isRemoved () const

bool	isLocked ()

void	setLocked (bool b)

bool	isHidden ()

void	setHidden (bool b)

void	setProgenitorFile (const char *pFile)

StringTableEntry	getProgenitorFile (void) const

void	setPeriodicTimerID (const S32 timerID)

S32	getPeriodicTimerID (void) const

bool	isPeriodicTimerActive (void) const

bool	isSelected () const

bool	isExpanded () const

void	setSelected (bool sel)

void	setExpanded (bool exp)

void	setModDynamicFields (bool dyn)

void	setModStaticFields (bool sta)

	SimObject (const U8 namespaceLinkMask=LinkSuperClassName\|LinkClassName)

virtual	~SimObject ()

virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup. More...

virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup. More...

virtual void	onNameChange (const char *name)
	Called when the object's name is changed. More...

virtual void	onStaticModified (const char slotName, const char newValue=NULL)

virtual void	inspectPreApply ()

virtual void	inspectPostApply ()

virtual void	onEditorEnable ()
	Called when the editor is activated. More...

virtual void	onEditorDisable ()
	Called when the editor is deactivated. More...

bool	registerObject ()

bool	registerObject (U32 id)

bool	registerObject (const char *name)

bool	registerObject (const char *name, U32 id)

void	unregisterObject ()

void	deleteObject ()

bool	addToSet (SimObjectId)

bool	addToSet (const char *)

bool	removeFromSet (SimObjectId)

bool	removeFromSet (const char *)

virtual void	writeFields (Stream &stream, U32 tabStop)

virtual bool	writeObject (Stream *stream)

virtual bool	readObject (Stream *stream)

virtual void	buildFilterList ()

void	addFieldFilter (const char *fieldName)

void	removeFieldFilter (const char *fieldName)

void	clearFieldFilters ()

bool	isFiltered (const char *fieldName)

void	assignFieldsFrom (SimObject *obj)

void	assignDynamicFieldsFrom (SimObject *obj)

Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name. More...

virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep. More...

bool	setField (const char fieldName, const char value)
	Set the value of a field. More...

virtual	~ConsoleObject ()

const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified. More...

AbstractClassRep::FieldList &	getModifiableFieldList ()

bool &	getDynamicGroupExpand ()

S32	getClassId (U32 netClassGroup) const

const char *	getClassName () const

Public Member Functions inherited from SceneRenderObject
	SceneRenderObject ()

virtual	~SceneRenderObject ()

Public Member Functions inherited from PhysicsProxy
	PhysicsProxy ()

virtual	~PhysicsProxy ()

Public Member Functions inherited from SpriteBatch
	SpriteBatch ()

virtual	~SpriteBatch ()

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)

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

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

StringTableEntry	getSpriteImage (void) const

void	setSpriteImageFrame (const U32 imageFrame)

U32	getSpriteImageFrame (void) const

void	setSpriteAnimation (const char *pAssetId)

StringTableEntry	getSpriteAnimation (void) const

void	clearSpriteAsset (void)

void	setSpriteVisible (const bool visible)

bool	getSpriteVisible (void) const

void	setSpriteLocalPosition (const Vector2 &localPosition)

Vector2	getSpriteLocalPosition (void)

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	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	initPersistFields ()

static BatchLayoutType	getBatchLayoutTypeEnum (const char *label)

static const char *	getBatchLayoutTypeDescription (const BatchLayoutType batchLayoutType)

Static Public Member Functions inherited from SceneObject
static void	initPersistFields ()

static void	resetBlendOptions (void)

static U32	getGlobalSceneObjectCount (void)

static b2BodyType	getBodyTypeEnum (const char *label)

static const char *	getBodyTypeDescription (const b2BodyType bodyType)

static b2Shape::Type	getCollisionShapeTypeEnum (const char *label)

static const char *	getCollisionShapeTypeDescription (const b2Shape::Type collisionShapeType)

static S32	getSrcBlendFactorEnum (const char *label)

static S32	getDstBlendFactorEnum (const char *label)

static const char *	getSrcBlendFactorDescription (const GLenum factor)

static const char *	getDstBlendFactorDescription (const GLenum factor)

Static Public Member Functions inherited from SpriteBatch
static void	WriteCustomTamlSchema (const AbstractClassRep pClassRep, TiXmlElement pParentElement)

Protected Types
typedef SceneObject	Parent

Protected Types inherited from SpriteBatch
typedef HashMap< U32, SpriteBatchItem * >	typeSpriteBatchHash

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

typedef HashMap < StringTableEntry, SpriteBatchItem * >	typeSpriteNameHash

Protected Member Functions
virtual SpriteBatchItem *	createSprite (const SpriteBatchItem::LogicalPosition &logicalPosition)

virtual SpriteBatchItem *	createSpriteRectilinearLayout (const SpriteBatchItem::LogicalPosition &logicalPosition)

virtual SpriteBatchItem *	createSpriteIsometricLayout (const SpriteBatchItem::LogicalPosition &logicalPosition)

virtual SpriteBatchItem *	createCustomLayout (const SpriteBatchItem::LogicalPosition &logicalPosition)

virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Taml callbacks. More...

virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read. More...

Protected Member Functions inherited from SceneObject
virtual void	OnRegisterScene (Scene *pScene)
	Scene (un)registering. More...

virtual void	OnUnregisterScene (Scene *pScene)

void	resetTickSpatials (const bool resize=false)
	Ticking. More...

bool	getSpatialDirty (void) const

void	initializeContactGathering (void)
	Contact processing. More...

S32	copyCircleCollisionShapeTo (SceneObject *pSceneObject, const b2FixtureDef &fixtureDef) const

S32	copyPolygonCollisionShapeTo (SceneObject *pSceneObject, const b2FixtureDef &fixtureDef) const

S32	copyChainCollisionShapeTo (SceneObject *pSceneObject, const b2FixtureDef &fixtureDef) const

S32	copyEdgeCollisionShapeTo (SceneObject *pSceneObject, const b2FixtureDef &fixtureDef) const

Protected Member Functions inherited from BehaviorComponent
virtual const char *	_callMethod (U32 argc, const char *argv[], bool callThis=true)

Protected Member Functions inherited from SpriteBatch
SpriteBatchItem *	createSprite (void)

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

SpriteBatchItem *	findSpriteId (const U32 batchId)

SpriteBatchItem *	findSpriteName (const char *pName)

void	setBatchTransform (const b2Transform &batchTransform)

void	updateLocalExtents (void)

void	createSpriteBatchQuery (void)

void	destroySpriteBatchQuery (void)

void	onTamlCustomWrite (TamlCustomNodes &customNodes)

void	onTamlCustomRead (const TamlCustomNodes &customNodes)

Static Protected Member Functions
static bool	writeDefaultSpriteStride (void *obj, StringTableEntry pFieldName)

static bool	writeDefaultSpriteSize (void *obj, StringTableEntry pFieldName)

static bool	setDefaultSpriteAngle (void obj, const char data)

static const char *	getDefaultSpriteAngle (void obj, const char data)

static bool	writeDefaultSpriteAngle (void *obj, StringTableEntry pFieldName)

static bool	writeBatchIsolated (void *obj, StringTableEntry pFieldName)

static bool	writeBatchSortMode (void *obj, StringTableEntry pFieldName)

static bool	setBatchLayout (void obj, const char data)

static bool	writeBatchLayout (void *obj, StringTableEntry pFieldName)

static bool	setBatchCulling (void obj, const char data)

static bool	writeBatchCulling (void *obj, StringTableEntry pFieldName)

Static Protected Member Functions inherited from SceneObject
static S32 QSORT_CALLBACK	sceneObjectLayerDepthSort (const void a, const void b)

static bool	setLifetime (void obj, const char data)
	Lifetime. More...

static bool	writeLifetime (void *obj, StringTableEntry pFieldName)

static bool	setSceneLayer (void obj, const char data)
	Scene layers. More...

static bool	writeSceneLayer (void *obj, StringTableEntry pFieldName)

static bool	setSceneLayerDepth (void obj, const char data)

static bool	writeSceneLayerDepth (void *obj, StringTableEntry pFieldName)

static bool	setSceneGroup (void obj, const char data)
	Scene groups. More...

static bool	writeSceneGroup (void *obj, StringTableEntry pFieldName)

static bool	setSize (void obj, const char data)
	Area. More...

static bool	writeSize (void *obj, StringTableEntry pFieldName)

static bool	setPosition (void obj, const char data)
	Position / Angle. More...

static const char *	getPosition (void obj, const char data)

static bool	writePosition (void *obj, StringTableEntry pFieldName)

static bool	setAngle (void obj, const char data)

static const char *	getAngle (void obj, const char data)

static bool	writeAngle (void *obj, StringTableEntry pFieldName)

static bool	setFixedAngle (void obj, const char data)

static const char *	getFixedAngle (void obj, const char data)

static bool	writeFixedAngle (void *obj, StringTableEntry pFieldName)

static bool	setBodyType (void obj, const char data)
	Body. More...

static const char *	getBodyType (void obj, const char data)

static bool	writeBodyType (void *obj, StringTableEntry pFieldName)

static bool	setActive (void obj, const char data)

static const char *	getActive (void obj, const char data)

static bool	writeActive (void *obj, StringTableEntry pFieldName)

static bool	setAwake (void obj, const char data)

static const char *	getAwake (void obj, const char data)

static bool	writeAwake (void *obj, StringTableEntry pFieldName)

static bool	setBullet (void obj, const char data)

static const char *	getBullet (void obj, const char data)

static bool	writeBullet (void *obj, StringTableEntry pFieldName)

static bool	setSleepingAllowed (void obj, const char data)

static const char *	getSleepingAllowed (void obj, const char data)

static bool	writeSleepingAllowed (void *obj, StringTableEntry pFieldName)

static bool	setDefaultDensity (void obj, const char data)
	Collision control. More...

static bool	writeDefaultDensity (void *obj, StringTableEntry pFieldName)

static bool	setDefaultFriction (void obj, const char data)

static bool	writeDefaultFriction (void *obj, StringTableEntry pFieldName)

static bool	setDefaultRestitution (void obj, const char data)

static bool	writeDefaultRestitution (void *obj, StringTableEntry pFieldName)

static bool	setCollisionGroups (void obj, const char data)

static bool	writeCollisionGroups (void *obj, StringTableEntry pFieldName)

static bool	setCollisionLayers (void obj, const char data)

static bool	writeCollisionLayers (void *obj, StringTableEntry pFieldName)

static bool	writeCollisionSuppress (void *obj, StringTableEntry pFieldName)

static bool	setGatherContacts (void obj, const char data)

static bool	writeGatherContacts (void *obj, StringTableEntry pFieldName)

static bool	setLinearVelocity (void obj, const char data)
	Velocities. More...

static const char *	getLinearVelocity (void obj, const char data)

static bool	writeLinearVelocity (void *obj, StringTableEntry pFieldName)

static bool	setAngularVelocity (void obj, const char data)

static const char *	getAngularVelocity (void obj, const char data)

static bool	writeAngularVelocity (void *obj, StringTableEntry pFieldName)

static bool	setLinearDamping (void obj, const char data)

static const char *	getLinearDamping (void obj, const char data)

static bool	writeLinearDamping (void *obj, StringTableEntry pFieldName)

static bool	setAngularDamping (void obj, const char data)

static const char *	getAngularDamping (void obj, const char data)

static bool	writeAngularDamping (void *obj, StringTableEntry pFieldName)

static bool	setGravityScale (void obj, const char data)
	Gravity scaling. More...

static const char *	getGravityScale (void obj, const char data)

static bool	writeGravityScale (void *obj, StringTableEntry pFieldName)

static bool	writeVisible (void *obj, StringTableEntry pFieldName)
	Render visibility. More...

static bool	writeBlendMode (void *obj, StringTableEntry pFieldName)
	Render blending. More...

static bool	writeSrcBlendFactor (void *obj, StringTableEntry pFieldName)

static bool	writeDstBlendFactor (void *obj, StringTableEntry pFieldName)

static bool	writeBlendColor (void *obj, StringTableEntry pFieldName)

static bool	writeAlphaTest (void *obj, StringTableEntry pFieldName)

static bool	writeSortPoint (void *obj, StringTableEntry pFieldName)
	Render sorting. More...

static bool	writeRenderGroup (void *obj, StringTableEntry pFieldName)

static bool	writeUseInputEvents (void *obj, StringTableEntry pFieldName)
	Input events. More...

static bool	writePickingAllowed (void *obj, StringTableEntry pFieldName)
	Picking. More...

static bool	writeUpdateCallback (void *obj, StringTableEntry pFieldName)
	Script callbacks. More...

static bool	writeCollisionCallback (void *obj, StringTableEntry pFieldName)

static bool	writeSleepingCallback (void *obj, StringTableEntry pFieldName)

static bool	setScene (void obj, const char data)
	Scene. More...

static bool	writeScene (void *obj, StringTableEntry pFieldName)

Additional Inherited Members
Public Attributes inherited from BehaviorComponent
typeInstanceConnectionHash	mBehaviorConnections

Static Public Attributes inherited from SpriteBatch
static const S32	INVALID_SPRITE_PROXY = -1

Protected Attributes inherited from SceneObject
SimObjectPtr< Scene >	mpScene
	Scene. More...

SimObjectPtr< Scene >	mpTargetScene

F32	mLifetime
	Lifetime. More...

bool	mLifetimeActive

U32	mSceneLayer
	Scene layers. More...

U32	mSceneLayerMask

F32	mSceneLayerDepth

U32	mSceneGroup
	Scene groups. More...

U32	mSceneGroupMask

Vector2	mSize
	Area. More...

bool	mAutoSizing

b2AABB	mPreTickAABB

b2AABB	mCurrentAABB

Vector2	mLocalSizeOOBB [4]

Vector2	mRenderOOBB [4]

S32	mWorldProxyId

Vector2	mPreTickPosition
	Position / Angle. More...

F32	mPreTickAngle

Vector2	mRenderPosition

F32	mRenderAngle

bool	mSpatialDirty

b2Body *	mpBody
	Body. More...

b2BodyDef	mBodyDefinition

U32	mWorldQueryKey

U32	mCollisionLayerMask
	Collision control. More...

U32	mCollisionGroupMask

bool	mCollisionSuppress

b2FixtureDef	mDefaultFixture

bool	mGatherContacts

Scene::typeContactVector *	mpCurrentContacts

typeCollisionFixtureDefVector	mCollisionFixtureDefs
	General collision shape access. More...

typeCollisionFixtureVector	mCollisionFixtures

bool	mVisible
	Render visibility. More...

bool	mBlendMode
	Render blending. More...

S32	mSrcBlendFactor

S32	mDstBlendFactor

ColorF	mBlendColor

F32	mAlphaTest

Vector2	mSortPoint
	Render sorting. More...

bool	mUseInputEvents
	Input events. More...

bool	mUpdateCallback
	Script callbacks. More...

bool	mCollisionCallback

bool	mSleepingCallback

bool	mLastAwakeState

U32	mDebugMask
	Debug mode. More...

SceneWindow *	mpAttachedCamera
	Camera mounting. More...

bool	mAttachedGuiSizeControl
	GUI attachment. More...

GuiControl *	mpAttachedGui

SceneWindow *	mpAttachedGuiSceneWindow

bool	mBeingSafeDeleted
	Safe deletion. More...

bool	mSafeDeleteReady

typeDestroyNotificationVector	mDestroyNotifyList
	Destroy notifications. More...

bool	mBatchIsolated
	Miscellaneous. More...

U32	mSerialiseKey

bool	mEditorTickAllowed

bool	mPickingAllowed

bool	mAlwaysInScope

U32	mMoveToEventId

U32	mRotateToEventId

U32	mSerialId

StringTableEntry	mRenderGroup

Protected Attributes inherited from SpriteBatch
typeSpriteBatchHash	mSprites

typeSpritePositionHash	mSpritePositions

typeSpriteNameHash	mSpriteNames

SpriteBatchItem *	mSelectedSprite

SceneRenderQueue::RenderSort	mBatchSortMode

bool	mBatchCulling

Vector2	mDefaultSpriteStride

Vector2	mDefaultSpriteSize

F32	mDefaultSpriteAngle

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Member Typedef Documentation

typedef SceneObject Parent

protected

Member Enumeration Documentation

enum BatchLayoutType

Enumerator
INVALID_LAYOUT
NO_LAYOUT
RECTILINEAR_LAYOUT
ISOMETRIC_LAYOUT
CUSTOM_LAYOUT

Constructor & Destructor Documentation

CompositeSprite ( )

~CompositeSprite ( )

virtual

Member Function Documentation

virtual bool canPrepareRender ( void ) const

inlinevirtual

Render Output.

Reimplemented from SceneObject.

void copyTo ( SimObject * object )

virtual

Reimplemented from SceneObject.

SpriteBatchItem * createCustomLayout ( const SpriteBatchItem::LogicalPosition & logicalPosition )

protectedvirtual

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

protectedvirtual

Reimplemented from SpriteBatch.

SpriteBatchItem * createSpriteIsometricLayout ( const SpriteBatchItem::LogicalPosition & logicalPosition )

protectedvirtual

SpriteBatchItem * createSpriteRectilinearLayout ( const SpriteBatchItem::LogicalPosition & logicalPosition )

protectedvirtual

DECLARE_CONOBJECT ( CompositeSprite )

Declare Console Object.

BatchLayoutType getBatchLayout ( void ) const

inline

const char * getBatchLayoutTypeDescription ( const BatchLayoutType batchLayoutType )

static

CompositeSprite::BatchLayoutType getBatchLayoutTypeEnum ( const char * label )

static

static const char* getDefaultSpriteAngle	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

void initPersistFields ( )

static

Defaults.

void integrateObject	(	const F32	totalTime,
		const F32	elapsedTime,
		DebugStats *	pDebugStats
	)

virtual

Reimplemented from SceneObject.

void interpolateObject ( const F32 timeDelta )

virtual

Reimplemented from SceneObject.

bool onAdd ( void )

virtual

Reimplemented from SpriteBatch.

void onRemove ( )

virtual

Reimplemented from SpriteBatch.

void onTamlCustomRead ( const TamlCustomNodes & customNodes )

protectedvirtual

Called during the reading of the object to allow custom properties to be read.

Reimplemented from SceneObject.

void onTamlCustomWrite ( TamlCustomNodes & customNodes )

protectedvirtual

Taml callbacks.

Reimplemented from SceneObject.

void preIntegrate	(	const F32	totalTime,
		const F32	elapsedTime,
		DebugStats *	pDebugStats
	)

virtual

Integration.

Reimplemented from SceneObject.

void scenePrepareRender	(	const SceneRenderState *	pSceneRenderState,
		SceneRenderQueue *	pSceneRenderQueue
	)

virtual

Reimplemented from SceneObject.

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

virtual

Reimplemented from SceneObject.

static bool setBatchCulling	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

void setBatchLayout ( const BatchLayoutType & batchLayoutType )

static bool setBatchLayout	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

static bool setDefaultSpriteAngle	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

virtual bool shouldRender ( void ) const

inlinevirtual

Reimplemented from SceneObject.

static bool writeBatchCulling	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeBatchIsolated	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeBatchLayout	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeBatchSortMode	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeDefaultSpriteAngle	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeDefaultSpriteSize	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeDefaultSpriteStride	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

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

2d/sceneobject/CompositeSprite.h
2d/sceneobject/CompositeSprite.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation