OpenCOVER
Public Member Functions | List of all members
opencover::coColorBar Class Reference

#include <coColorBar.h>

Inheritance diagram for opencover::coColorBar:
Inheritance graph
[legend]
Collaboration diagram for opencover::coColorBar:
Collaboration graph
[legend]

Public Member Functions

 coColorBar (const std::string &name, const std::string &species, float min, float max, int numColors, const float *r, const float *g, const float *b, const float *a, bool inMenu=true)
 
 ~coColorBar ()
 destructor More...
 
void update (float min, float max, int numColors, const float *r, const float *g, const float *b, const float *a)
 
const char * getName () const override
 
virtual vrui::coUIElementgetUIElement () override
 
virtual const char * getClassName () const override
 get the Element's classname More...
 
virtual bool isOfClassName (const char *) const override
 check if the Element or any ancestor is this classname 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 coUIElementgetUIElement ()
 
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...
 

Additional Inherited Members

- 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...
 
bool active_
 flag if item is active More...
 

Detailed Description

class coColorBar, derived from coMenuItem colorbar is a window containing a texture and labels

Constructor & Destructor Documentation

◆ coColorBar()

opencover::coColorBar::coColorBar ( const std::string &  name,
const std::string &  species,
float  min,
float  max,
int  numColors,
const float *  r,
const float *  g,
const float *  b,
const float *  a,
bool  inMenu = true 
)

constructor create texture and labels, put them nto containers

Parameters
namethe name of the colorbar, identical with module name, eg, g, Colors_1
speciesdata species name, currently not displayed
mindata minimum
maxdata maximum
numColorsnumber of different colors in colorbar
rred colors
ggreen colors
bblue colors
ared colors

◆ ~coColorBar()

opencover::coColorBar::~coColorBar ( )

destructor

Member Function Documentation

◆ getClassName()

virtual const char * opencover::coColorBar::getClassName ( ) const
overridevirtual

get the Element's classname

Reimplemented from vrui::coMenuItem.

◆ getName()

const char * opencover::coColorBar::getName ( ) const
overridevirtual

get name

Returns
name the name of the colorbar, identical with module name, eg, g, Colors_1

Reimplemented from vrui::coMenuItem.

◆ getUIElement()

virtual vrui::coUIElement * opencover::coColorBar::getUIElement ( )
overridevirtual

Reimplemented from vrui::coMenuItem.

◆ isOfClassName()

virtual bool opencover::coColorBar::isOfClassName ( const char *  ) const
overridevirtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coMenuItem.

◆ update()

void opencover::coColorBar::update ( float  min,
float  max,
int  numColors,
const float *  r,
const float *  g,
const float *  b,
const float *  a 
)

colorbar update

Parameters
mindata minimum
maxdata maximum
numColorsnumber of different colors in colorbar
rred colors
ggreen colors
bblue colors
ared colors

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