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

#include <coSliderMenuItem.h>

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

Public Member Functions

 coSliderMenuItem (const std::string &name, float min, float max, float init)
 
virtual ~coSliderMenuItem ()
 
int hit (vruiHit *hit)
 
void miss ()
 
void setValue (float value)
 
float getValue () const
 
void setMin (float min)
 
float getMin () const
 
void setMax (float max)
 
float getMax () const
 
void setNumTicks (float ticks)
 
float getNumTicks () const
 
void setPrecision (int precision)
 
int getPrecision () const
 
bool isInteger () const
 
void setInteger (bool on)
 
void sliderEvent (coSlider *slider)
 
void sliderReleasedEvent (coSlider *)
 
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...
 
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...
 
bool updateContentRange (float min, float max, float value, bool isInteger, float step)
 for floating point state transfers between fixed boundaries More...
 
bool updateContentFloat (float value)
 for discrete state transfers More...
 
bool updateContentReleased ()
 for boolean state transfers 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)
 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 updateContentBool (bool)
 set the twin MenuItem More...
 
virtual bool updateContentPressed ()
 for boolean state transfers More...
 
virtual bool updateContentInt (int)
 for boolean state transfers 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...
 
- Public Member Functions inherited from vrui::coSliderActor
virtual ~coSliderActor ()
 
- 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

coSliderslider
 slider UI element More...
 
- 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::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

This class defines a menu item which provides a slider to manipulate a scalar value. The slider UI element is defined in coSlider, events are processed by coSliderActor and coAction.

Constructor & Destructor Documentation

vrui::coSliderMenuItem::coSliderMenuItem ( const std::string &  name,
float  min,
float  max,
float  init 
)
virtual vrui::coSliderMenuItem::~coSliderMenuItem ( )
virtual

Member Function Documentation

virtual void vrui::coSliderMenuItem::doActionPress ( )
virtual

Action is called via joystick.

Reimplemented from vrui::coMenuItem.

virtual void vrui::coSliderMenuItem::doActionRelease ( )
virtual

Action is called via joystick.

Reimplemented from vrui::coMenuItem.

virtual void vrui::coSliderMenuItem::doSecondActionPress ( )
virtual

second Action for Item

Reimplemented from vrui::coMenuItem.

virtual void vrui::coSliderMenuItem::doSecondActionRelease ( )
virtual

second Action for Item

Reimplemented from vrui::coMenuItem.

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

get the Element's classname

Reimplemented from vrui::coRowMenuItem.

float vrui::coSliderMenuItem::getMax ( ) const
float vrui::coSliderMenuItem::getMin ( ) const
float vrui::coSliderMenuItem::getNumTicks ( ) const
int vrui::coSliderMenuItem::getPrecision ( ) const
float vrui::coSliderMenuItem::getValue ( ) const
int vrui::coSliderMenuItem::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.

bool vrui::coSliderMenuItem::isInteger ( ) const
virtual bool vrui::coSliderMenuItem::isOfClassName ( const char *  ) const
virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coRowMenuItem.

void vrui::coSliderMenuItem::miss ( )
virtual

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

Reimplemented from vrui::coAction.

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

MenuItem is selected via joystick.

Reimplemented from vrui::coRowMenuItem.

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

functions activates or deactivates the item

Reimplemented from vrui::coRowMenuItem.

void vrui::coSliderMenuItem::setInteger ( bool  on)
void vrui::coSliderMenuItem::setMax ( float  max)
void vrui::coSliderMenuItem::setMin ( float  min)
void vrui::coSliderMenuItem::setNumTicks ( float  ticks)
void vrui::coSliderMenuItem::setPrecision ( int  precision)
void vrui::coSliderMenuItem::setValue ( float  value)
void vrui::coSliderMenuItem::sliderEvent ( coSlider slider)
virtual

Reimplemented from vrui::coSliderActor.

void vrui::coSliderMenuItem::sliderReleasedEvent ( coSlider )
virtual

Reimplemented from vrui::coSliderActor.

bool vrui::coSliderMenuItem::updateContentFloat ( float  )
virtual

for discrete state transfers

Reimplemented from vrui::coMenuItem.

bool vrui::coSliderMenuItem::updateContentRange ( float  ,
float  ,
float  ,
bool  ,
float   
)
virtual

for floating point state transfers between fixed boundaries

for floating point state transfers

Reimplemented from vrui::coMenuItem.

bool vrui::coSliderMenuItem::updateContentReleased ( )
virtual

for boolean state transfers

Reimplemented from vrui::coMenuItem.

Member Data Documentation

coSlider* vrui::coSliderMenuItem::slider
protected

slider UI element


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