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

#include <coIconButtonToolboxItem.h>

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

Public Member Functions

 coIconButtonToolboxItem (const std::string &)
 
virtual ~coIconButtonToolboxItem ()
 
virtual int hit (vruiHit *)
 
virtual void miss ()
 
virtual void selected (bool select)
 MenuItem is selected via joystick. More...
 
virtual void doActionRelease ()
 Action is called via joystick. More...
 
virtual void buttonEvent (coButton *)
 
virtual bool updateContentBool (bool)
 set the twin MenuItem 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::coToolboxMenuItem
 coToolboxMenuItem (const std::string &name)
 
virtual ~coToolboxMenuItem ()
 
virtual coUIElementgetUIElement ()
 
virtual void doSecondActionRelease ()
 Action is called via joystick. More...
 
- 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 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 setLabel (const std::string &newName)
 this function may be overloaded - it is called by setName() More...
 
virtual void doActionPress ()
 Action is called via joystick. More...
 
virtual void doSecondActionPress ()
 second Action for Item More...
 
- Public Member Functions inherited from vrui::coButtonActor
virtual ~coButtonActor ()
 
- 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

coPushButtonmyButton
 
vruiNodelastHit
 
- Protected Attributes inherited from vrui::coToolboxMenuItem
coMenuContainermenuContainer
 container to store menu elements More...
 
coColoredBackgroundbackground
 menu item background which changes its color when menu item is selected 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::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 }
 

Detailed Description

This class defines a toolbox item which can be used as a button to trigger an action. The event states are fed to the Twin Item (actual state: on, off). Additionally specified own menuListeners are performed after the twin item! The button works as 'key' button not as 'toggle' button.

Constructor & Destructor Documentation

vrui::coIconButtonToolboxItem::coIconButtonToolboxItem ( const std::string &  )
virtual vrui::coIconButtonToolboxItem::~coIconButtonToolboxItem ( )
virtual

Member Function Documentation

virtual void vrui::coIconButtonToolboxItem::buttonEvent ( coButton )
inlinevirtual

Implements vrui::coButtonActor.

virtual void vrui::coIconButtonToolboxItem::doActionRelease ( )
virtual

Action is called via joystick.

Reimplemented from vrui::coMenuItem.

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

get the Element's classname

Reimplemented from vrui::coToolboxMenuItem.

virtual int vrui::coIconButtonToolboxItem::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::coIconButtonToolboxItem::isOfClassName ( const char *  ) const
virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coToolboxMenuItem.

virtual void vrui::coIconButtonToolboxItem::miss ( )
virtual

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

Reimplemented from vrui::coAction.

virtual void vrui::coIconButtonToolboxItem::selected ( bool  select)
virtual

MenuItem is selected via joystick.

Reimplemented from vrui::coMenuItem.

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

functions activates or deactivates the item

Reimplemented from vrui::coToolboxMenuItem.

virtual bool vrui::coIconButtonToolboxItem::updateContentBool ( bool  )
virtual

set the twin MenuItem

Reimplemented from vrui::coMenuItem.

Member Data Documentation

vruiNode* vrui::coIconButtonToolboxItem::lastHit
protected
coPushButton* vrui::coIconButtonToolboxItem::myButton
protected

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