Fission FSN
Loading...
Searching...
No Matches
fsCScreenFadeComponent.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: fsCScreenFadeComponent.h
4*
5* Purpose: A component which renders an untextured sprite to the
6* whole of the display.
7*
8*********************************************************************/
9
10#ifndef fsCScreenFadeComponenthdr
11#define fsCScreenFadeComponenthdr
12
14#include <fsCore/fsStr.h>
16
17class fsSColour;
18class fsCSprite;
19
21{
22 friend class fsCComponentFactory;
23
24public:
25
26 void spriteInitialise();
27
28 void colourSet(const fsSColour& pColour);
29
30 // Optional tapButton: the name of a button in this gui that a tap on the fade (outside the
31 // gui's own sprites) presses, usually its Close or Back. Empty when the fade isn't tappable.
32 const fsStr& tapButtonGet() const { return mTapButton; }
33
34 static const fsCUniqueId mTypeId;
35
36protected:
37
38 static fsIComponent* create(fsCEntity* pParent);
39
40 void initialiseFromVariableTableDo(const fsCVariableTable& pVars) override;
41 void renderDo() override;
42 void matrixApplyDo() override;
43
46
47
48private:
49
50 std::unique_ptr<fsCSprite> mSprite;
51 fsStr mTapButton;
52};
53
54#endif
Definition fsCEntity.h:39
static fsIComponent * create(fsCEntity *pParent)
Definition fsCScreenFadeComponent.cpp:42
const fsStr & tapButtonGet() const
Definition fsCScreenFadeComponent.h:32
friend class fsCComponentFactory
Definition fsCScreenFadeComponent.h:22
void renderDo() override
Definition fsCScreenFadeComponent.cpp:47
void spriteInitialise()
Definition fsCScreenFadeComponent.cpp:13
void initialiseFromVariableTableDo(const fsCVariableTable &pVars) override
Definition fsCScreenFadeComponent.cpp:24
virtual ~fsCScreenFadeComponent()
Definition fsCScreenFadeComponent.cpp:63
void matrixApplyDo() override
Definition fsCScreenFadeComponent.cpp:52
void colourSet(const fsSColour &pColour)
Definition fsCScreenFadeComponent.cpp:19
static const fsCUniqueId mTypeId
Definition fsCScreenFadeComponent.h:34
fsCScreenFadeComponent(fsCEntity *pParent)
Definition fsCScreenFadeComponent.cpp:57
Definition fsCSprite.h:24
Definition fsCUniqueId.h:21
Definition fsCVariableTable.h:27
fsIComponent(fsCEntity *pParent)
Definition fsIComponent.cpp:86
fsIRenderableComponent(fsCEntity *pParent)
Definition fsIRenderableComponent.cpp:4
Definition fsSColour.h:20
Definition fsStr.h:23