fsISpriteComponent Class Reference

#include <fsISpriteComponent.h>

Inheritance diagram for fsISpriteComponent:

Public Member Functions
fsBool	obscuredByBoundingBoxCheck (fsISpriteComponent *pOtherSprComp)
void	alphaBlendSet (fsS32 pBlend)
fsBool	hitTest (fsISpriteComponent *pOtherSprComp, fsBool pRequireHitMap) const
fsBool	hitTest (const fsPoint &pScreenPos, fsBool pRequireHitMap) const
fsS32	widthGet () const
fsS32	heightGet () const
void	colourSet (const fsSColour4B &pColour)
void	widthSet (fsS32 pWidth, fsBool pModifyRenderData=true)
void	heightSet (fsS32 pHeight, fsBool pModifyRenderData=true)
std::shared_ptr< fsCBrush >	brushGet () const
void	brushSet (std::shared_ptr< fsCBrush > pBrush)
Public Member Functions inherited from fsIComponent
template<typename TInterface>
std::vector< fsCEntity * >	appSceneEntitiesWithComponentOfFamilyType () const
template<typename TInterface>
fsCEntity *	appSceneFirstEntityWithComponentOfFamilyType () const
fsCEntity *	appSceneEntityNamed (const fsStr &pName) const
void	reset ()
void	update (fsS32 pDeltaMs)
void	render ()
void	matrixApply ()
void	postLoad ()
void	deserialise ()
void	serialise ()
void	initialiseFromVariableTable (const fsCVariableTable &pVars)
void	initialise ()
void	finalise ()
fsCEntity *	parentGet () const
fsCEntity *	grandparentGet () const

Static Public Attributes
static const fsCUniqueId	mTypeId

Protected Member Functions
virtual fsBool	obscuredByBoundingBoxCheckDo (fsISpriteComponent *pOtherSprComp)
virtual void	alphaBlendSetDo (fsS32 pBlend)
virtual fsBool	hitTestDo (fsISpriteComponent *pOtherSprComp, fsBool pRequireHitMap) const
virtual fsBool	hitTestDo (const fsPoint &pScreenPos, fsBool pRequireHitMap) const
virtual fsS32	widthGetDo () const =0
virtual fsS32	heightGetDo () const =0
virtual void	colourSetDo (const fsSColour4B &pColour)
virtual void	widthSetDo (fsS32 pWidth, fsBool pModifyRenderData=true)=0
virtual void	heightSetDo (fsS32 pHeight, fsBool pModifyRenderData=true)=0
virtual std::shared_ptr< fsCBrush >	brushGetDo () const
virtual void	brushSetDo (std::shared_ptr< fsCBrush > pBrush)
	fsISpriteComponent (fsCEntity *pParent)
virtual	~fsISpriteComponent ()
Protected Member Functions inherited from fsIRenderableComponent
	fsIRenderableComponent (fsCEntity *pParent)
virtual	~fsIRenderableComponent ()
Protected Member Functions inherited from fsIComponent
virtual void	resetDo ()
virtual void	updateDo (fsS32 pDeltaMs)
virtual void	renderDo ()
virtual void	matrixApplyDo ()
virtual void	postLoadDo ()
virtual void	deserialiseDo ()
virtual void	serialiseDo ()
virtual void	initialiseFromVariableTableDo (const fsCVariableTable &pVars)
virtual void	initialiseDo ()
virtual void	finaliseDo ()
virtual	~fsIComponent ()
	fsIComponent (fsCEntity *pParent)

Friends
class	fsCComponentFactory

Constructor & Destructor Documentation

fsISpriteComponent()

fsISpriteComponent::fsISpriteComponent ( fsCEntity * pParent )

protected

~fsISpriteComponent()

fsISpriteComponent::~fsISpriteComponent ( )

protectedvirtual

Member Function Documentation

alphaBlendSet()

void fsISpriteComponent::alphaBlendSet

(

fsS32

pBlend

)

alphaBlendSetDo()

