Menu item which is usable as a toggle button, a radio button, or a group of toggle buttons. More...

#include <coCheckboxMenuItem.h>

Inheritance diagram for vrui::coCheckboxMenuItem:

Public Member Functions
	coCheckboxMenuItem (const std::string &name, bool on, coCheckboxGroup *group=0)
	Constructor. More...

virtual	~coCheckboxMenuItem ()
	Destructor. More...

void	setState (bool newState, bool generateEvent, bool updateGroup=false)
	Set new checkbox state. More...

void	setState (bool newState)

bool	getState () const
	Get checkbox state. More...

coCheckboxGroup *	getGroup ()
	Get group this checkbox belongs to. More...

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

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

virtual void	selected (bool select)
	MenuItem is selected via joystick. More...

virtual void	doActionRelease ()
	Action is called via joystick. 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)
	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 ()
	Destructor. Removes this menu item from the parent menu. More...

virtual void	setLabel (coLabel *label)
	Set a new label for the menu item. More...

coLabel *	getLabel ()
	Get the current label. More...

void	setLabel (const std::string &labelString) override
	this function may be overloaded - it is called by setName() More...

coUIElement *	getUIElement () override
	return the actual UI Element that represents this menu. More...

const char *	getClassName () const override
	get the Element's classname More...

bool	isOfClassName (const char *) const override
	check if the Element or any ancestor is this classname More...

void	setActive (bool a) override
	activates or deactivates the item More...

void	selected (bool selected) override
	MenuItem is selected via joystick. More...

void	setVisible (bool visible) override
	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...

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::coButtonActor
virtual	~coButtonActor ()

virtual void	buttonEvent (coButton *button)=0

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 Member Functions
virtual void	buttonEvent (coButton *source)

Protected Attributes
coButton *	checkBox
	actual button which is used for interaction More...

coCheckboxGroup *	group
	checkbox group this checkbox belongs to More...

bool	myState

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

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

coLabel *	label
	label text 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 }

Static Protected Attributes inherited from vrui::coRowMenuItem
static const int	LEFTMARGIN = 30
	size of margin at left edge of menu item More...

Detailed Description

Menu item which is usable as a toggle button, a radio button, or a group of toggle buttons.

The usage type is detemined by:

for toggle buttons: no coCheckboxGroup assigned
for radio buttons: assign a coCheckboxGroup without an argument to its constructor
for grouped toggle buttons: assign a coCheckboxGroup with true as the argument to the constructor

Constructor & Destructor Documentation

◆ coCheckboxMenuItem()

vrui::coCheckboxMenuItem::coCheckboxMenuItem	(	const std::string &	name,
		bool	on,
		coCheckboxGroup *	group = `0`
	)

Constructor.

Parameters

name	displayed menu item text
defaultState	default checkbox state (true = checked)
cbg	checkbox group this element is to be added to. Defaults to NULL for independent checkbox.

◆ ~coCheckboxMenuItem()

vrui::coCheckboxMenuItem::~coCheckboxMenuItem ( )

virtual

Destructor.

Member Function Documentation

◆ buttonEvent()

void vrui::coCheckboxMenuItem::buttonEvent ( coButton * source )

protectedvirtual

Implements vrui::coButtonActor.

◆ doActionRelease()

void vrui::coCheckboxMenuItem::doActionRelease ( )

virtual

Action is called via joystick.

open or close Submenu

Reimplemented from vrui::coMenuItem.

◆ getClassName()

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

virtual

get the Element's classname

Reimplemented from vrui::coMenuItem.

◆ getGroup()

coCheckboxGroup * vrui::coCheckboxMenuItem::getGroup ( )

Get group this checkbox belongs to.

Returns: pointer to checkbox group

◆ getState()

bool vrui::coCheckboxMenuItem::getState ( ) const

Get checkbox state.

Returns: checkbox state (true = checked, false = unchecked)

◆ hit()

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

virtual

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

Returns: ACTION_CALL_ON_MISS

Implements vrui::coAction.

◆ isOfClassName()

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

virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coMenuItem.

◆ miss()

void vrui::coCheckboxMenuItem::miss ( )

virtual

Called when input device leaves the element.

Reimplemented from vrui::coAction.

◆ selected()

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

virtual

MenuItem is selected via joystick.

highlight the item

Reimplemented from vrui::coMenuItem.

◆ setActive()

void vrui::coCheckboxMenuItem::setActive ( bool a )

virtual

functions activates or deactivates the item

Reimplemented from vrui::coMenuItem.

◆ setState() [1/2]

void vrui::coCheckboxMenuItem::setState ( bool newState )

inline

◆ setState() [2/2]

void vrui::coCheckboxMenuItem::setState	(	bool	newState,
		bool	generateEvent,
		bool	updateGroup = `false`
	)

Set new checkbox state.

Parameters

newState	true = checked, false = unchecked
generateEvent	if true, a menuEvent is generated
updateGroup	if true, checkbox group members are updated accordingly, default false

Member Data Documentation

◆ checkBox

coButton* vrui::coCheckboxMenuItem::checkBox

protected

actual button which is used for interaction

◆ group

coCheckboxGroup* vrui::coCheckboxMenuItem::group

protected

checkbox group this checkbox belongs to

◆ myState

bool vrui::coCheckboxMenuItem::myState

protected

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

COVISE Online Documentation

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ coCheckboxMenuItem()

◆ ~coCheckboxMenuItem()

Member Function Documentation

◆ buttonEvent()

◆ doActionRelease()

◆ getClassName()

◆ getGroup()

◆ getState()

◆ hit()

◆ isOfClassName()

◆ miss()

◆ selected()

◆ setActive()

◆ setState() [1/2]

◆ setState() [2/2]

Member Data Documentation

◆ checkBox

◆ group

◆ myState