gfCNavigateComponent Class Reference

#include <gfCNavigateComponent.h>

Inheritance diagram for gfCNavigateComponent:

Classes
struct	sfsCNavigateComponentMsgParam

Public Member Functions
void	activeSet (fsBool pActive)
fsBool	activeGet () const
Public Member Functions inherited from fsIGestureHandlingComponent
fsBool	hitTest (const fsPoint &pPos) const
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 fsStr	mEntityPrefix
static const fsCUniqueId	mTypeId
static const fsCUniqueId	mNavigateComponentTapMsg

Protected Member Functions
void	tutorialCompletedDo (const fsPoint &pPos) override
fsBool	acceptingInputGet () const override
void	onTap (const fsPoint &pTapPos) override
fsBool	highlightSetDo () override
	gfCNavigateComponent (fsCEntity *pParent)
virtual	~gfCNavigateComponent ()
Protected Member Functions inherited from fsIGestureHandlingComponent
virtual void	stolenInputDo ()
void	gestureTypesSet (fsBool pHandleTaps, fsBool pHandleDragEvent, fsBool pHandlePinchEvents)
fsBool	messageProcessDo (const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
void	listenersRegisterDo () override
void	listenersDeregisterDo () override
void	gestureReset ()
	fsIGestureHandlingComponent (fsCEntity *pParent, fsBool pHandleTaps, fsBool pHandleDragEvent, fsBool pHandlePinchEvents)
virtual	~fsIGestureHandlingComponent ()
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 ()
Protected Member Functions inherited from fsITutorialEnabledComponent
	fsITutorialEnabledComponent ()
virtual	~fsITutorialEnabledComponent ()

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 }
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)
Protected Types inherited from fsIGestureHandlingComponent
enum	{   eSTATE_NOT_IN_GESTURE = 0 , eSTATE_MOUSE_OVER , eSTATE_EVALUATING_GESTURE_TYPE , eSTATE_IN_TAP_GESTURE ,   eSTATE_IN_DRAG_GESTURE , eSTATE_IN_PINCH_GESTURE , eSTATE_WAITING_FOR_ALL_POINTS_TO_RELEASE }
Protected Attributes inherited from fsIGestureHandlingComponent
std::vector< sGesturePoint >	mGesturePoints
fsS32	mGestureState
fsS32	mNumPointsDown
fsBool	mHighlighted
Protected Attributes inherited from fsIMessageListener
fsS32	mPriority

Constructor & Destructor Documentation

gfCNavigateComponent()

gfCNavigateComponent::gfCNavigateComponent ( fsCEntity * pParent )

protected

~gfCNavigateComponent()

gfCNavigateComponent::~gfCNavigateComponent ( )

protectedvirtual

Member Function Documentation

acceptingInputGet()

fsBool gfCNavigateComponent::acceptingInputGet ( ) const

overrideprotectedvirtual

Implements fsIGestureHandlingComponent.

activeGet()

fsBool gfCNavigateComponent::activeGet

(

)

const

activeSet()

void gfCNavigateComponent::activeSet

(

fsBool

pActive

)

create()

fsIComponent * gfCNavigateComponent::create ( fsCEntity * pParent )

staticprotected

highlightSetDo()

fsBool gfCNavigateComponent::highlightSetDo ( )

overrideprotectedvirtual

Reimplemented from fsIGestureHandlingComponent.

onTap()

void gfCNavigateComponent::onTap ( const fsPoint & pTapPos )

overrideprotectedvirtual

Reimplemented from fsIGestureHandlingComponent.

tutorialCompletedDo()

void gfCNavigateComponent::tutorialCompletedDo ( const fsPoint & pPos )

overrideprotectedvirtual

Implements fsITutorialEnabledComponent.

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mEntityPrefix

const fsStr gfCNavigateComponent::mEntityPrefix

static

mNavigateComponentTapMsg

const fsCUniqueId gfCNavigateComponent::mNavigateComponentTapMsg

static

mTypeId

const fsCUniqueId gfCNavigateComponent::mTypeId

static

---

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

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