Menu item which can be used to open and close submenus menu events are generated when the user opens or closes the submenu In difference to a normal Menu subwindow, orientation (attachement) changes have to be handled properly. More...

#include <coSubMenuToolboxItem.h>

Inheritance diagram for vrui::coSubMenuToolboxItem:

Public Member Functions
	coSubMenuToolboxItem (const std::string &name)
	Constructor. More...

virtual	~coSubMenuToolboxItem ()
	Destructor. More...

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

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

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

virtual void	doActionRelease () override
	Action is called via joystick. More...

virtual void	setMenu (coMenu *menu) override
	set the submenu to handle. More...

virtual void	closeSubmenu () override
	Close the submenu. More...

virtual void	openSubmenu () override
	Open the submenu. More...

virtual void	setAttachment (int attachment) override=0
	sets the attachment border More...

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

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...

void	positionSubmenu () override

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::coGenericSubMenuItem
	coGenericSubMenuItem (coMenuItem *container)
	Constructor. More...

virtual	~coGenericSubMenuItem ()
	Destructor. More...

virtual void	setMenu (coMenu *menu)
	set the submenu to handle. More...

virtual void	closeSubmenu ()=0

virtual void	openSubmenu ()=0

virtual void	positionSubmenu ()=0

bool	isOpen () const
	Get menu state. More...

coMenu *	getMenu ()
	get my subMenu More...

Public Member Functions inherited from vrui::coRotButtonActor
virtual	~coRotButtonActor ()

virtual void	buttonEvent (coRotButton *button)=0
	Called whenever a button was pressed. 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
coRotButton *	subMenuIcon
	arrow button which is used for interaction More...

int	attachment

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::coGenericSubMenuItem
coMenu *	subMenu
	the subMenu which is opened and closed by thes button More...

bool	open
	current state of the menu (open or closed) More...

coMenuItem *	container_
	containing menu item 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

Menu item which can be used to open and close submenus menu events are generated when the user opens or closes the submenu In difference to a normal Menu subwindow, orientation (attachement) changes have to be handled properly.

Constructor & Destructor Documentation

◆ coSubMenuToolboxItem()

vrui::coSubMenuToolboxItem::coSubMenuToolboxItem ( const std::string & name )

Constructor.

Parameters

name	displayed menu item text

◆ ~coSubMenuToolboxItem()

vrui::coSubMenuToolboxItem::~coSubMenuToolboxItem ( )

virtual

Destructor.

Member Function Documentation

◆ closeSubmenu()

void vrui::coSubMenuToolboxItem::closeSubmenu ( )

overridevirtual

Close the submenu.

Implements vrui::coGenericSubMenuItem.

◆ doActionRelease()

void vrui::coSubMenuToolboxItem::doActionRelease ( )

overridevirtual

Action is called via joystick.

open or close Submenu

Reimplemented from vrui::coMenuItem.

◆ getClassName()

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

overridevirtual

get the Element's classname

Reimplemented from vrui::coToolboxMenuItem.

Reimplemented in vrui::coIconSubMenuToolboxItem, and vrui::coLabelSubMenuToolboxItem.

◆ hit()

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

overridevirtual

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

Returns: ACTION_CALL_ON_MISS

Implements vrui::coAction.

◆ isOfClassName()

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

overridevirtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coToolboxMenuItem.

Reimplemented in vrui::coIconSubMenuToolboxItem, and vrui::coLabelSubMenuToolboxItem.

◆ miss()

void vrui::coSubMenuToolboxItem::miss ( )

overridevirtual

Called when input device leaves the element.

Reimplemented from vrui::coAction.

◆ openSubmenu()

void vrui::coSubMenuToolboxItem::openSubmenu ( )

overridevirtual

Open the submenu.

Implements vrui::coGenericSubMenuItem.

◆ positionSubmenu()

void vrui::coSubMenuToolboxItem::positionSubmenu ( )

overridevirtual

Implements vrui::coGenericSubMenuItem.

◆ selected()

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

overridevirtual

MenuItem is selected via joystick.

highlight the item

Reimplemented from vrui::coMenuItem.

◆ setActive()

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

overridevirtual

functions activates or deactivates the item

Reimplemented from vrui::coToolboxMenuItem.

◆ setAttachment()

virtual void vrui::coSubMenuToolboxItem::setAttachment ( int )

overridepure virtual

sets the attachment border

Reimplemented from vrui::coMenuItem.

Implemented in vrui::coIconSubMenuToolboxItem, and vrui::coLabelSubMenuToolboxItem.

◆ setMenu()

void vrui::coSubMenuToolboxItem::setMenu ( coMenu * menu )

overridevirtual

set the submenu to handle.

Parameters

menu submenu

Reimplemented from vrui::coGenericSubMenuItem.

Member Data Documentation

◆ attachment

int vrui::coSubMenuToolboxItem::attachment

protected

◆ subMenuIcon

coRotButton* vrui::coSubMenuToolboxItem::subMenuIcon

protected

arrow button which is used for interaction

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

◆ coSubMenuToolboxItem()

◆ ~coSubMenuToolboxItem()

Member Function Documentation

◆ closeSubmenu()

◆ doActionRelease()

◆ getClassName()

◆ hit()

◆ isOfClassName()

◆ miss()

◆ openSubmenu()

◆ positionSubmenu()

◆ selected()

◆ setActive()

◆ setAttachment()

◆ setMenu()

Member Data Documentation

◆ attachment

◆ subMenuIcon