fsCRollOverButtonComponent Class Reference

#include <fsCRollOverButtonComponent.h>

Inheritance diagram for fsCRollOverButtonComponent:

Classes
struct	fsCRollOverAction
struct	sButtonEventMsgParam

Public Member Functions
void	actionSet (fsCRollOverAction *pRollOverAction)
fsCEntity *	buttonGuiEntityCreate (const fsStr &pEntityName, const fsCResourceName &pImageFileName, const fsCResourceName &pDownImageFileName)
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 ()
Public Member Functions inherited from fsITutorialEnabledComponent
void	tutorialCompleted (const fsPoint &pPos)

Static Public Attributes
static const fsCUniqueId	mTypeId

Protected Member Functions
void	tutorialCompletedDo (const fsPoint &pPos) override
void	updateDo (fsS32 pDeltaMs) override
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
void	defaultSpriteSet ()
virtual fsBool	acceptingInputGet () const
virtual void	onTap (const fsPoint &pTapPos)
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
	fsCRollOverButtonComponent (fsCEntity *pParent)
virtual	~fsCRollOverButtonComponent ()
Protected Member Functions inherited from fsIComponent
virtual void	resetDo ()
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)
Protected Member Functions inherited from fsIMessageListener
virtual void	inputStealDo ()
	fsIMessageListener (fsS32 pPriority)
virtual	~fsIMessageListener ()
Protected Member Functions inherited from fsITutorialEnabledComponent
	fsITutorialEnabledComponent ()
virtual	~fsITutorialEnabledComponent ()

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

Protected Attributes
std::shared_ptr< fsCBrush >	mBrush
std::shared_ptr< fsCBrush >	mOverBrush
fsCRollOverAction *	mActionId
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Friends
class	gfCLevelSequencerMapComponent
class	fsCComponentFactory
class	gfIAutoTestLevelUserInputComponent

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 }
Static Public Member Functions inherited from fsIMessageListener
static fsBool	lessThan (const fsIMessageListener *pLHS, const fsIMessageListener *pRHS)
Static Public Member Functions inherited from fsITutorialEnabledComponent
static fsStr	associatedEntityNameGet (fsCEntity *pEnt)

Constructor & Destructor Documentation

fsCRollOverButtonComponent()

fsCRollOverButtonComponent::fsCRollOverButtonComponent ( fsCEntity * pParent )

protected

~fsCRollOverButtonComponent()

fsCRollOverButtonComponent::~fsCRollOverButtonComponent ( )

protectedvirtual

Member Function Documentation

acceptingInputGet()

fsBool fsCRollOverButtonComponent::acceptingInputGet ( ) const

protectedvirtual

actionSet()

void fsCRollOverButtonComponent::actionSet

(

fsCRollOverAction *

pRollOverAction

)

buttonGuiEntityCreate()

fsCEntity * fsCRollOverButtonComponent::buttonGuiEntityCreate	(	const fsStr &	pEntityName,
		const fsCResourceName &	pImageFileName,
		const fsCResourceName &	pDownImageFileName )

create()

fsIComponent * fsCRollOverButtonComponent::create ( fsCEntity * pParent )

staticprotected

defaultSpriteSet()

void fsCRollOverButtonComponent::defaultSpriteSet ( )

protected

initialiseFromVariableTableDo()

void fsCRollOverButtonComponent::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

listenersDeregisterDo()

void fsCRollOverButtonComponent::listenersDeregisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

listenersRegisterDo()

void fsCRollOverButtonComponent::listenersRegisterDo ( )

overrideprotectedvirtual

Implements fsIMessageListener.

messageProcessDo()

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

overrideprotectedvirtual

Implements fsIMessageListener.

onTap()

void fsCRollOverButtonComponent::onTap ( const fsPoint & pTapPos )

protectedvirtual

tutorialCompletedDo()

void fsCRollOverButtonComponent::tutorialCompletedDo ( const fsPoint & pPos )

overrideprotectedvirtual

Implements fsITutorialEnabledComponent.

updateDo()

void fsCRollOverButtonComponent::updateDo ( fsS32 pDeltaMs )

overrideprotectedvirtual

Reimplemented from fsIComponent.

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

gfCLevelSequencerMapComponent

friend class gfCLevelSequencerMapComponent

friend

gfIAutoTestLevelUserInputComponent

friend class gfIAutoTestLevelUserInputComponent

friend

Member Data Documentation

mActionId

fsCRollOverAction* fsCRollOverButtonComponent::mActionId

protected

mBrush

std::shared_ptr<fsCBrush> fsCRollOverButtonComponent::mBrush

protected

mOverBrush

std::shared_ptr<fsCBrush> fsCRollOverButtonComponent::mOverBrush

protected

mTypeId

const fsCUniqueId fsCRollOverButtonComponent::mTypeId

static

---

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

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