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

#include <coSubMenuItem.h>

Inheritance diagram for vrui::coSubMenuItem:
Inheritance graph
[legend]
Collaboration diagram for vrui::coSubMenuItem:
Collaboration graph
[legend]

Public Member Functions

 coSubMenuItem (const std::string &name)
 
virtual ~coSubMenuItem ()
 
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 void doSecondActionRelease ()
 second Action for Item More...
 
virtual void closeSubmenu ()
 
virtual void openSubmenu ()
 
virtual void positionSubmenu ()
 
virtual void buttonEvent (coRotButton *button)
 
virtual bool updateContentBool (bool newState)
 set the twin MenuItem More...
 
virtual void setAttachment (int attachment)
 Set the attachment of the submenu respective to the menu item. More...
 
virtual int getAttachment ()
 Get the attachment. More...
 
virtual void setActive (bool a)
 functions activates or deactivates the item 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...
 
void setSecondaryItem (coMenuItem *item)
 trigger doActionRelease (i.e. toggle) this item on XFORM button release 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)
 this function may be overloaded - it is called by setName() More...
 
virtual coUIElementgetUIElement ()
 
- 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 const char * getName () const
 
virtual coMenuItemgetTwin ()
 
virtual void setTwin (coMenuItem *twin)
 get the twin MenuItem More...
 
virtual bool updateContentPressed ()
 for boolean state transfers More...
 
virtual bool updateContentReleased ()
 for boolean state transfers More...
 
virtual bool updateContentInt (int)
 for boolean state transfers More...
 
virtual bool updateContentFloat (float)
 for discrete state transfers More...
 
virtual bool updateContentRange (float, float, float, bool, float)
 for floating point state transfers between fixed boundaries More...
 
virtual bool updateContentPointer (void *)
 
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 bool getActive ()
 return if item is active More...
 
virtual void doActionPress ()
 Action is called via joystick. More...
 
virtual void doSecondActionPress ()
 second Action for Item More...
 
- Public Member Functions inherited from vrui::coGenericSubMenuItem
 coGenericSubMenuItem (coMenuItem *container)
 
virtual ~coGenericSubMenuItem ()
 
void setMenu (coMenu *menu)
 
void setMenuChangeListener (coMenuChangeListener *listener)
 
bool isOpen () const
 
coMenugetMenu ()
 get my subMenu More...
 
- Public Member Functions inherited from vrui::coRotButtonActor
virtual ~coRotButtonActor ()
 
- Public Member Functions inherited from vrui::coAction
 coAction ()
 Constructor. More...
 
virtual ~coAction ()
 Destructor. More...
 
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

coRotButtonsubMenuIcon
 arrow button which is used for interaction More...
 
coBackgroundspace
 blank space left of label text, used as a margin More...
 
int attachment
 
coMenuItemsecondaryItem
 item that is triggered on right-button clicks More...
 
coCombinedButtonInteractionpreventMoveInteraction
 
- 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...
 
coMenuItemmyTwin
 pointer to a cloned 'twin' version (toolbar/menu) of this item. On changes the current content state should be forwarded to the twin so it can update is representation to it. (see 'updateContent()' methods) More...
 
bool active_
 flag if item is active More...
 
- Protected Attributes inherited from vrui::coGenericSubMenuItem
coMenusubMenu
 the subMenu which is opened and closed by thes button More...
 
bool open
 current state of the menu (open or closed) More...
 
coMenuChangeListenerlistener_
 attach this listener to the menu when added to one More...
 
coMenuItemcontainer_
 containing menu item 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 }
 
- 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 which can be used to open and close submenus menu events are generated when the user opens or closes the submenu

Constructor & Destructor Documentation

vrui::coSubMenuItem::coSubMenuItem ( const std::string &  name)
virtual vrui::coSubMenuItem::~coSubMenuItem ( )
virtual

Member Function Documentation

virtual void vrui::coSubMenuItem::buttonEvent ( coRotButton button)
virtual
virtual void vrui::coSubMenuItem::closeSubmenu ( )
virtual
virtual void vrui::coSubMenuItem::doActionRelease ( )
virtual

Action is called via joystick.

Reimplemented from vrui::coMenuItem.

virtual void vrui::coSubMenuItem::doSecondActionRelease ( )
virtual

second Action for Item

Reimplemented from vrui::coMenuItem.

virtual int vrui::coSubMenuItem::getAttachment ( )
inlinevirtual

Get the attachment.

virtual const char* vrui::coSubMenuItem::getClassName ( ) const
virtual

get the Element's classname

Reimplemented from vrui::coRowMenuItem.

int vrui::coSubMenuItem::hit ( vruiHit hit)
virtual

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.

virtual bool vrui::coSubMenuItem::isOfClassName ( const char *  ) const
virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coRowMenuItem.

void vrui::coSubMenuItem::miss ( )
virtual

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

Reimplemented from vrui::coAction.

virtual void vrui::coSubMenuItem::openSubmenu ( )
virtual
virtual void vrui::coSubMenuItem::positionSubmenu ( )
virtual
virtual void vrui::coSubMenuItem::selected ( bool  select)
virtual

MenuItem is selected via joystick.

Reimplemented from vrui::coRowMenuItem.

virtual void vrui::coSubMenuItem::setActive ( bool  a)
virtual

functions activates or deactivates the item

Reimplemented from vrui::coRowMenuItem.

virtual void vrui::coSubMenuItem::setAttachment ( int  attachment)
virtual

Set the attachment of the submenu respective to the menu item.

Reimplemented from vrui::coMenuItem.

void vrui::coSubMenuItem::setSecondaryItem ( coMenuItem item)

trigger doActionRelease (i.e. toggle) this item on XFORM button release

virtual bool vrui::coSubMenuItem::updateContentBool ( bool  )
virtual

set the twin MenuItem

Reimplemented from vrui::coMenuItem.

Member Data Documentation

int vrui::coSubMenuItem::attachment
protected
coCombinedButtonInteraction* vrui::coSubMenuItem::preventMoveInteraction
protected
coMenuItem* vrui::coSubMenuItem::secondaryItem
protected

item that is triggered on right-button clicks

coBackground* vrui::coSubMenuItem::space
protected

blank space left of label text, used as a margin

coRotButton* vrui::coSubMenuItem::subMenuIcon
protected

arrow button which is used for interaction


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