OpenCOVER
Public Member Functions | Protected Attributes | List of all members
opencover::VruiPartnerMenuItem Class Reference

#include <VruiPartnerMenuItem.h>

Inheritance diagram for opencover::VruiPartnerMenuItem:
Inheritance graph
[legend]
Collaboration diagram for opencover::VruiPartnerMenuItem:
Collaboration graph
[legend]

Public Member Functions

 VruiPartnerMenuItem (const std::string &name, bool on, vrui::coCheckboxGroup *=NULL)
 
 ~VruiPartnerMenuItem () override
 
int hit (vrui::vruiHit *hit) override
 
void miss () override
 
void buttonEvent (vrui::coButton *button) override
 
const char * getClassName () const override
 get the Element's classname More...
 
bool isOfClassName (const char *) const override
 check if the Element or any ancestor is this classname More...
 
- Public Member Functions inherited from vrui::coCheckboxMenuItem
 coCheckboxMenuItem (const std::string &name, bool on, coCheckboxGroup *group=0)
 
virtual ~coCheckboxMenuItem ()
 
void setState (bool newState, bool generateEvent, bool updateGroup=false)
 
void setState (bool newState)
 
bool getState () const
 
coCheckboxGroupgetGroup ()
 
int hit (vruiHit *hit)
 
void miss ()
 
virtual void selected (bool select)
 MenuItem is selected via joystick. More...
 
virtual void doActionRelease ()
 Action is called via joystick. More...
 
virtual const char * getClassName () const
 get the Element's classname More...
 
virtual bool isOfClassName (const char *) const
 check if the Element or any ancestor is this classname More...
 
virtual void setActive (bool a)
 functions activates or deactivates the item More...
 
- Public Member Functions inherited from vrui::coRowMenuItem
 coRowMenuItem (const std::string &labelString)
 
 coRowMenuItem (const std::string &symbolicName, const std::string &labelString)
 
virtual ~coRowMenuItem ()
 
virtual void setLabel (coLabel *label)
 
coLabelgetLabel ()
 
void setLabel (const std::string &labelString) override
 this function may be overloaded - it is called by setName() More...
 
coUIElementgetUIElement () override
 
const char * getClassName () const override
 get the Element's classname More...
 
bool isOfClassName (const char *) const override
 check if the Element or any ancestor is this classname More...
 
void setActive (bool a) override
 activates or deactivates the item More...
 
void selected (bool selected) override
 MenuItem is selected via joystick. More...
 
void setVisible (bool visible) override
 
- Public Member Functions inherited from vrui::coMenuItem
 coMenuItem (const std::string &name)
 
virtual ~coMenuItem ()
 
virtual void setMenuListener (coMenuListener *listener)
 
virtual coMenuListenergetMenuListener ()
 
virtual void setParentMenu (coMenu *parent)
 
virtual void setVisible (bool visible)
 
virtual bool isVisible () const
 
virtual void setAttachment (int)
 sets the attachment border More...
 
virtual const char * getName () const
 
virtual coUIElementgetUIElement ()
 
virtual const char * getClassName () const
 get the Element's classname More...
 
virtual bool isOfClassName (const char *) const
 check if the Element or any ancestor is this classname More...
 
coMenugetParentMenu ()
 get my parent menu More...
 
void setName (const std::string &newName, bool updateTwins=true)
 set my name - items with labels must call this when changing label More...
 
virtual void setActive (bool a)
 functions activates or deactivates the item More...
 
virtual bool getActive ()
 return if item is active More...
 
virtual void setLabel (const std::string &newName)
 this function may be overloaded - it is called by setName() More...
 
virtual void selected (bool select)
 MenuItem is selected via joystick. More...
 
virtual void doActionPress ()
 Action is called via joystick. More...
 
virtual void doActionRelease ()
 Action is called via joystick. More...
 
virtual void doSecondActionPress ()
 second Action for Item More...
 
virtual void doSecondActionRelease ()
 second Action for Item More...
 
