#include <coUIElement.h>

Inheritance diagram for vrui::coUIElement:

Collaboration diagram for vrui::coUIElement:

Public Types
enum	Material { RED = 0, GREEN, BLUE, YELLOW, GREY, WHITE, BLACK, DARK_YELLOW, WHITE_NL, ITEM_BACKGROUND_NORMAL, ITEM_BACKGROUND_HIGHLIGHTED, ITEM_BACKGROUND_DISABLED, HANDLE_BACKGROUND_NORMAL, HANDLE_BACKGROUND_HIGHLIGHTED, HANDLE_BACKGROUND_DISABLED, NUM_MATERIALS }
	Color definitions, to be used whenever a material is needed. More...

enum	{ LEFT = 0, TOP, RIGHT, BOTTOM, REPLACE }

Public Member Functions
	coUIElement ()

virtual	~coUIElement ()

virtual void	createGeometry ()

virtual void	setParent (coUIContainer *)

virtual coUIContainer *	getParent ()

virtual void	setEnabled (bool enabled)

virtual void	setHighlighted (bool highlighted)

virtual void	setVisible (bool visible)

virtual bool	isEnabled () const

virtual bool	isHighlighted () const

virtual bool	isVisible () const

virtual float	getWidth () const =0
	Returns element width. More...

virtual float	getHeight () const =0
	Returns element height. More...

virtual float	getDepth () const

virtual float	getXpos () const =0
	Returns element x position. More...

virtual float	getYpos () const =0
	Returns element y position. More...

virtual float	getZpos () const

virtual void	childResized (bool shrink=true)

virtual void	resizeToParent (float, float, float, bool shrink=true)

virtual void	shrinkToMin ()
	Set element location in space. More...

virtual void	setPos (float, float, float)=0

virtual void	setSize (float, float, float)

virtual void	setSize (float)

virtual float	getResizePref ()

virtual void	setUserData (coUIUserData *)

virtual coUIUserData *	getUserData () const

virtual vruiTransformNode *	getDCS ()

virtual vruiUIElementProvider *	getUIElementProvider () const

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

virtual int	getAttachment () const
	returns the attachment border More...

void	setUniqueName (const char *)

const char *	getUniqueName () 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...

Public Attributes
enum vrui::coUIElement:: { ... }	Attachments

Protected Member Functions
virtual void	resizeGeometry ()

virtual const vruiMatrix *	getTransformMatrix ()

Protected Attributes
float	xScaleFactor
	UI element x axis scale factor. More...

float	yScaleFactor
	UI element y axis scale factor. More...

float	zScaleFactor
	UI element z axis scale factor. More...

bool	enabled
	true if UI element is enabled, false if UI element cannot be used More...

bool	highlighted
	true if highlighted More...

bool	visible
	true if UI element is visible, false if not visible but still present in scene tree More...

vruiUIElementProvider *	uiElementProvider

Detailed Description

Basic VRUI GUI element. This class provides functionality for all VRUI elements like position, size, font, visibility, availability, parent, etc.
At least this class should be subclassed for any new GUI element types.
All inheritable functions are defined virtual so that they can be overwritten by subclasses.

Member Enumeration Documentation

anonymous enum

attachment order is counterclockwise like this and describes the side/border which the item is attached to!

Enumerator
LEFT
TOP
RIGHT
BOTTOM
REPLACE

enum vrui::coUIElement::Material

Color definitions, to be used whenever a material is needed.

Enumerator
RED
GREEN
BLUE
YELLOW
GREY
WHITE
BLACK
DARK_YELLOW
WHITE_NL	self illuminated white (NL = no lighting)
ITEM_BACKGROUND_NORMAL
ITEM_BACKGROUND_HIGHLIGHTED
ITEM_BACKGROUND_DISABLED
HANDLE_BACKGROUND_NORMAL
HANDLE_BACKGROUND_HIGHLIGHTED
HANDLE_BACKGROUND_DISABLED
NUM_MATERIALS	this entry must always be the last one in the list

Constructor & Destructor Documentation

vrui::coUIElement::coUIElement ( )

virtual vrui::coUIElement::~coUIElement ( )

virtual

Member Function Documentation

virtual void vrui::coUIElement::childResized ( bool shrink = true )

virtual

virtual void vrui::coUIElement::createGeometry ( )

virtual

Reimplemented in vrui::coButton, vrui::coRotButton, vrui::coRowMenuHandle, and vrui::coPopupHandle.

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

inlinevirtual

returns the attachment border

Reimplemented in vrui::coRowContainer.

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

virtual

virtual vruiTransformNode* vrui::coUIElement::getDCS ( )

virtual

Reimplemented in vrui::coRotButton, vrui::coButton, vrui::coPanel, and vrui::coRowContainer.

virtual float vrui::coUIElement::getDepth ( ) const

virtual

Reimplemented in vrui::coLabel, vrui::coRowContainer, vrui::coFrame, and vrui::coBackground.

virtual float vrui::coUIElement::getHeight ( ) const

pure virtual

Returns element height.

Implemented in vrui::coValuePoti, vrui::coSlider, vrui::coRotButton, vrui::coButton, vrui::coPanel, vrui::coLabel, vrui::coRowContainer, vrui::coFrame, and vrui::coBackground.

virtual coUIContainer* vrui::coUIElement::getParent ( )

virtual

virtual float vrui::coUIElement::getResizePref ( )

inlinevirtual

virtual const vruiMatrix* vrui::coUIElement::getTransformMatrix ( )

protectedvirtual

virtual vruiUIElementProvider* vrui::coUIElement::getUIElementProvider ( ) const

inlinevirtual

const char* vrui::coUIElement::getUniqueName ( ) const

virtual coUIUserData* vrui::coUIElement::getUserData ( ) const

virtual

