vrui::coInteraction Class Reference

#include <coInteraction.h>

Inheritance diagram for vrui::coInteraction:

Public Types
enum	InteractionState {   Idle = 0 , PendingActive , Active , Paused ,   RemoteActive , ActiveNotify , Stopped }
enum	InteractionPriority {   Low = 0 , Navigation , NavigationHigh , Medium ,   High , Menu , Highest }
enum	InteractionType {   ButtonA = 0 , ButtonAction = ButtonA , ButtonB , ButtonDrive = ButtonB ,   ButtonC , ButtonXform = ButtonC , ButtonD , ButtonForward = ButtonD ,   ButtonE , ButtonBack = ButtonE , ButtonToggleDocuments , ButtonDrag ,   ButtonZoom , ButtonMenu , ButtonQuit , ButtonNextInter ,   ButtonPrevInter , ButtonNextPerson , ButtonPrevPerson , LastButton = ButtonPrevPerson ,   WheelHorizontal , WheelVertical , Wheel = WheelVertical , Joystick ,   AllButtons , NoButton , NumInteractorTypes }
enum	InteractionGroup { GroupNonexclusive , GroupNavigation }
enum	RunningState { StateStarted = 0 , StateRunning , StateStopped , StateNotRunning }

Public Member Functions
	coInteraction (InteractionType type, const std::string &name, InteractionPriority priority=Medium)
virtual	~coInteraction ()
InteractionState	getState () const
InteractionType	getType () const
InteractionPriority	getPriority () const
InteractionGroup	getGroup () const
void	setGroup (InteractionGroup group)
void	requestActivation ()
virtual void	update ()
virtual void	cancelInteraction ()
virtual void	setName (const std::string &name)
virtual void	removeIcon ()
virtual void	addIcon ()
virtual bool	hasPriority ()
virtual void	cancelPendingActivation ()
virtual void	doActivation ()
virtual void	pause ()
virtual const std::string &	getName () const
virtual void	resetState ()
bool	activate ()
bool	isRegistered ()
void	setNotifyOnly (bool flag)
bool	isNotifyOnly ()
bool	wasStarted () const
bool	isRunning () const
bool	wasStopped () const
bool	isIdle () const
InteractionState	getState ()

Protected Member Functions
void	setState (InteractionState s)

Protected Attributes
std::string	name
InteractionType	type
InteractionPriority	priority
InteractionGroup	group = GroupNonexclusive
RunningState	runningState
bool	notifyOnly
bool	hasPriorityFlag
bool	registered

Friends
class	coInteractionManager

Member Enumeration Documentation

InteractionGroup

enum vrui::coInteraction::InteractionGroup

Enumerator
GroupNonexclusive
GroupNavigation

InteractionPriority

enum vrui::coInteraction::InteractionPriority

Enumerator
Low
Navigation
NavigationHigh
Medium
High
Menu
Highest

InteractionState

enum vrui::coInteraction::InteractionState

Enumerator
Idle
PendingActive
Active
Paused
RemoteActive
ActiveNotify
Stopped

InteractionType

enum vrui::coInteraction::InteractionType

Enumerator
ButtonA
ButtonAction
ButtonB
ButtonDrive
ButtonC
ButtonXform
ButtonD
ButtonForward
ButtonE
ButtonBack
ButtonToggleDocuments
ButtonDrag
ButtonZoom
ButtonMenu
ButtonQuit
ButtonNextInter
ButtonPrevInter
ButtonNextPerson
ButtonPrevPerson
LastButton
WheelHorizontal
WheelVertical
Wheel
Joystick
AllButtons
NoButton
NumInteractorTypes

RunningState

enum vrui::coInteraction::RunningState

Enumerator
StateStarted
StateRunning
StateStopped
StateNotRunning

Constructor & Destructor Documentation

coInteraction()

vrui::coInteraction::coInteraction	(	InteractionType	type,
		const std::string &	name,
		InteractionPriority	priority = Medium
	)