- Public Member Functions inherited from vrui::coButtonActor
virtual ~coButtonActor ()
 
virtual void buttonEvent (coButton *button)=0
 
- Public Member Functions inherited from vrui::coAction
 coAction ()
 Constructor. More...
 
virtual ~coAction ()
 Destructor. More...
 
virtual int hit (vruiHit *hit)=0
 
virtual void miss ()
 
void setFrame (unsigned int frame)
 INTERNAL set the framecounter (used to produce the miss call) More...
 
unsigned int getFrame () const
 INTERNAL get the framecounter (used to produce the miss call) More...
 
void setNode (vruiNode *)
 INTERNAL set the node this action belongs to. More...
 
void addChild (coAction *)
 INTERNAL add a child action. More...
 
virtual int hitAll (vruiHit *hit)
 INTERNAL same as miss/hit, but do it for all children as well. More...
 
virtual void missAll ()
 INTERNAL same as miss/hit, but do it for all children as well. More...
 

Protected Attributes

vrui::coButtonviewpoint
 actual button which is used for interaction More...
 
- Protected Attributes inherited from vrui::coCheckboxMenuItem
coButtoncheckBox
 actual button which is used for interaction More...
 
coCheckboxGroupgroup
 checkbox group this checkbox belongs to More...
 
bool myState
 
- Protected Attributes inherited from vrui::coRowMenuItem
coMenuContainercontainer
 container to store menu elements More...
 
coColoredBackgroundbackground
 menu item background which changes its color when menu item is selected More...
 
coLabellabel
 label text More...
 
- Protected Attributes inherited from vrui::coMenuItem
bool visible
 
coMenumyMenu
 this menu item More...
 
coMenuListenerlistener
 on menu selection More...
 
std::string myName
 symbolic name, or displayed as label) More...
 
bool active_
 flag if item is active More...
 
- Protected Attributes inherited from vrui::coAction
std::string actionName
 

Additional Inherited Members

- Public Types inherited from vrui::coAction
enum  Result { ACTION_DONE = 0x00 , ACTION_CALL_ON_MISS = 0x01 , ACTION_UNDEF = 0x02 }
 
virtual void buttonEvent (coButton *source)
 
- Static Protected Attributes inherited from vrui::coRowMenuItem
static const int LEFTMARGIN
 size of margin at left edge of menu item More...
 

Detailed Description

Menu Item that reflects the state of a participant in a CVE

Constructor & Destructor Documentation

◆ VruiPartnerMenuItem()

opencover::VruiPartnerMenuItem::VruiPartnerMenuItem ( const std::string &  name,
bool  on,
vrui::coCheckboxGroup = NULL 
)

◆ ~VruiPartnerMenuItem()

opencover::VruiPartnerMenuItem::~VruiPartnerMenuItem ( )
override

Member Function Documentation

◆ buttonEvent()

void opencover::VruiPartnerMenuItem::buttonEvent ( vrui::coButton button)
overridevirtual

Reimplemented from vrui::coCheckboxMenuItem.

◆ getClassName()

const char * opencover::VruiPartnerMenuItem::getClassName ( ) const
overridevirtual

get the Element's classname

Reimplemented from vrui::coCheckboxMenuItem.

◆ hit()

int opencover::VruiPartnerMenuItem::hit ( vrui::vruiHit hit)
overridevirtual

hit is called whenever the node, or any node underneath the node with this action is intersected return ACTION_CALL_ON_MISS if you want miss to be called otherwise return ACTION_DONE

Implements vrui::coAction.

◆ isOfClassName()

bool opencover::VruiPartnerMenuItem::isOfClassName ( const char *  ) const
overridevirtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coCheckboxMenuItem.

◆ miss()

void opencover::VruiPartnerMenuItem::miss ( )
overridevirtual

miss is called once after a hit, if the node is not intersected anymore

Reimplemented from vrui::coAction.

Member Data Documentation

◆ viewpoint

vrui::coButton* opencover::VruiPartnerMenuItem::viewpoint
protected

actual button which is used for interaction


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