gfCVisibilityStateComponent Class Reference

#include <gfCVisibilityStateComponent.h>

Inheritance diagram for gfCVisibilityStateComponent:

Public Member Functions
fsBool	initiallyVisibleGet () const
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
Public Member Functions inherited from fsIMessageListenerComponent
	fsIMessageListenerComponent (fsCEntity *pParent)
	fsIMessageListenerComponent (fsCEntity *pParent, fsS32 pPriority)
virtual	~fsIMessageListenerComponent ()
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
Public Member Functions inherited from fsIMessageListener
void	listenersRegister ()
void	listenersDeregister ()
void	prioritySet (fsS32 pPriority)
fsBool	messageProcess (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam)
void	inputSteal ()

Static Public Member Functions
static fsBool	statusChangerGet (const fsStr &pEntKey)
static void	maskKeyCheckProviderSet (fsBool(*pProvider)(const fsStr &pKeyName))
Static Public Member Functions inherited from fsIMessageListener
static fsBool	lessThan (const fsIMessageListener *pLHS, const fsIMessageListener *pRHS)

Static Public Attributes
static const fsCUniqueId	mLockBrokenMsg
static const fsCUniqueId	mMaskResetMsg
static const fsCUniqueId	mMaskActionMsg
static const fsCUniqueId	mTypeId

Protected Member Functions
	gfCVisibilityStateComponent (fsCEntity *pParent)
virtual	~gfCVisibilityStateComponent ()
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)
Protected Member Functions inherited from fsIMessageListener
virtual void	inputStealDo ()
	fsIMessageListener (fsS32 pPriority)
virtual	~fsIMessageListener ()

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

Friends
class	fsCComponentFactory

Additional Inherited Members
Public Types inherited from fsIMessageListener
enum	{   ePRIORITY_NORMAL = 0 , ePRIORITY_DEBUG_WINDOW , ePRIORITY_SOFTWARE_CURSOR , ePRIORITY_TEXT_ENTRY ,   ePRIORITY_DEBUG_MODAL , ePRIORITY_DEBUG_MODAL_BUTTON }
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Constructor & Destructor Documentation

gfCVisibilityStateComponent()

gfCVisibilityStateComponent::gfCVisibilityStateComponent ( fsCEntity * pParent )

protected

~gfCVisibilityStateComponent()

gfCVisibilityStateComponent::~gfCVisibilityStateComponent ( )

protectedvirtual

Member Function Documentation

create()

fsIComponent * gfCVisibilityStateComponent::create ( fsCEntity * pParent )

staticprotected

initiallyVisibleGet()

fsBool gfCVisibilityStateComponent::initiallyVisibleGet

(

)

const

listenersDeregisterDo()

void gfCVisibilityStateComponent::listenersDeregisterDo ( )

overridevirtual

Implements fsIMessageListener.

listenersRegisterDo()

void gfCVisibilityStateComponent::listenersRegisterDo ( )

overridevirtual

Implements fsIMessageListener.

maskKeyCheckProviderSet()

void gfCVisibilityStateComponent::maskKeyCheckProviderSet ( fsBool(* pProvider )(const fsStr &pKeyName) )

static

messageProcessDo()

fsBool gfCVisibilityStateComponent::messageProcessDo ( const fsCUniqueId & pMessageType, const fsIMessageDispatcher::sMessageParameters & pParam )

overridevirtual

Implements fsIMessageListener.

statusChangerGet()

fsBool gfCVisibilityStateComponent::statusChangerGet ( const fsStr & pEntKey )

static

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mLockBrokenMsg

const fsCUniqueId gfCVisibilityStateComponent::mLockBrokenMsg

static

mMaskActionMsg

const fsCUniqueId gfCVisibilityStateComponent::mMaskActionMsg

static

mMaskResetMsg

const fsCUniqueId gfCVisibilityStateComponent::mMaskResetMsg

static

mTypeId

const fsCUniqueId gfCVisibilityStateComponent::mTypeId

static

---

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

• /home/runner/work/fission/fission/gameModules/gfComponents/components/gfCVisibilityStateComponent.h
• /home/runner/work/fission/fission/gameModules/gfComponents/components/gfCVisibilityStateComponent.cpp