NbNavigationState Class Reference

Internal class. More...

#include <NutsnBolts/navigation/NbNavigationState.h>

Public Member Functions
	NbNavigationState (void)
	~NbNavigationState (void)
NbNavigationMode *	getMode (void) const
const SoEvent *	getTrigger (void) const
void	pop (void)
void	push (NbNavigationMode *mode, const SoEvent *trigger)
void	reset (void)

Detailed Description

Internal class.

This class is only used internally in the NbNavigationSystem class to track the current navigation state (current mode). It isn't exposed anywhere.

Constructor & Destructor Documentation

NbNavigationState()

NbNavigationState::NbNavigationState

(

void

)

Constructor.

~NbNavigationState()

NbNavigationState::~NbNavigationState

(

void

)

Destructor.

Member Function Documentation

getMode()

NbNavigationMode * NbNavigationState::getMode

(

void

)

const

Returns the mode at the top of the mode state stack.

See also

push, pop, getTrigger

getTrigger()

const SoEvent * NbNavigationState::getTrigger

(

void

)

const

Returns the event that triggered the current mode.

NULL is returned in the case of the initial mode and if the mode state stack has been popped empty.

See also

getMode, push, pop

pop()

void NbNavigationState::pop

(

void

)

Pops the mode state stack.

push()

void NbNavigationState::push	(	NbNavigationMode *	mode,
		const SoEvent *	trigger )

Pushes a new mode on the state stack. trigger is the event that triggered the mode change.

See also

pop, getMode, getTrigger

reset()

void NbNavigationState::reset

(

void

)

Resets the mode state stack.

---

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

• NbNavigationState.h
• NbNavigationState.cpp