virtual void fsISpriteComponent::alphaBlendSetDo ( fsS32 pBlend )

inlineprotectedvirtual

Reimplemented in fsCSpriteComponent.

brushGet()

std::shared_ptr< fsCBrush > fsISpriteComponent::brushGet

(

)

const

brushGetDo()

virtual std::shared_ptr< fsCBrush > fsISpriteComponent::brushGetDo ( ) const

inlineprotectedvirtual

Reimplemented in fsCSpriteComponent.

brushSet()

void fsISpriteComponent::brushSet

(

std::shared_ptr< fsCBrush >

pBrush

)

brushSetDo()

virtual void fsISpriteComponent::brushSetDo ( std::shared_ptr< fsCBrush > pBrush )

inlineprotectedvirtual

Reimplemented in fsCSpriteComponent.

colourSet()

void fsISpriteComponent::colourSet

(

const fsSColour4B &

pColour

)

colourSetDo()

virtual void fsISpriteComponent::colourSetDo ( const fsSColour4B & pColour )

inlineprotectedvirtual

Reimplemented in fsCSpriteComponent.

heightGet()

fsS32 fsISpriteComponent::heightGet

(

)

const

heightGetDo()

virtual fsS32 fsISpriteComponent::heightGetDo ( ) const

protectedpure virtual

Implemented in fsCMovieSpriteComponent, and fsCSpriteComponent.

heightSet()

void fsISpriteComponent::heightSet	(	fsS32	pHeight,
		fsBool	pModifyRenderData = true )

heightSetDo()

virtual void fsISpriteComponent::heightSetDo ( fsS32 pHeight, fsBool pModifyRenderData = true )

protectedpure virtual

Implemented in fsCMovieSpriteComponent, and fsCSpriteComponent.

hitTest() [1/2]

fsBool fsISpriteComponent::hitTest	(	const fsPoint &	pScreenPos,
		fsBool	pRequireHitMap ) const

hitTest() [2/2]

fsBool fsISpriteComponent::hitTest	(	fsISpriteComponent *	pOtherSprComp,
		fsBool	pRequireHitMap ) const

hitTestDo() [1/2]

virtual fsBool fsISpriteComponent::hitTestDo ( const fsPoint & pScreenPos, fsBool pRequireHitMap ) const

inlineprotectedvirtual

Reimplemented in fsCSpriteComponent.

hitTestDo() [2/2]

virtual fsBool fsISpriteComponent::hitTestDo ( fsISpriteComponent * pOtherSprComp, fsBool pRequireHitMap ) const

inlineprotectedvirtual

Reimplemented in fsCSpriteComponent.

obscuredByBoundingBoxCheck()

fsBool fsISpriteComponent::obscuredByBoundingBoxCheck

(

fsISpriteComponent *

pOtherSprComp

)

obscuredByBoundingBoxCheckDo()

virtual fsBool fsISpriteComponent::obscuredByBoundingBoxCheckDo ( fsISpriteComponent * pOtherSprComp )

inlineprotectedvirtual

Reimplemented in fsCSpriteComponent.

widthGet()

fsS32 fsISpriteComponent::widthGet

(

)

const

widthGetDo()

virtual fsS32 fsISpriteComponent::widthGetDo ( ) const

protectedpure virtual

Implemented in fsCMovieSpriteComponent, and fsCSpriteComponent.

widthSet()

void fsISpriteComponent::widthSet	(	fsS32	pWidth,
		fsBool	pModifyRenderData = true )

widthSetDo()

virtual void fsISpriteComponent::widthSetDo ( fsS32 pWidth, fsBool pModifyRenderData = true )

protectedpure virtual

Implemented in fsCMovieSpriteComponent, and fsCSpriteComponent.

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mTypeId

const fsCUniqueId fsISpriteComponent::mTypeId

static

---

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

• /home/runner/work/fission/fission/libs/fsRenderer/src/components/fsISpriteComponent.h
• /home/runner/work/fission/fission/libs/fsRenderer/src/components/fsISpriteComponent.cpp