fsIGuiComponent Class Reference

#include <fsIGuiComponent.h>

Inheritance diagram for fsIGuiComponent:

Public Member Functions
template<typename TComponent>
TComponent *	siblingEntityComponentGet () const
template<typename TComponent>
TComponent *	siblingEntityFamilyComponentGet () const
void	listenerComponentsRegister (fsCEntity *const pRoot) const
void	listenerComponentsDeRegister (fsCEntity *const pRoot) const
virtual fsBool	onButtonClicked (fsCButtonComponent *pButtonComp)
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 void	flush ()
static fsCEntity *	guiCreateFromCommands (fsStr &pCommands, fsCEntity *pParent=nullptr, fsBool pModal=true, fsBool pNewGrammarMode=false)
static fsCEntity *	guiCreateFromFile (const fsCResourceName &pGuiLayoutFileName, fsCEntity *pParent=nullptr, fsBool pModal=true)
static fsCGuiParseTree	parseToTree (fsStr &pCommands, fsBool pNewGrammarMode=false)
static fsCEntity *	constructFromTree (const fsCGuiParseTree &pTree, fsCEntity *pParent=nullptr, fsBool pModal=true)
static fsBool	newGrammarFileNameResolve (const fsStr &pLegacyFileName, fsStr &pOutResolvedFileName)
static fsIGuiComponent *	guiParentGetFromComponent (const fsIComponent *pComponent)
static fsBool	entityHasGuiComponentGet (const fsINode *pNode)

Protected Member Functions
void	layoutFileProcess ()
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
	fsIGuiComponent (fsCEntity *pParent)
virtual	~fsIGuiComponent ()
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	initialiseDo ()
virtual void	finaliseDo ()
virtual	~fsIComponent ()
	fsIComponent (fsCEntity *pParent)

Constructor & Destructor Documentation

fsIGuiComponent()

fsIGuiComponent::fsIGuiComponent ( fsCEntity * pParent )

protected

~fsIGuiComponent()

fsIGuiComponent::~fsIGuiComponent ( )

protectedvirtual

Member Function Documentation

constructFromTree()

fsCEntity * fsIGuiComponent::constructFromTree ( const fsCGuiParseTree & pTree, fsCEntity * pParent = nullptr, fsBool pModal = true )

static

entityHasGuiComponentGet()

fsBool fsIGuiComponent::entityHasGuiComponentGet ( const fsINode * pNode )

static

flush()

void fsIGuiComponent::flush ( )

static

guiCreateFromCommands()

fsCEntity * fsIGuiComponent::guiCreateFromCommands ( fsStr & pCommands, fsCEntity * pParent = nullptr, fsBool pModal = true, fsBool pNewGrammarMode = false )

static

guiCreateFromFile()

fsCEntity * fsIGuiComponent::guiCreateFromFile ( const fsCResourceName & pGuiLayoutFileName, fsCEntity * pParent = nullptr, fsBool pModal = true )

static

guiParentGetFromComponent()

fsIGuiComponent * fsIGuiComponent::guiParentGetFromComponent ( const fsIComponent * pComponent )

static

initialiseFromVariableTableDo()

void fsIGuiComponent::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

Reimplemented in gfCAchievementsScreen, gfCBonusCollectionScreen, gfCChapterMenuGui, gfCChoosePlayerGui, gfCConversationGui, gfCCreditsGui, gfCCrossOutPickListEntryGui, gfCDebugWindowGui, gfCDiaryGui, gfCDropOffPickListEntryGui, gfCInGameShopGui, gfCLevelSequencerMapComponent, gfCLevelSequencerMinigameComponent, gfCLocaleSelectGui, gfCMiniGameGui, gfCMoreGamesGui, gfCNewPlayerGui, gfCOptionsGui, gfCParkCatalogueGui, gfCParkEndOfDayGui, gfCParkHudGui, gfCPickListGui, gfCPlayerSlotGui, gfCRoundScoreGui, gfCSingleItemPickListEntryGui, gfCTuneGui, gfCWallpaperGui, gfCWordSearchImageGroupPickListEntryGui, gfCWordSearchTiledPickListEntryGui, gfICatalogueGui, and gfIRoundScoreGui.

layoutFileProcess()

void fsIGuiComponent::layoutFileProcess ( )

protected

listenerComponentsDeRegister()

void fsIGuiComponent::listenerComponentsDeRegister

(

fsCEntity *const

pRoot

)

const

listenerComponentsRegister()

void fsIGuiComponent::listenerComponentsRegister

(

fsCEntity *const

pRoot

)

const

newGrammarFileNameResolve()

fsBool fsIGuiComponent::newGrammarFileNameResolve ( const fsStr & pLegacyFileName, fsStr & pOutResolvedFileName )

static

onButtonClicked()

fsBool fsIGuiComponent::onButtonClicked ( fsCButtonComponent * pButtonComp )

virtual

Reimplemented in fsCConfirmBoxGui, fsCEmptyGui, fsCEndMenuGui, fsCGameGui, fsCInGameCheatMenu, fsCInventoryGui, fsCLocaleGui, fsCMainMenuGui, fsCMapGui, fsCMapPopUpFVGui, fsCMapPopUpGui, fsCPauseMenuGui, gfCAchievementsScreen, gfCBonusCollectionScreen, gfCChapterMenuGui, gfCChoosePlayerGui, gfCConversationGui, gfCDebugMenuGui, gfCDiaryGui, gfCInGameShopGui, gfCJigsawMinigameGui, gfCLevelSequencerMinigameComponent, gfCLocaleSelectGui, gfCNewPlayerGui, gfCOptionsGui, gfCParkCatalogueGui, gfCParkEndOfDayGui, gfCParkHudGui, gfCParkMainMenuGui, gfCPlayerSlotGui, gfCRoundScoreGui, gfCTaskNoteGuiComponent, and gfICatalogueGui.

parseToTree()

fsCGuiParseTree fsIGuiComponent::parseToTree ( fsStr & pCommands, fsBool pNewGrammarMode = false )

static

siblingEntityComponentGet()

template<typename TComponent>

TComponent * fsIGuiComponent::siblingEntityComponentGet

(

)

const

siblingEntityFamilyComponentGet()

template<typename TComponent>

TComponent * fsIGuiComponent::siblingEntityFamilyComponentGet

(

)

const

---

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

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