Overview | All Modules | Tutorial | User's Guide | Programming Guide
Previous

COVISE Online Documentation

Next

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vrui::coButtonInteraction Class Reference

#include <coButtonInteraction.h>

Inheritance diagram for vrui::coButtonInteraction:
vrui::coInteraction vrui::coCombinedButtonInteraction vrui::coMouseButtonInteraction vrui::coRelativeButtonInteraction vrui::coTrackerButtonInteraction vrui::coRelativeInputInteraction

Public Member Functions

 coButtonInteraction (InteractionType type, const std::string &name, InteractionPriority priority=Medium)
 
virtual ~coButtonInteraction ()
 
virtual void update ()
 
virtual void startInteraction ()
 
virtual void stopInteraction ()
 
virtual void doInteraction ()
 
virtual void cancelInteraction ()
 
virtual void resetState ()
 
int getWheelCount () const
 
- Public Member Functions inherited from vrui::coInteraction
 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

virtual bool conditionMet () const
 
virtual bool conditionBecameMet () const
 
void updateState (vruiButtons *button)
 
- Protected Member Functions inherited from vrui::coInteraction
void setState (InteractionState s)
 

Protected Attributes

unsigned buttonmask = 0
 
int wheelCount = 0
 
vruiButtonsbutton = nullptr
 
- Protected Attributes inherited from vrui::coInteraction
std::string name
 
InteractionType type
 
InteractionPriority priority
 
InteractionGroup group = GroupNonexclusive
 
RunningState runningState
 
bool notifyOnly
 
bool hasPriorityFlag
 
bool registered
 

Additional Inherited Members

- Public Types inherited from vrui::coInteraction
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 }
 

Constructor & Destructor Documentation

◆ coButtonInteraction()

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

◆ ~coButtonInteraction()

vrui::coButtonInteraction::~coButtonInteraction ( )
virtual

Member Function Documentation

◆ cancelInteraction()

void vrui::coButtonInteraction::cancelInteraction ( )
virtual

Reimplemented from vrui::coInteraction.

◆ conditionBecameMet()

bool vrui::coButtonInteraction::conditionBecameMet ( ) const
protectedvirtual

◆ conditionMet()

bool vrui::coButtonInteraction::conditionMet ( ) const
protectedvirtual

◆ doInteraction()

void vrui::coButtonInteraction::doInteraction ( )
virtual

◆ getWheelCount()

int vrui::coButtonInteraction::getWheelCount ( ) const

◆ resetState()

void vrui::coButtonInteraction::resetState ( )
virtual

Reimplemented from vrui::coInteraction.

◆ startInteraction()

void vrui::coButtonInteraction::startInteraction ( )
virtual

◆ stopInteraction()

void vrui::coButtonInteraction::stopInteraction ( )
virtual

◆ update()

void vrui::coButtonInteraction::update ( )
virtual

◆ updateState()

void vrui::coButtonInteraction::updateState ( vruiButtons button)
protected

Member Data Documentation

◆ button

vruiButtons* vrui::coButtonInteraction::button = nullptr
protected

◆ buttonmask

unsigned vrui::coButtonInteraction::buttonmask = 0
protected

◆ wheelCount

int vrui::coButtonInteraction::wheelCount = 0
protected

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

Authors: Martin Aumüller, Ruth Lang, Daniela Rainer, Jürgen Schulze-Döbold, Andreas Werner, Peter Wolf, Uwe Wössner
Copyright © 1993-2009 HLRS, 2004-2009 RRZK, 2005-2009 Visenso
COVISE Version 6.5 Academic