#include <coToolboxMenu.h>

Inheritance diagram for vrui::coToolboxMenu:

Collaboration diagram for vrui::coToolboxMenu:

Public Member Functions
	coToolboxMenu (const std::string &name="Toolbox", coMenu *parent=0, coRowContainer::Orientation orientation=coRowContainer::HORIZONTAL, int attachment=coUIElement::BOTTOM, int maxItems=0)
	handle More...

virtual	~coToolboxMenu ()

void	add (coMenuItem *)

void	insert (coMenuItem *, int)

void	remove (coMenuItem *)

void	removeAll ()

int	getItemCount () const

virtual void	setScale (float s)
	Sets the menu size by applying a scaling factor to the default size. More...

virtual float	getScale () const
	Gets the current scaling factor. More...

virtual void	setTransformMatrix (vruiMatrix *mat)

virtual void	setTransformMatrix (vruiMatrix *mat, float scale)

virtual void	setVisible (bool newState)

vruiTransformNode *	getDCS ()
	Get Transformation Node. More...

virtual coUIElement *	getUIElement ()

virtual void	buttonEvent (coButton *)

bool	update ()

void	show ()
	makes the menu visible More...

void	hide ()
	hides this menu More...

virtual void	setAttachment (int)

virtual int	getAttachment () const

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

void	fixPos (bool doFix)
	fix mmy menu's position More...

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

virtual void	makeVisible (coMenuItem *item)
	makes the item visible for joystick interaction More...

Public Member Functions inherited from vrui::coMenu
	coMenu (coMenu *parentMenu, const std::string &name)

virtual	~coMenu ()
	Sets the matrix which defines location and orientation. More...

virtual void	setMenuListener (coMenuFocusListener *listener)

virtual int	hit (vruiHit *hit)

virtual void	miss ()

virtual void	positionAllSubmenus ()
	reposition all submenus, for example after the main menu was repositioned with setTransform matrix More...

virtual void	closeMenu ()

virtual void	doActionPress ()
	Action is called via joystick. More...

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

virtual void	doSecondActionPress ()
	Action is called via joystick. More...

virtual void	doSecondActionRelease ()
	Action is called via joystick. More...

virtual bool	isInteractionActive () const

coCombinedButtonInteraction *	getInteraction () const

coCombinedButtonInteraction *	getMoveInteraction () const

void	setShowMode (int mode)

int	getShowMode () const

virtual void	setSubMenuItem (coGenericSubMenuItem *item)

coGenericSubMenuItem *	getSubMenuItem ()

void	closeAllOtherMenus (coMenuItem *leave=0)
	close all menus: optionally leave one open More...

void	removeAllAfter (coMenuItem *last)
	remove all items behind a given one More...

bool	isVisible () const
	check whether menu is currently visible More...

const char *	getName () const
	get my menu's name More...

coMenuItemVector	getAllItems ()

coMenuItem *	getItemByName (const char *name)

int	index (const coMenuItem *item)

void	setParent (coMenu *newParent)

const coMenu *	getParent ()

bool	wasMoved () const

void	setMoved (bool flag)

Public Member Functions inherited from vrui::coAction
	coAction ()
	Constructor. More...

virtual	~coAction ()
	Destructor. 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...

Public Member Functions inherited from vrui::coUpdateable
	coUpdateable ()
	Constructor. More...

virtual	~coUpdateable ()
	Destructor. More...

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

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

virtual void	menuPressEvent (coMenuItem *menuItem)

virtual void	menuReleaseEvent (coMenuItem *menuItem)

Protected Attributes
coRowContainer *	itemsContainer
	menu items (anything below title bar) More...

coFrame *	itemsFrame

coToolboxMenuHandle *	handle
	surrounding frame More...

Protected Attributes inherited from vrui::coMenu
std::list< coMenuItem * >	items
	list of menu items which can be accessed from this menu More...

coMenu *	parent
	parent menu, NULL if this is the topmost menu More...

coGenericSubMenuItem *	myMenuItem

coMenuFocusListener *	listener
	menu event listener, triggered on menu selection More...

int	showMode
	how to show and hide this Menu More...

bool	visible

std::string	name

coCombinedButtonInteraction *	interaction

coCombinedButtonInteraction *	moveInteraction

