fsITextSpriteComponent Class Reference

#include <fsITextSpriteComponent.h>

Inheritance diagram for fsITextSpriteComponent:

Public Types
enum	eHORIZONTAL_ALIGNMENT { eHALIGN_LEFT = 0 , eHALIGN_CENTRE , eHALIGN_RIGHT }
enum	eVERTICAL_ALIGNMENT { eVALIGN_TOP = 0 , eVALIGN_MIDDLE , eVALIGN_BOTTOM }

Public Member Functions
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 Member Functions
static fsPoint	fontSizeGet (const fsCVariableTable &pVars)

Protected Member Functions
virtual void	outlineSetDo (const fsSColour4B &pOutline, fsF32 pSize) const =0
virtual void	shadowSetDo (const fsSColour4B &pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const =0
virtual void	glowSetDo (const fsSColour4B &pGlow) const =0
virtual void	alignmentSetDo (eHORIZONTAL_ALIGNMENT pAlignH, eVERTICAL_ALIGNMENT pAlignV)=0
virtual void	initialiseDo (const fsStr &pText, fsIFont *pFont)=0
virtual fsS32	stringWidthInPixelsGetDo () const =0
virtual void	formattingRectSizeSetDo (const fsRect &pFormattingRect)=0
virtual void	colourSetDo (const fsSColour4B &pColour)=0
virtual fsStr	textGetDo () const =0
virtual void	textSetDo (const fsStr &pText)=0
	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	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)

Member Enumeration Documentation

eHORIZONTAL_ALIGNMENT

enum fsITextSpriteComponent::eHORIZONTAL_ALIGNMENT

Enumerator
eHALIGN_LEFT
eHALIGN_CENTRE
eHALIGN_RIGHT

eVERTICAL_ALIGNMENT

enum fsITextSpriteComponent::eVERTICAL_ALIGNMENT

Enumerator
eVALIGN_TOP
eVALIGN_MIDDLE
eVALIGN_BOTTOM

Constructor & Destructor Documentation

fsITextSpriteComponent()

fsITextSpriteComponent::fsITextSpriteComponent ( fsCEntity * pParent )

protected

~fsITextSpriteComponent()

fsITextSpriteComponent::~fsITextSpriteComponent ( )

protectedvirtual

Member Function Documentation

alignmentSet()

void fsITextSpriteComponent::alignmentSet	(	eHORIZONTAL_ALIGNMENT	pAlignH,
		eVERTICAL_ALIGNMENT	pAlignV )

alignmentSetDo()

virtual void fsITextSpriteComponent::alignmentSetDo ( eHORIZONTAL_ALIGNMENT pAlignH, eVERTICAL_ALIGNMENT pAlignV )

protectedpure virtual

Implemented in fsCTextSpriteComponent.

colourSet()

void fsITextSpriteComponent::colourSet

(

const fsSColour4B &

pColour

)

colourSetDo()

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

protectedpure virtual

Implemented in fsCTextSpriteComponent.

fontSizeGet()

fsPoint fsITextSpriteComponent::fontSizeGet ( const fsCVariableTable & pVars )

static

formattingRectSizeSet()

void fsITextSpriteComponent::formattingRectSizeSet

(

const fsRect &

pFormattingRect

)

formattingRectSizeSetDo()

virtual void fsITextSpriteComponent::formattingRectSizeSetDo ( const fsRect & pFormattingRect )

protectedpure virtual

Implemented in fsCTextSpriteComponent.

glowSet()

void fsITextSpriteComponent::glowSet

(

const fsSColour4B &

pGlow

)

const

glowSetDo()

virtual void fsITextSpriteComponent::glowSetDo ( const fsSColour4B & pGlow ) const

protectedpure virtual

Implemented in fsCTextSpriteComponent.

initialise()

void fsITextSpriteComponent::initialise	(	const fsStr &	pText,
		fsIFont *	pFont )

initialiseDo()

virtual void fsITextSpriteComponent::initialiseDo ( const fsStr & pText, fsIFont * pFont )

protectedpure virtual

Implemented in fsCTextSpriteComponent.

outlineSet()

void fsITextSpriteComponent::outlineSet	(	const fsSColour4B &	pOutline,
		fsF32	pSize ) const

outlineSetDo()

virtual void fsITextSpriteComponent::outlineSetDo ( const fsSColour4B & pOutline, fsF32 pSize ) const

protectedpure virtual

Implemented in fsCTextSpriteComponent.

shadowSet()

void fsITextSpriteComponent::shadowSet	(	const fsSColour4B &	pShadow,
		fsVec2d	pOffset,
		fsF32	pBlurRadius ) const

shadowSetDo()

virtual void fsITextSpriteComponent::shadowSetDo ( const fsSColour4B & pShadow, fsVec2d pOffset, fsF32 pBlurRadius ) const

protectedpure virtual

Implemented in fsCTextSpriteComponent.

stringWidthInPixelsGet()

fsS32 fsITextSpriteComponent::stringWidthInPixelsGet

(

)

const

stringWidthInPixelsGetDo()

virtual fsS32 fsITextSpriteComponent::stringWidthInPixelsGetDo ( ) const

protectedpure virtual

Implemented in fsCTextSpriteComponent.

textGet()

fsStr fsITextSpriteComponent::textGet

(

)

const

textGetDo()

virtual fsStr fsITextSpriteComponent::textGetDo ( ) const

protectedpure virtual

Implemented in fsCRevealingTextSpriteComponent, and fsCTextSpriteComponent.

textSet()

void fsITextSpriteComponent::textSet

(

const fsStr &

pText

)

textSetDo()

virtual void fsITextSpriteComponent::textSetDo ( const fsStr & pText )

protectedpure virtual

Implemented in fsCRevealingTextSpriteComponent, fsCTextEntryComponent, and fsCTextSpriteComponent.

---

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

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