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

#include <coButtonMenuItem.h>

Inheritance diagram for vrui::coButtonMenuItem:
Inheritance graph
Collaboration diagram for vrui::coButtonMenuItem:
Collaboration graph

Public Member Functions

 coButtonMenuItem (const std::string &)
 coButtonMenuItem (const std::string &name, const std::string &nameIcon, float texSizeX=0, float texSizeY=0)
 Button with icon. More...
virtual ~coButtonMenuItem ()
int hit (vruiHit *hit)
void miss ()
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 bool dropOperation (coDragNDrop *)
virtual const std::string & getIconName ()
virtual float getIconSizeX ()
virtual float getIconSizeY ()
virtual void setIconSizeX (float x)
virtual void setIconSizeY (float y)
virtual void setActive (bool a)
 functions activates or deactivates the item More...
virtual void selected (bool select)
 MenuItem is selected via joystick. More...
virtual void doActionRelease ()
 ActionPress is called via joystick. 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 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 doActionPress ()
 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::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...
- Public Member Functions inherited from vrui::coDragNDrop
 coDragNDrop ()
 simple constructor More...
 coDragNDrop (int)
 constructor with specific media type More...
virtual ~coDragNDrop ()
int getMediaType ()
- Public Member Functions inherited from vrui::coTexturedBackgroundActor
virtual ~coTexturedBackgroundActor ()
virtual void texturePointerClicked (coTexturedBackground *, float, float)
virtual void texturePointerReleased (coTexturedBackground *, float, float)
virtual void texturePointerDragged (coTexturedBackground *, float, float)
virtual void texturePointerMoved (coTexturedBackground *, float, float)
virtual void texturePointerLeft (coTexturedBackground *)

Protected Attributes

 blank space left of label text, used as a margin More...
- Protected Attributes inherited from vrui::coRowMenuItem
 container to store menu elements More...
 menu item background which changes its color when menu item is selected More...
 label text More...
- Protected Attributes inherited from vrui::coMenuItem
bool visible
 this menu item More...
 on menu selection More...
std::string myName
 symbolic name, or displayed as label) More...
 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
- Protected Attributes inherited from vrui::coDragNDrop
int mediaType
 this objects media type More...
 this is the pfDCS that should be used for drag visualisation More...

Additional Inherited Members

- Public Types inherited from vrui::coAction
enum  Result { ACTION_DONE = 0x00, ACTION_CALL_ON_MISS = 0x01, ACTION_UNDEF = 0x02 }
- Public Types inherited from vrui::coDragNDrop
 the known media types More...
- Protected Member Functions inherited from vrui::coDragNDrop
bool processHit ()
void dragOperation ()
 those two do the work and return if it worked :) More...
- Static Protected Attributes inherited from vrui::coRowMenuItem
static const int LEFTMARGIN
 size of margin at left edge of menu item More...

Detailed Description

This class defines a menu item which can be used as a button to trigger an action. The events are processed by coAction.

Constructor & Destructor Documentation

vrui::coButtonMenuItem::coButtonMenuItem ( const std::string &  )
vrui::coButtonMenuItem::coButtonMenuItem ( const std::string &  name,
const std::string &  nameIcon,
float  texSizeX = 0,
float  texSizeY = 0 

Button with icon.

virtual vrui::coButtonMenuItem::~coButtonMenuItem ( )

Member Function Documentation

virtual void vrui::coButtonMenuItem::doActionRelease ( )

ActionPress is called via joystick.

Reimplemented from vrui::coMenuItem.

virtual bool vrui::coButtonMenuItem::dropOperation ( coDragNDrop )

Implements vrui::coDragNDrop.

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

get the Element's classname

Reimplemented from vrui::coRowMenuItem.

virtual const std::string& vrui::coButtonMenuItem::getIconName ( )
virtual float vrui::coButtonMenuItem::getIconSizeX ( )
virtual float vrui::coButtonMenuItem::getIconSizeY ( )
int vrui::coButtonMenuItem::hit ( vruiHit hit)

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::coButtonMenuItem::isOfClassName ( const char *  ) const

check if the Element or any ancestor is this classname

Reimplemented from vrui::coRowMenuItem.

void vrui::coButtonMenuItem::miss ( )

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

Reimplemented from vrui::coAction.

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

MenuItem is selected via joystick.

Reimplemented from vrui::coRowMenuItem.

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

functions activates or deactivates the item

Reimplemented from vrui::coRowMenuItem.

virtual void vrui::coButtonMenuItem::setIconSizeX ( float  x)
virtual void vrui::coButtonMenuItem::setIconSizeY ( float  y)
virtual bool vrui::coButtonMenuItem::updateContentBool ( bool  )

set the twin MenuItem

Reimplemented from vrui::coMenuItem.

Member Data Documentation

coTexturedBackground* vrui::coButtonMenuItem::icon
coBackground* vrui::coButtonMenuItem::space

blank space left of label text, used as a margin

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