This class provides a coMenuItem which consists of a coValuePoti and a coLabel. More...

#include <coPotiToolboxItem.h>

Inheritance diagram for vrui::coPotiToolboxItem:

Public Member Functions
	coPotiToolboxItem (const std::string &symbolicName, float min, float max, float defaultValue, vruiCOIM *=0, const std::string &="")
	Constructor. More...

virtual	~coPotiToolboxItem ()
	Destructor. More...

void	setMax (float m)

void	setMin (float m)

void	setInteger (bool i)

void	setIncrement (float incr)

float	getValue () const
	Get current poti value. More...

int	hit (vruiHit *)
	This method is called on intersections of the input device with the poti Toolbox item. More...

void	miss ()
	Called when input device leaves the element. More...

virtual void	selected (bool)
	highlight the item More...

virtual void	doActionPress ()
	move slider to lower More...

virtual void	doSecondActionPress ()
	move slider to upper More...

virtual void	potiValueChanged (float, float, coValuePoti *, int context=-1)
	Calls the value changed listener (coValuePotiActor) when poti value was changed. More...

virtual void	potiPressed (coValuePoti *, int context=-1)
	Calls the value changed listener (coValuePotiActor) when button was pressed. More...

virtual void	potiReleased (coValuePoti *, int context=-1)
	Calls the value changed listener (coValuePotiActor) when button was released. 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...

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 coUIElement *	getUIElement ()
	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 coMenuListener *	getMenuListener ()
	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 coUIElement *	getUIElement ()
	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...

coMenu *	getParentMenu ()
	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::coValuePotiActor
virtual	~coValuePotiActor ()

virtual void	potiValueChanged (float oldValue, float newValue, coValuePoti *poti, int context=-1)=0
	Called whenever poti value was changed. More...

virtual void	potiPressed (coValuePoti *poti, int context=-1)

virtual void	potiReleased (coValuePoti *poti, int context=-1)

virtual int	getContext ()
	Get the current context, if one poti is used in different contexts (for collaborative use). More...

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
coValuePoti *	poti
	actual poti interactor More...

coLabel *	label

Protected Attributes inherited from vrui::coToolboxMenuItem
coMenuContainer *	menuContainer
	container to store menu elements More...

coColoredBackground *	background
	menu item background which changes its color when menu item is selected More...

Protected Attributes inherited from vrui::coMenuItem
bool	visible

coMenu *	myMenu
	parent menu which contains More...

coMenuListener *	listener
	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 }

Detailed Description

This class provides a coMenuItem which consists of a coValuePoti and a coLabel.

Constructor & Destructor Documentation

◆ coPotiToolboxItem()

vrui::coPotiToolboxItem::coPotiToolboxItem	(	const std::string &	symbolicName,
		float	min,
		float	max,
		float	defaultValue,
		vruiCOIM *	coim = `0`,
		const std::string &	idName = `""`
	)

Constructor.

Parameters

symbolicName	poti description text
min,max	minimum and maximum poti values
defaultValue	default poti value
coim	Covise interaction manager for collaborative usage (optional)
idName	unique ID string for collaboration (optional)

◆ ~coPotiToolboxItem()

vrui::coPotiToolboxItem::~coPotiToolboxItem ( )

virtual

Destructor.

Member Function Documentation

◆ doActionPress()

void vrui::coPotiToolboxItem::doActionPress ( )

virtual

move slider to lower

Reimplemented from vrui::coMenuItem.

◆ doSecondActionPress()

void vrui::coPotiToolboxItem::doSecondActionPress ( )

virtual

move slider to upper

Reimplemented from vrui::coMenuItem.

◆ getClassName()

const char * vrui::coPotiToolboxItem::getClassName ( ) const

virtual

get the Element's classname

Reimplemented from vrui::coToolboxMenuItem.

◆ getValue()

float vrui::coPotiToolboxItem::getValue ( ) const

Get current poti value.

Returns: current poti value

◆ hit()

int vrui::coPotiToolboxItem::hit ( vruiHit * hit )

virtual

This method is called on intersections of the input device with the poti Toolbox item.

Returns: ACTION_CALL_ON_MISS

Implements vrui::coAction.

◆ isOfClassName()

bool vrui::coPotiToolboxItem::isOfClassName ( const char * classname ) const

virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coToolboxMenuItem.

◆ miss()

void vrui::coPotiToolboxItem::miss ( )

virtual

Called when input device leaves the element.

Reimplemented from vrui::coAction.

◆ potiPressed()

void vrui::coPotiToolboxItem::potiPressed	(	coValuePoti *	,
		int	context = `-1`
	)

virtual

Calls the value changed listener (coValuePotiActor) when button was pressed.

Reimplemented from vrui::coValuePotiActor.

◆ potiReleased()

void vrui::coPotiToolboxItem::potiReleased	(	coValuePoti *	,
		int	context = `-1`
	)

virtual

Calls the value changed listener (coValuePotiActor) when button was released.

Reimplemented from vrui::coValuePotiActor.

◆ potiValueChanged()

void vrui::coPotiToolboxItem::potiValueChanged	(	float	,
		float	newValue,
		coValuePoti *	,
		int	context = `-1`
	)

virtual

Calls the value changed listener (coValuePotiActor) when poti value was changed.

Implements vrui::coValuePotiActor.

◆ selected()

void vrui::coPotiToolboxItem::selected ( bool select )

virtual

highlight the item

Reimplemented from vrui::coMenuItem.

◆ setIncrement()

void vrui::coPotiToolboxItem::setIncrement ( float incr )

◆ setInteger()

void vrui::coPotiToolboxItem::setInteger ( bool i )

◆ setMax()

void vrui::coPotiToolboxItem::setMax ( float m )

◆ setMin()

void vrui::coPotiToolboxItem::setMin ( float m )

Member Data Documentation

◆ label

coLabel* vrui::coPotiToolboxItem::label

protected

◆ poti

coValuePoti* vrui::coPotiToolboxItem::poti

protected

actual poti interactor

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

COVISE Online Documentation

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ coPotiToolboxItem()

◆ ~coPotiToolboxItem()

Member Function Documentation

◆ doActionPress()

◆ doSecondActionPress()

◆ getClassName()

◆ getValue()

◆ hit()

◆ isOfClassName()

◆ miss()

◆ potiPressed()

◆ potiReleased()

◆ potiValueChanged()

◆ selected()

◆ setIncrement()

◆ setInteger()

◆ setMax()

◆ setMin()

Member Data Documentation

◆ label

◆ poti