~coInteraction()

virtual vrui::coInteraction::~coInteraction ( )

virtual

Member Function Documentation

activate()

bool vrui::coInteraction::activate

(

)

addIcon()

virtual void vrui::coInteraction::addIcon ( )

virtual

Reimplemented in opencover::coVRIntersectionInteractor.

cancelInteraction()

virtual void vrui::coInteraction::cancelInteraction ( )

virtual

Reimplemented in vrui::coButtonInteraction, and vrui::coNavInteraction.

cancelPendingActivation()

virtual void vrui::coInteraction::cancelPendingActivation ( )

virtual

doActivation()

virtual void vrui::coInteraction::doActivation ( )

virtual

getGroup()

InteractionGroup vrui::coInteraction::getGroup ( ) const

inline

getName()

virtual const std::string & vrui::coInteraction::getName ( ) const

inlinevirtual

getPriority()

InteractionPriority vrui::coInteraction::getPriority ( ) const

inline

getState() [1/2]

InteractionState vrui::coInteraction::getState

(

)

getState() [2/2]

InteractionState vrui::coInteraction::getState ( ) const

inline

getType()

InteractionType vrui::coInteraction::getType ( ) const

inline

hasPriority()

virtual bool vrui::coInteraction::hasPriority ( )

virtual

isIdle()

bool vrui::coInteraction::isIdle ( ) const

inline

isNotifyOnly()

bool vrui::coInteraction::isNotifyOnly ( )

inline

isRegistered()

bool vrui::coInteraction::isRegistered ( )

inline

isRunning()

bool vrui::coInteraction::isRunning ( ) const

inline

pause()

virtual void vrui::coInteraction::pause ( )

virtual

removeIcon()

virtual void vrui::coInteraction::removeIcon ( )

virtual

Reimplemented in opencover::coVRIntersectionInteractor.

requestActivation()

void vrui::coInteraction::requestActivation

(

)

resetState()

virtual void vrui::coInteraction::resetState ( )

virtual

Reimplemented in opencover::coVRIntersectionInteractor, vrui::coButtonInteraction, opencover::coVR3DGizmoType, opencover::coVR3DScaleGizmo, and opencover::coVR3DTransGizmo.

setGroup()

void vrui::coInteraction::setGroup

(

InteractionGroup

group

)

setName()

virtual void vrui::coInteraction::setName ( const std::string &  name )

virtual

setNotifyOnly()

void vrui::coInteraction::setNotifyOnly

(

bool

flag

)

setState()

void vrui::coInteraction::setState ( InteractionState  s )

protected

update()

virtual void vrui::coInteraction::update ( )

virtual

Reimplemented in vrui::coButtonInteraction, vrui::coCombinedButtonInteraction, vrui::coMouseButtonInteraction, vrui::coNavInteraction, vrui::coRelativeButtonInteraction, vrui::coTrackerButtonInteraction, vrui::coRelativeInputInteraction, and opencover::coVR3DGizmoType.

wasStarted()

bool vrui::coInteraction::wasStarted ( ) const

inline

wasStopped()

bool vrui::coInteraction::wasStopped ( ) const

inline

Friends And Related Function Documentation

coInteractionManager

friend class coInteractionManager

friend

Member Data Documentation

group

InteractionGroup vrui::coInteraction::group = GroupNonexclusive

protected

hasPriorityFlag

bool vrui::coInteraction::hasPriorityFlag

protected

name

std::string vrui::coInteraction::name

protected

notifyOnly

bool vrui::coInteraction::notifyOnly

protected

priority

InteractionPriority vrui::coInteraction::priority

protected

registered

bool vrui::coInteraction::registered

protected

runningState

RunningState vrui::coInteraction::runningState

protected

type

InteractionType vrui::coInteraction::type

protected

---

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

• OpenVRUI/coInteraction.h