fsCRevealingTextSpriteComponent Class Reference

#include <fsCRevealingTextSpriteComponent.h>

Inheritance diagram for fsCRevealingTextSpriteComponent:

Public Member Functions
void	shortCircuit ()
void	updateDo (fsS32 pDeltaMs) override
void	trigger ()
fsBool	triggeredGet () const
fsBool	finishedGet () const
Public Member Functions inherited from fsITextSpriteComponent
void	outlineSet (const fsSColour4B &pOutline, fsF32 pSize) const
void	shadowSet (const fsSColour4B &pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const
void	glowSet (const fsSColour4B &pGlow) const
void	alignmentSet (eHORIZONTAL_ALIGNMENT pAlignH, eVERTICAL_ALIGNMENT pAlignV)
void	initialise (const fsStr &pText, fsIFont *pFont)
fsS32	stringWidthInPixelsGet () const
void	formattingRectSizeSet (const fsRect &pFormattingRect)
void	colourSet (const fsSColour4B &pColour)
void	textSet (const fsStr &pText)
fsStr	textGet () const
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
Static Public Attributes inherited from fsCTextSpriteComponent
static const fsCUniqueId	mTypeId

Protected Member Functions
fsStr	textGetDo () const override
void	textSetDo (const fsStr &pText) override
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
	fsCRevealingTextSpriteComponent (fsCEntity *pParent)
virtual	~fsCRevealingTextSpriteComponent ()
Protected Member Functions inherited from fsCTextSpriteComponent
void	outlineSetDo (const fsSColour4B &pOutline, fsF32 pSize) const override
void	shadowSetDo (const fsSColour4B &pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const override
void	glowSetDo (const fsSColour4B &pGlow) const override
void	alignmentSetDo (eHORIZONTAL_ALIGNMENT pAlignH, eVERTICAL_ALIGNMENT pAlignV) override
void	initialiseDo (const fsStr &pText, fsIFont *pFont) override
fsS32	stringWidthInPixelsGetDo () const override
void	formattingRectSizeSetDo (const fsRect &pFormattingRect) override
void	colourSetDo (const fsSColour4B &pColour) override
fsStr	textGetDo () const override
void	textSetDo (const fsStr &pText) override
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
void	renderDo () override
void	matrixApplyDo () override
	fsCTextSpriteComponent (fsCEntity *pParent)
virtual	~fsCTextSpriteComponent ()
Protected Member Functions inherited from fsITextSpriteComponent
	fsITextSpriteComponent (fsCEntity *pParent)
virtual	~fsITextSpriteComponent ()
Protected Member Functions inherited from fsIRenderableComponent
	fsIRenderableComponent (fsCEntity *pParent)
virtual	~fsIRenderableComponent ()
Protected Member Functions inherited from fsIComponent
virtual void	resetDo ()
virtual void	postLoadDo ()
virtual void	deserialiseDo ()
virtual void	serialiseDo ()
virtual void	initialiseDo ()
virtual void	finaliseDo ()
virtual	~fsIComponent ()
	fsIComponent (fsCEntity *pParent)

Static Protected Member Functions
static fsIComponent *	create (fsCEntity *pParent)
Static Protected Member Functions inherited from fsCTextSpriteComponent
static fsIComponent *	create (fsCEntity *pParent)

Friends
class	fsCComponentFactory

Additional Inherited Members
Public Types inherited from fsITextSpriteComponent
enum	eHORIZONTAL_ALIGNMENT { eHALIGN_LEFT = 0 , eHALIGN_CENTRE , eHALIGN_RIGHT }
enum	eVERTICAL_ALIGNMENT { eVALIGN_TOP = 0 , eVALIGN_MIDDLE , eVALIGN_BOTTOM }
Static Public Member Functions inherited from fsITextSpriteComponent
static fsPoint	fontSizeGet (const fsCVariableTable &pVars)
Protected Attributes inherited from fsCTextSpriteComponent
fsCTextSprite *	mTextSprite
fsS32	mHAlign

Constructor & Destructor Documentation

fsCRevealingTextSpriteComponent()

fsCRevealingTextSpriteComponent::fsCRevealingTextSpriteComponent ( fsCEntity * pParent )

protected

~fsCRevealingTextSpriteComponent()

fsCRevealingTextSpriteComponent::~fsCRevealingTextSpriteComponent ( )

protectedvirtual

Member Function Documentation

create()

fsIComponent * fsCRevealingTextSpriteComponent::create ( fsCEntity * pParent )

staticprotected

finishedGet()

fsBool fsCRevealingTextSpriteComponent::finishedGet

(

)

const

initialiseFromVariableTableDo()

void fsCRevealingTextSpriteComponent::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

shortCircuit()

void fsCRevealingTextSpriteComponent::shortCircuit

(

)

textGetDo()

fsStr fsCRevealingTextSpriteComponent::textGetDo ( ) const

overrideprotectedvirtual

Implements fsITextSpriteComponent.

textSetDo()

void fsCRevealingTextSpriteComponent::textSetDo ( const fsStr & pText )

overrideprotectedvirtual

Implements fsITextSpriteComponent.

trigger()

void fsCRevealingTextSpriteComponent::trigger

(

)

triggeredGet()

fsBool fsCRevealingTextSpriteComponent::triggeredGet

(

)

const

updateDo()

void fsCRevealingTextSpriteComponent::updateDo ( fsS32 pDeltaMs )

overridevirtual

Reimplemented from fsIComponent.

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mTypeId

const fsCUniqueId fsCRevealingTextSpriteComponent::mTypeId

static

---

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

• /home/runner/work/fission/fission/libs/fsAppCore/src/components/fsCRevealingTextSpriteComponent.h
• /home/runner/work/fission/fission/libs/fsAppCore/src/components/fsCRevealingTextSpriteComponent.cpp