Overview | All Modules | Tutorial | User's Guide | Programming Guide
Previous

COVISE Online Documentation

Next

Public Member Functions | Protected Attributes | List of all members
vrui::coSliderToolboxItem Class Reference

#include <coSliderToolboxItem.h>

Inheritance diagram for vrui::coSliderToolboxItem:
vrui::coToolboxMenuItem vrui::coSliderActor vrui::coAction vrui::coMenuItem

Public Member Functions

 coSliderToolboxItem (const std::string &, float, float, float)
 Constructor, derived from coRowToolboxItem. More...
 
virtual ~coSliderToolboxItem ()
 Destructor. More...
 
virtual int hit (vruiHit *)
 This method is called on intersections of the input device with the slider menu item. More...
 
virtual void miss ()
 Called when input device leaves the element. More...
 
void setValue (float)
 Set the slider value. More...
 
float getValue () const
 
void setMin (float)
 Set slider minimum value. More...
 
float getMin () const
 Get current slider minimum value. More...
 
void setMax (float)
 Set slider maximum value. More...
 
float getMax () const
 Get slider maximum value. More...
 
void setNumTicks (float)
 Set number of tick lines on slider. More...
 
float getNumTicks () const
 Get number of ticks. More...
 
void setPrecision (int)
 Set value display precision. More...
 
int getPrecision () const
 Get precision. More...
 
void setInteger (bool)
 Set integer or floating point value display. More...
 
bool isInteger () const
 Get integer number display state. More...
 
void setLogarithmic (bool)
 
bool isLogarithmic () const
 
void setLabel (const std::string &labelstr)
 this function may be overloaded - it is called by setName() More...
 
void sliderEvent (coSlider *)
 Called every time the slider value is changed by the user. More...
 
void sliderReleasedEvent (coSlider *)
 
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...
 
virtual void selected (bool select)
 MenuItem is selected via joystick. More...
 
virtual void doActionPress ()
 move slider to lower More...
 
virtual void doSecondActionPress ()
 move slider to upper More...
 
- Public Member Functions inherited from vrui::coToolboxMenuItem
 coToolboxMenuItem (const std::string &name)
 Constructor. More...
 
virtual ~coToolboxMenuItem ()
 Destructor. Removes this menu item from the parent menu. More...
 
virtual coUIElementgetUIElement ()
 return the actual UI Element that represents this menu. 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)
 activates or deactivates the item More...
 
virtual void doSecondActionRelease ()
 Action is called via joystick. More...
 
- Public Member Functions inherited from vrui::coMenuItem
 coMenuItem (const std::string &name)
 Constructor. More...
 
virtual ~coMenuItem ()
 Destructor. Removes this menu item from the parent menu. More...
 
virtual void setMenuListener (coMenuListener *listener)
 Set a new menu listener to receive menu item events. More...
 
virtual coMenuListenergetMenuListener ()
 Get the menu listener to receive menu item events. More...
 
virtual void setParentMenu (coMenu *parent)
 Set the parent menu in which this menu item is listed. More...
 
virtual void setVisible (bool visible)
 show or hide this menu item., just removes it from the scenegraph in the default implementation, should do something better in the real implementation More...
 
virtual bool isVisible () const
 
virtual void setAttachment (int)
 sets the attachment border More...
 
virtual const char * getName () const
 returns the symbolic name of this menu item. More...
 
virtual coUIElementgetUIElement ()
 return the actual UI Element that represents this menu. 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...
 
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::coSliderActor
virtual ~coSliderActor ()
 
virtual void sliderEvent (coSlider *slider)
 Called every time the slider value is changed by the user. More...
 
virtual void sliderReleasedEvent (coSlider *slider)
 
- Public Member Functions inherited from vrui::coAction
 coAction ()
 Constructor. More...
 
virtual ~coAction ()
 Destructor. More...
 
virtual int hit (vruiHit *hit)=0
 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 More...
 
virtual void miss ()
 miss is called once after a hit, if the node is not intersected anymore 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...
 
coLabelminLabel
 
coLabelmaxLabel
 
coLabellabel
 
- 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
 parent menu which contains More...
 
coMenuListenerlistener
 menu event listener, triggered More...
 