coCombinedButtonInteraction *	wheelInteraction
	interaction for preventing accidental global wheel interaction More...

float	scale_

vruiMatrix *	matrix_

int	attachment_

bool	wasMoved_ = false

Protected Attributes inherited from vrui::coAction
std::string	actionName

Additional Inherited Members
Public Types inherited from vrui::coMenu
enum	{ MENU_ONOFF = 0, MENU_SLIDE }

Public Types inherited from vrui::coAction
enum	Result { ACTION_DONE = 0x00, ACTION_CALL_ON_MISS = 0x01, ACTION_UNDEF = 0x02 }

Detailed Description

A Toolbox Menu contains Toolbox Menu Item and offers different organization modes (horizontal or vertical) The Handle, Items and submenus are organized respectively to this setting.

Constructor & Destructor Documentation

vrui::coToolboxMenu::coToolboxMenu	(	const std::string &	name = `"Toolbox"`,
		coMenu *	parent = `0`,
		coRowContainer::Orientation	orientation = `coRowContainer::HORIZONTAL`,
		int	attachment = `coUIElement::BOTTOM`,
		int	maxItems = `0`
	)

handle

virtual vrui::coToolboxMenu::~coToolboxMenu ( )

virtual

Member Function Documentation

void vrui::coToolboxMenu::add ( coMenuItem * )

virtual

Reimplemented from vrui::coMenu.

virtual void vrui::coToolboxMenu::buttonEvent ( coButton * )

inlinevirtual

Implements vrui::coButtonActor.

void vrui::coToolboxMenu::fixPos ( bool doFix )

fix mmy menu's position

virtual int vrui::coToolboxMenu::getAttachment ( ) const

virtual

Reimplemented from vrui::coMenu.

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

virtual

get the Element's classname

Reimplemented from vrui::coMenu.

vruiTransformNode* vrui::coToolboxMenu::getDCS ( )

virtual

Get Transformation Node.

Implements vrui::coMenu.

int vrui::coToolboxMenu::getItemCount ( ) const

virtual

Reimplemented from vrui::coMenu.

virtual float vrui::coToolboxMenu::getScale ( ) const

virtual

Gets the current scaling factor.

Implements vrui::coMenu.

virtual coUIElement* vrui::coToolboxMenu::getUIElement ( )

virtual

Reimplemented from vrui::coMenu.

void vrui::coToolboxMenu::hide ( )

virtual

hides this menu

Implements vrui::coMenu.

void vrui::coToolboxMenu::insert	(	coMenuItem *	,
		int
	)

virtual

Reimplemented from vrui::coMenu.

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

virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coMenu.

virtual void vrui::coToolboxMenu::makeVisible ( coMenuItem * item )

virtual

makes the item visible for joystick interaction

Reimplemented from vrui::coMenu.

void vrui::coToolboxMenu::remove ( coMenuItem * )

virtual

Reimplemented from vrui::coMenu.

void vrui::coToolboxMenu::removeAll ( )

virtual

Reimplemented from vrui::coMenu.

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

virtual

Menu is selected via joystick.

Reimplemented from vrui::coMenu.

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

virtual

Reimplemented from vrui::coMenu.

virtual void vrui::coToolboxMenu::setScale ( float s )

virtual

Sets the menu size by applying a scaling factor to the default size.

Implements vrui::coMenu.

virtual void vrui::coToolboxMenu::setTransformMatrix ( vruiMatrix * mat )

virtual

Implements vrui::coMenu.

virtual void vrui::coToolboxMenu::setTransformMatrix	(	vruiMatrix *	matrix,
		float	scale
	)

virtual

of the menu. Sets the matrix which defines location orientation and scale of the menu and the scale factor included in the matrix.

Implements vrui::coMenu.

virtual void vrui::coToolboxMenu::setVisible ( bool newState )

virtual

Reimplemented from vrui::coMenu.

void vrui::coToolboxMenu::show ( )

virtual

makes the menu visible

Implements vrui::coMenu.

bool vrui::coToolboxMenu::update ( )

virtual

this method is called once per frame as long as it returns true. as soon as it returns false, it is removed from the update manager and not called again. the update method is called prior to preFrame();

Implements vrui::coUpdateable.