virtual float vrui::coUIElement::getWidth ( ) const

pure virtual

Returns element width.

Implemented in vrui::coValuePoti, vrui::coSlider, vrui::coRotButton, vrui::coButton, vrui::coPanel, vrui::coLabel, vrui::coRowContainer, vrui::coFrame, and vrui::coBackground.

virtual float vrui::coUIElement::getXpos ( ) const

pure virtual

Returns element x position.

Implemented in vrui::coValuePoti, vrui::coSlider, vrui::coRotButton, vrui::coLabel, vrui::coRowContainer, vrui::coButton, vrui::coPanel, vrui::coFrame, and vrui::coBackground.

virtual float vrui::coUIElement::getYpos ( ) const

pure virtual

Returns element y position.

Implemented in vrui::coValuePoti, vrui::coSlider, vrui::coRotButton, vrui::coLabel, vrui::coRowContainer, vrui::coButton, vrui::coPanel, vrui::coFrame, and vrui::coBackground.

virtual float vrui::coUIElement::getZpos ( ) const

virtual

Reimplemented in vrui::coSlider, vrui::coRotButton, vrui::coLabel, vrui::coRowContainer, vrui::coButton, vrui::coPanel, vrui::coFrame, and vrui::coBackground.

virtual bool vrui::coUIElement::isEnabled ( ) const

virtual

virtual bool vrui::coUIElement::isHighlighted ( ) const

virtual

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

virtual

check if the Element or any ancestor is this classname

Reimplemented in vrui::coSlopePoti, vrui::coTextureRectBackground, vrui::coTexturedBackground, vrui::coValuePoti, vrui::coRotToggleButton, vrui::coToggleButton, vrui::coRotPushButton, vrui::coPushButton, vrui::coSlider, vrui::coLabel, vrui::coFrame, vrui::coRotButton, vrui::coRowContainer, vrui::coButton, vrui::coPanel, vrui::coRowMenuHandle, vrui::coToolboxMenuHandle, vrui::coPopupHandle, vrui::coBackground, vrui::coUIContainer, vrui::coProgressBar, vrui::coColoredBackground, and vrui::coMenuContainer.

virtual bool vrui::coUIElement::isVisible ( ) const

virtual

virtual void vrui::coUIElement::resizeGeometry ( )

protectedvirtual

Reimplemented in vrui::coLabel, vrui::coButton, vrui::coRotButton, vrui::coUIContainer, and vrui::coBackground.

virtual void vrui::coUIElement::resizeToParent	(	float	,
		float	,
		float	,
		bool	shrink = `true`
	)

virtual

Reimplemented in vrui::coFrame, vrui::coRowMenuHandle, vrui::coBackground, vrui::coPopupHandle, vrui::coProgressBar, vrui::coUIContainer, vrui::coRowContainer, and vrui::coMenuContainer.

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

inlinevirtual

sets the attachment border

Reimplemented in vrui::coRowContainer.

virtual void vrui::coUIElement::setEnabled ( bool enabled )

virtual

Reimplemented in vrui::coValuePoti, vrui::coTexturedBackground, vrui::coTextureRectBackground, vrui::coBackground, vrui::coUIContainer, and vrui::coColoredBackground.

virtual void vrui::coUIElement::setHighlighted ( bool highlighted )

virtual

Reimplemented in vrui::coTexturedBackground, vrui::coTextureRectBackground, vrui::coLabel, vrui::coSlider, vrui::coBackground, vrui::coUIContainer, and vrui::coColoredBackground.

virtual void vrui::coUIElement::setParent ( coUIContainer * )

virtual

virtual void vrui::coUIElement::setPos	(	float	,
		float	,
		float
	)

pure virtual

Implemented in vrui::coValuePoti, vrui::coFrame, vrui::coSlider, vrui::coRotButton, vrui::coPanel, vrui::coButton, vrui::coLabel, vrui::coRowContainer, and vrui::coBackground.

virtual void vrui::coUIElement::setSize	(	float	,
		float	,
		float
	)

virtual

Reimplemented in vrui::coValuePoti, vrui::coFrame, vrui::coSlider, vrui::coButton, vrui::coRotButton, vrui::coLabel, and vrui::coBackground.

virtual void vrui::coUIElement::setSize ( float )

virtual

Reimplemented in vrui::coValuePoti, vrui::coFrame, vrui::coSlider, vrui::coButton, vrui::coRotButton, vrui::coLabel, and vrui::coBackground.

void vrui::coUIElement::setUniqueName ( const char * )

virtual void vrui::coUIElement::setUserData ( coUIUserData * )

virtual

virtual void vrui::coUIElement::setVisible ( bool visible )

virtual

virtual void vrui::coUIElement::shrinkToMin ( )

virtual

Set element location in space.

Reimplemented in vrui::coTexturedBackground, vrui::coFrame, vrui::coRowMenuHandle, vrui::coBackground, vrui::coPopupHandle, vrui::coUIContainer, and vrui::coRowContainer.

Member Data Documentation

enum { ... } vrui::coUIElement::Attachments

attachment order is counterclockwise like this and describes the side/border which the item is attached to!

bool vrui::coUIElement::enabled

protected

true if UI element is enabled, false if UI element cannot be used

bool vrui::coUIElement::highlighted

protected

true if highlighted

vruiUIElementProvider* vrui::coUIElement::uiElementProvider

protected

bool vrui::coUIElement::visible

protected

true if UI element is visible, false if not visible but still present in scene tree

float vrui::coUIElement::xScaleFactor

protected

UI element x axis scale factor.

float vrui::coUIElement::yScaleFactor

protected

UI element y axis scale factor.

float vrui::coUIElement::zScaleFactor

protected

UI element z axis scale factor.

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

OpenVRUI/coUIElement.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation