Fission FSN
Loading...
Searching...
No Matches
fsITextSpriteComponent.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: fsITextSpriteComponent.h
4*
5* Purpose: Interface for text sprite components
6*
7*********************************************************************/
8
9#ifndef fsITextSpriteComponenthdr
10#define fsITextSpriteComponenthdr
11
12#include <fsCore/fsStr.h>
13
15
16struct fsSColour4B;
17class fsRect;
18class fsIFont;
19
20
22{
23public:
24
31
38
39 static fsPoint fontSizeGet(const fsCVariableTable& pVars);
40
41 void outlineSet(const fsSColour4B& pOutline, fsF32 pSize) const;
42 void shadowSet(const fsSColour4B& pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const;
43 void glowSet(const fsSColour4B& pGlow) const;
44
46
47 void initialise(const fsStr& pText, fsIFont* pFont);
48
50
51 void formattingRectSizeSet(const fsRect& pFormattingRect);
52 void wordWrapSet(fsBool pEnabled);
53 void colourSet(const fsSColour4B& pColour);
54
55 void textSet(const fsStr& pText);
56 fsStr textGet() const;
57
58protected:
59
60 virtual void outlineSetDo(const fsSColour4B& pOutline, fsF32 pSize) const = 0;
61 virtual void shadowSetDo(const fsSColour4B& pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const = 0;
62 virtual void glowSetDo(const fsSColour4B& pGlow) const = 0;
63
64 virtual void alignmentSetDo(eHORIZONTAL_ALIGNMENT pAlignH, eVERTICAL_ALIGNMENT pAlignV) = 0;
65 virtual void initialiseDo(const fsStr& pText, fsIFont* pFont) = 0;
66
67 virtual fsS32 stringWidthInPixelsGetDo() const = 0;
68
69 virtual void formattingRectSizeSetDo(const fsRect& pFormattingRect) = 0;
70 virtual void wordWrapSetDo(fsBool pEnabled) = 0;
71 virtual void colourSetDo(const fsSColour4B& pColour) = 0;
72 virtual fsStr textGetDo() const = 0;
73 virtual void textSetDo(const fsStr& pText) = 0;
74
76 ~fsITextSpriteComponent() override;
77
78private:
79};
80
81#endif
Definition fsCEntity.h:39
Definition fsCVariableTable.h:27
void initialise()
Definition fsIComponent.cpp:51
Definition fsIFont.h:34
fsIRenderableComponent(fsCEntity *pParent)
Definition fsIRenderableComponent.cpp:4
~fsITextSpriteComponent() override
Definition fsITextSpriteComponent.cpp:77
fsStr textGet() const
Definition fsITextSpriteComponent.cpp:62
virtual void glowSetDo(const fsSColour4B &pGlow) const =0
virtual void initialiseDo(const fsStr &pText, fsIFont *pFont)=0
void textSet(const fsStr &pText)
Definition fsITextSpriteComponent.cpp:67
void glowSet(const fsSColour4B &pGlow) const
Definition fsITextSpriteComponent.cpp:11
virtual void formattingRectSizeSetDo(const fsRect &pFormattingRect)=0
void alignmentSet(eHORIZONTAL_ALIGNMENT pAlignH, eVERTICAL_ALIGNMENT pAlignV)
Definition fsITextSpriteComponent.cpp:32
virtual void wordWrapSetDo(fsBool pEnabled)=0
virtual void colourSetDo(const fsSColour4B &pColour)=0
virtual void alignmentSetDo(eHORIZONTAL_ALIGNMENT pAlignH, eVERTICAL_ALIGNMENT pAlignV)=0
static fsPoint fontSizeGet(const fsCVariableTable &pVars)
Definition fsITextSpriteComponent.cpp:21
void colourSet(const fsSColour4B &pColour)
Definition fsITextSpriteComponent.cpp:57
void wordWrapSet(fsBool pEnabled)
Definition fsITextSpriteComponent.cpp:52
fsS32 stringWidthInPixelsGet() const
Definition fsITextSpriteComponent.cpp:42
virtual fsStr textGetDo() const =0
virtual void textSetDo(const fsStr &pText)=0
void shadowSet(const fsSColour4B &pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const
Definition fsITextSpriteComponent.cpp:16
eVERTICAL_ALIGNMENT
Definition fsITextSpriteComponent.h:33
@ eVALIGN_BOTTOM
Definition fsITextSpriteComponent.h:36
@ eVALIGN_MIDDLE
Definition fsITextSpriteComponent.h:35
@ eVALIGN_TOP
Definition fsITextSpriteComponent.h:34
virtual fsS32 stringWidthInPixelsGetDo() const =0
void outlineSet(const fsSColour4B &pOutline, fsF32 pSize) const
Definition fsITextSpriteComponent.cpp:6
void formattingRectSizeSet(const fsRect &pFormattingRect)
Definition fsITextSpriteComponent.cpp:47
virtual void outlineSetDo(const fsSColour4B &pOutline, fsF32 pSize) const =0
virtual void shadowSetDo(const fsSColour4B &pShadow, fsVec2d pOffset, fsF32 pBlurRadius) const =0
eHORIZONTAL_ALIGNMENT
Definition fsITextSpriteComponent.h:26
@ eHALIGN_RIGHT
Definition fsITextSpriteComponent.h:29
@ eHALIGN_LEFT
Definition fsITextSpriteComponent.h:27
@ eHALIGN_CENTRE
Definition fsITextSpriteComponent.h:28
fsITextSpriteComponent(fsCEntity *pParent)
Definition fsITextSpriteComponent.cpp:72
Definition fsRect.h:16
Definition fsStr.h:23
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
float fsF32
Definition fsBaseTypes.h:28
Definition fsPoint.h:17
Definition fsSColour.h:54
Definition fsVec2d.h:16