OpenCOVER
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
vrui::coInteraction Class Reference

#include <coInteraction.h>

Inheritance diagram for vrui::coInteraction:
Inheritance graph
[legend]

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, ButtonB, ButtonC, ButtonD,
  ButtonE, Wheel, Joystick, AllButtons,
  NumInteractorTypes
}
 

Public Member Functions

 coInteraction (InteractionType type, const std::string &name, InteractionPriority priority=Medium)
 
virtual ~coInteraction ()
 
InteractionState getState () const
 
InteractionType getType () const
 
InteractionPriority getPriority () const
 
int getRemoteLockID () const
 
void setRemoteLockID (int ID)
 
void setRemoteLock (bool)
 
void setRemoteActive (bool)
 
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 ()
 

Protected Attributes

std::string name
 
InteractionState state
 
InteractionType type
 
InteractionPriority priority
 
bool notifyOnly
 
bool hasPriorityFlag
 
bool registered
 
bool remoteLock
 
int remoteLockID
 

Friends

class coInteractionManager
 

Member Enumeration Documentation

Enumerator
Low 
Navigation 
NavigationHigh 
Medium 
High 
Menu 
Highest 
Enumerator
Idle 
PendingActive 
Active 
Paused 
RemoteActive 
ActiveNotify 
Stopped 
Enumerator
ButtonA 
ButtonB 
ButtonC 
ButtonD 
ButtonE 
Wheel 
Joystick 
AllButtons 
NumInteractorTypes 

Constructor & Destructor Documentation

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

Member Function Documentation

bool vrui::coInteraction::activate ( )
virtual void vrui::coInteraction::addIcon ( )
virtual
virtual void vrui::coInteraction::cancelInteraction ( )
virtual
virtual void vrui::coInteraction::cancelPendingActivation ( )
virtual
virtual void vrui::coInteraction::doActivation ( )
virtual
virtual const std::string& vrui::coInteraction::getName ( ) const
inlinevirtual
InteractionPriority vrui::coInteraction::getPriority ( ) const
inline
int vrui::coInteraction::getRemoteLockID ( ) const
inline
InteractionState vrui::coInteraction::getState ( ) const
inline
InteractionType vrui::coInteraction::getType ( ) const
inline
virtual bool vrui::coInteraction::hasPriority ( )
virtual
bool vrui::coInteraction::isNotifyOnly ( )
inline
bool vrui::coInteraction::isRegistered ( )
inline
virtual void vrui::coInteraction::pause ( )
virtual
virtual void vrui::coInteraction::removeIcon ( )
virtual
void vrui::coInteraction::requestActivation ( )
virtual void vrui::coInteraction::resetState ( )
virtual

Reimplemented in vrui::coButtonInteraction.

virtual void vrui::coInteraction::setName ( const std::string &  name)
virtual
void vrui::coInteraction::setNotifyOnly ( bool  flag)
void vrui::coInteraction::setRemoteActive ( bool  )
void vrui::coInteraction::setRemoteLock ( bool  )
void vrui::coInteraction::setRemoteLockID ( int  ID)
virtual void vrui::coInteraction::update ( )
virtual

Friends And Related Function Documentation

friend class coInteractionManager
friend

Member Data Documentation

bool vrui::coInteraction::hasPriorityFlag
protected
std::string vrui::coInteraction::name
protected
bool vrui::coInteraction::notifyOnly
protected
InteractionPriority vrui::coInteraction::priority
protected
bool vrui::coInteraction::registered
protected
bool vrui::coInteraction::remoteLock
protected
int vrui::coInteraction::remoteLockID
protected
InteractionState vrui::coInteraction::state
protected
InteractionType vrui::coInteraction::type
protected

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