std::string myName
 name of the item (internal More...
 
bool active_
 flag if item is active More...
 
- Protected Attributes inherited from vrui::coAction
std::string actionName
 name of this action this can be used to distinguish betwenn different types of actions like touch and intersection actions More...
 

Additional Inherited Members

- Public Types inherited from vrui::coAction
enum  Result { ACTION_DONE = 0x00 , ACTION_CALL_ON_MISS = 0x01 , ACTION_UNDEF = 0x02 }
 

Constructor & Destructor Documentation

◆ coSliderToolboxItem()

vrui::coSliderToolboxItem::coSliderToolboxItem ( const std::string &  name,
float  min,
float  max,
float  init 
)

Constructor, derived from coRowToolboxItem.

Parameters
nameLabel text.
min,maxMinimum and maximum slider values.
initInitial slider value.
See also
coRowToolboxItem

◆ ~coSliderToolboxItem()

vrui::coSliderToolboxItem::~coSliderToolboxItem ( )
virtual

Destructor.

Member Function Documentation

◆ doActionPress()

void vrui::coSliderToolboxItem::doActionPress ( )
virtual

move slider to lower

Reimplemented from vrui::coMenuItem.

◆ doSecondActionPress()

void vrui::coSliderToolboxItem::doSecondActionPress ( )
virtual

move slider to upper

Reimplemented from vrui::coMenuItem.

◆ getClassName()

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

get the Element's classname

Reimplemented from vrui::coToolboxMenuItem.

◆ getMax()

float vrui::coSliderToolboxItem::getMax ( ) const

Get slider maximum value.

Returns
slider maximum value

◆ getMin()

float vrui::coSliderToolboxItem::getMin ( ) const

Get current slider minimum value.

Returns
current slider minimum value

◆ getNumTicks()

float vrui::coSliderToolboxItem::getNumTicks ( ) const

Get number of ticks.

Returns
number of tick lines

◆ getPrecision()

int vrui::coSliderToolboxItem::getPrecision ( ) const

Get precision.

Returns
number of decimals displayed

◆ getValue()

float vrui::coSliderToolboxItem::getValue ( ) const
Returns
current slider value

◆ hit()

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

This method is called on intersections of the input device with the slider menu item.

Parameters
phit position
hhit information
Returns
ACTION_CALL_ON_MISS

Implements vrui::coAction.

◆ isInteger()

bool vrui::coSliderToolboxItem::isInteger ( ) const

Get integer number display state.

Returns
true if value display is integer

◆ isLogarithmic()

bool vrui::coSliderToolboxItem::isLogarithmic ( ) const

◆ isOfClassName()

bool vrui::coSliderToolboxItem::isOfClassName ( const char *  classname) const
virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coToolboxMenuItem.

◆ miss()

void vrui::coSliderToolboxItem::miss ( )
virtual

Called when input device leaves the element.

Reimplemented from vrui::coAction.

◆ selected()

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

MenuItem is selected via joystick.

Reimplemented from vrui::coMenuItem.

◆ setActive()

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

functions activates or deactivates the item

Reimplemented from vrui::coToolboxMenuItem.

◆ setInteger()

void vrui::coSliderToolboxItem::setInteger ( bool  val)

Set integer or floating point value display.

Parameters
valtrue = integer display, false = floating point display

◆ setLabel()

void vrui::coSliderToolboxItem::setLabel ( const std::string &  newName)
virtual

this function may be overloaded - it is called by setName()

Reimplemented from vrui::coMenuItem.

◆ setLogarithmic()

void vrui::coSliderToolboxItem::setLogarithmic ( bool  on)

◆ setMax()

void vrui::coSliderToolboxItem::setMax ( float  val)

Set slider maximum value.

Parameters
valmaximum value

◆ setMin()

void vrui::coSliderToolboxItem::setMin ( float  val)

Set slider minimum value.

Parameters
valminimum value

◆ setNumTicks()

void vrui::coSliderToolboxItem::setNumTicks ( float  nt)

Set number of tick lines on slider.

Parameters
ntnew tick number

◆ setPrecision()

void vrui::coSliderToolboxItem::setPrecision ( int  nt)

Set value display precision.

Parameters
ntnumber of decimals to display

◆ setValue()

void vrui::coSliderToolboxItem::setValue ( float  val)

Set the slider value.

Parameters
valnew slider value

◆ sliderEvent()

void vrui::coSliderToolboxItem::sliderEvent ( coSlider slider)
virtual

Called every time the slider value is changed by the user.

It is also called if setValue() is called with generateEvent==true. This method needs to be overwritten by child classes.

Parameters
slidercoSlider which triggered this event

Reimplemented from vrui::coSliderActor.

◆ sliderReleasedEvent()

void vrui::coSliderToolboxItem::sliderReleasedEvent ( coSlider s)
virtual

Reimplemented from vrui::coSliderActor.

Member Data Documentation

◆ label

coLabel* vrui::coSliderToolboxItem::label
protected

◆ maxLabel

coLabel* vrui::coSliderToolboxItem::maxLabel
protected

◆ minLabel

coLabel* vrui::coSliderToolboxItem::minLabel
protected

◆ slider

coSlider* vrui::coSliderToolboxItem::slider
protected

slider UI element


The documentation for this class was generated from the following files:
PreviousNext

Authors: Martin Aumüller, Ruth Lang, Daniela Rainer, Jürgen Schulze-Döbold, Andreas Werner, Peter Wolf, Uwe Wössner
Copyright © 1993-2009 HLRS, 2004-2009 RRZK, 2005-2009 Visenso
COVISE Version 6.5 Academic