#include <coCheckboxMenuItem.h>

Inheritance diagram for vrui::coCheckboxMenuItem:

[legend]

Collaboration diagram for vrui::coCheckboxMenuItem:

[legend]

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

virtual	~coCheckboxMenuItem ()

void	setState (bool newState, bool generateEvent, bool updateGroup=false)

void	setState (bool newState)

bool	getState () const

coCheckboxGroup *	getGroup ()

int	hit (vruiHit *hit)

void	miss ()

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 ()

virtual void	setLabel (coLabel *label)

coLabel *	getLabel ()

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

coUIElement *	getUIElement () override

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

Public Member Functions inherited from vrui::coMenuItem
	coMenuItem (const std::string &name)

virtual	~coMenuItem ()

virtual void	setMenuListener (coMenuListener *listener)

virtual coMenuListener *	getMenuListener ()

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

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

virtual void	miss ()

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
	this menu item More...

coMenuListener *	listener
	on menu selection More...

std::string	myName
	symbolic name, or displayed as label) 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

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`
	)

◆ ~coCheckboxMenuItem()

virtual vrui::coCheckboxMenuItem::~coCheckboxMenuItem ( )

virtual

Member Function Documentation

◆ buttonEvent()

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

protectedvirtual

Implements vrui::coButtonActor.

Reimplemented in opencover::VruiPartnerMenuItem.

◆ doActionRelease()

virtual void vrui::coCheckboxMenuItem::doActionRelease ( )

virtual

Action is called via joystick.

Reimplemented from vrui::coMenuItem.

◆ getClassName()

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

virtual

get the Element's classname

Reimplemented from vrui::coMenuItem.

Reimplemented in opencover::VruiPartnerMenuItem.

◆ getGroup()

coCheckboxGroup * vrui::coCheckboxMenuItem::getGroup ( )

◆ getState()

bool vrui::coCheckboxMenuItem::getState ( ) const

◆ hit()

int vrui::coCheckboxMenuItem::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.

◆ isOfClassName()

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

virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coMenuItem.

Reimplemented in opencover::VruiPartnerMenuItem.

◆ miss()

void vrui::coCheckboxMenuItem::miss ( )

virtual

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

Reimplemented from vrui::coAction.

◆ selected()

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

virtual

MenuItem is selected via joystick.

Reimplemented from vrui::coMenuItem.

◆ setActive()

virtual 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`
	)

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 file:

OpenVRUI/coCheckboxMenuItem.h

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