This class provides background for GUI elements. More...

#include <coBackground.h>

Inheritance diagram for vrui::coBackground:

Public Member Functions
	coBackground ()
	Constructor. More...

virtual	~coBackground ()
	Destructor. More...

virtual void	addElement (coUIElement *element)
	Appends a child to this container. More...

virtual void	removeElement (coUIElement *element)
	Removes a child from this container. More...

virtual float	getWidth () const
	There is no sense to make virtual functions inline... More...

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

virtual float	getDepth () const
	Get z axis object size. More...

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

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

virtual float	getZpos () const
	Get z position. More...

virtual void	setPos (float x, float y, float z=0)

virtual void	setWidth (float width)
	set the width of the background element explicitely More...

virtual void	setHeight (float height)
	set the height of the background element explicitely More...

virtual void	setDepth (float depth)
	set the depth of the background element explicitely More...

virtual void	setMinWidth (float minWidth)
	set the minimum width of the background element More...

virtual void	setMinHeight (float minHeight)
	set the minimum height of the background element More...

virtual void	setMinDepth (float minDepth)
	set the minimum depth of the background element More...

virtual void	setZOffset (float offset)
	Change the Z offset of the child, default is 5mm. More...

virtual void	setSize (float size)
	Set UI element size, use equal values for all dimensions. More...

virtual void	setSize (float nw, float nh, float nd)
	Set UI element size. More...

virtual void	setEnabled (bool enabled)
	Set activation state of this container and all its children. More...

virtual void	setHighlighted (bool highlighted)
	Set highlight state of this container and all its children. More...

virtual void	resizeToParent (float, float, float, bool shrink=true)
	This method is called by containers after they resized to allow children to adjust their geometry to the new parents' size Children must not call childResized() of their parent here, as this could lead to an infinite loop. More...

virtual void	shrinkToMin ()
	Shrinks itself! This includes shrinking all children. 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...

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

virtual	~coUIContainer ()
	Destructor. More...

virtual void	setEnabled (bool enabled)
	Set activation state of this container and all its children. More...

virtual void	setHighlighted (bool highlighted)
	Set highlight state of this container and all its children. More...

virtual void	resizeToParent (float x, float y, float z, bool shrink=true)
	This method is called by containers after they resized to allow children to adjust their geometry to the new parents' size Children must not call childResized() of their parent here, as this could lead to an infinite loop. More...

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

virtual void	addElement (coUIElement *element)
	Appends a child to this container. More...

virtual void	removeElement (coUIElement *element)
	Removes a child from this container. More...

virtual void	removeLastElement ()
	Removes a child from this container. More...

virtual void	showElement (coUIElement *element)
	Adds the specified element to the scenegraph. More...

void	setXAlignment (int a)
	set the alignment in X direction of the children More...

void	setYAlignment (int a)
	set the alignment in Y direction of the children More...

void	setZAlignment (int a)
	set the alignment in Z direction of the children 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...

float	getMaxH () const
	maximum size in H direction More...

float	getMaxW () const
	maximum size in W direction More...

float	getMaxD () const
	maximum size in D direction More...

float	getSumH () const
	sum of sizes in H direction More...

float	getSumW () const
	sum of sizes in W direction More...

float	getSumD () const
	sum of sizes in D direction More...

int	getSize ()

Public Member Functions inherited from vrui::coUIElement
	coUIElement ()

virtual	~coUIElement ()
	Destructor. More...

virtual void	createGeometry ()

virtual void	setParent (coUIContainer *)
	Set parent container. More...

virtual coUIContainer *	getParent ()
	Get parent container. More...

virtual void	setEnabled (bool enabled)
	Set activation state. More...

virtual void	setHighlighted (bool highlighted)
	Set highlight state. More...

virtual void	setVisible (bool visible)
	Set element visibility. More...

virtual bool	isEnabled () const
	Get activation state. More...

virtual bool	isHighlighted () const
	Get highlight state. More...

virtual bool	isVisible () const
	Get visibility state. More...

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

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

virtual float	getDepth () const
	Get z axis object size. More...

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

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

virtual float	getZpos () const
	Get z position. More...

virtual void	childResized (bool shrink=true)
	This method is called by children whenever they change their size Implementations of this method should call the childResized() of their parent container. More...

virtual void	resizeToParent (float, float, float, bool shrink=true)
	This method is called by containers after they resized to allow children to adjust their geometry to the new parents' size Children must not call childResized() of their parent here, as this could lead to an infinite loop. More...

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

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

virtual void	setSize (float, float, float)
	Set UI element size. More...

virtual void	setSize (float)
	Set UI element size, use equal values for all dimensions. More...

virtual float	getResizePref ()

virtual void	setUserData (coUIUserData *)
	Set the current userdata object. More...

virtual coUIUserData *	getUserData () const
	Returns the current userdata object. More...

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

Protected Member Functions
virtual void	resizeGeometry ()
	this method is called whenever the geometry of the background has to be recomputed More...

void	realign ()
	centers the child More...

virtual void	resizeGeometry ()

Protected Member Functions inherited from vrui::coUIElement
virtual void	resizeGeometry ()

virtual const vruiMatrix *	getTransformMatrix ()

Protected Attributes
float	myX
	Background position X. More...

float	myY
	Background position Y. More...

float	myZ
	Background position Z. More...

float	myWidth
	Background width. More...

float	myHeight
	Background height. More...

float	myDepth
	Background depth. More...

float	minWidth
	Background minimal width. More...

float	minHeight
	Background minimal height. More...

float	minDepth
	Background minimal depth. More...

float	myZOffset
	Z offset of child. More...

Protected Attributes inherited from vrui::coUIContainer
int	xAlignment
	alignment on children in X direction More...

int	yAlignment
	alignment on children in Y direction More...

int	zAlignment
	alignment on children in Z direction More...

std::list< coUIElement * >	elements
	List of children elements. More...

float	prefWidth
	try to get That high/wide if possible More...

float	prefHeight

Protected Attributes inherited from vrui::coUIElement
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

Additional Inherited Members
Public Types inherited from vrui::coUIContainer
enum	{ CENTER = 0 , MIN , MAX , BOTH }
	Alignment specification for children. More...

Public Types inherited from vrui::coUIElement
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 , BACKGROUND , NUM_MATERIALS }
	Color definitions, to be used whenever a material is needed. More...

enum	{ LEFT = 0 , TOP , RIGHT , BOTTOM , REPLACE }
	attachment order is counterclockwise like this and describes the side/border which the item is attached to! More...

Static Public Member Functions inherited from vrui::coUIElement
static vruiMatrix *	getMatrixFromPositionHprScale (float x, float y, float z, float h, float p, float r, float scale)
	Constructor. More...

Public Attributes inherited from vrui::coUIContainer
enum vrui::coUIContainer:: { ... }	alignments
	Alignment specification for children. More...

Public Attributes inherited from vrui::coUIElement
enum vrui::coUIElement:: { ... }	Attachments
	attachment order is counterclockwise like this and describes the side/border which the item is attached to! More...

Detailed Description

This class provides background for GUI elements.

A background should contain only one child, use another container to layout multiple chlidren inside the frame.

Constructor & Destructor Documentation

◆ coBackground()

vrui::coBackground::coBackground ( )

Constructor.

◆ ~coBackground()

vrui::coBackground::~coBackground ( )

virtual

Destructor.

Member Function Documentation

◆ addElement()

void vrui::coBackground::addElement ( coUIElement * el )

virtual

Appends a child to this container.

Parameters

el	element to add

Reimplemented from vrui::coUIContainer.

◆ getClassName()

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

virtual

get the Element's classname

Reimplemented from vrui::coUIContainer.

Reimplemented in vrui::coColoredBackground, vrui::coTexturedBackground, and vrui::coTextureRectBackground.

◆ getDepth()

float vrui::coBackground::getDepth ( ) const

virtual

Get z axis object size.

Returns: z axis object size

Reimplemented from vrui::coUIElement.

◆ getHeight()

float vrui::coBackground::getHeight ( ) const

virtual

Returns element height.

Implements vrui::coUIElement.

◆ getWidth()

float vrui::coBackground::getWidth ( ) const

virtual

There is no sense to make virtual functions inline...

Implements vrui::coUIElement.

◆ getXpos()

float vrui::coBackground::getXpos ( ) const

virtual

Returns element x position.

Implements vrui::coUIElement.

◆ getYpos()

float vrui::coBackground::getYpos ( ) const

virtual

Returns element y position.

Implements vrui::coUIElement.

◆ getZpos()

float vrui::coBackground::getZpos ( ) const

virtual

Get z position.

Returns: z position

Reimplemented from vrui::coUIElement.

◆ isOfClassName()

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

virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coUIContainer.

Reimplemented in vrui::coColoredBackground, vrui::coTexturedBackground, and vrui::coTextureRectBackground.

◆ realign()

void vrui::coBackground::realign ( )

protected

centers the child

◆ removeElement()

void vrui::coBackground::removeElement ( coUIElement * el )

virtual

Removes a child from this container.

Parameters

el	element to remove

Reimplemented from vrui::coUIContainer.

◆ resizeGeometry()

void vrui::coBackground::resizeGeometry ( )

protectedvirtual

this method is called whenever the geometry of the background has to be recomputed

Reimplemented from vrui::coUIContainer.

◆ resizeToParent()

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

virtual

This method is called by containers after they resized to allow children to adjust their geometry to the new parents' size Children must not call childResized() of their parent here, as this could lead to an infinite loop.

Derived elements do not have to implement this method.

Parameters

newWidth,newHeight,newDepth desired size

Reimplemented from vrui::coUIContainer.

◆ setDepth()

void vrui::coBackground::setDepth ( float f )

virtual

set the depth of the background element explicitely

Parameters

f new depth

◆ setEnabled()

void vrui::coBackground::setEnabled ( bool en )

virtual

Set activation state of this container and all its children.

Parameters

en	true = elements enabled

Reimplemented from vrui::coUIContainer.

Reimplemented in vrui::coTexturedBackground, vrui::coTextureRectBackground, and vrui::coColoredBackground.

◆ setHeight()

void vrui::coBackground::setHeight ( float f )

virtual

set the height of the background element explicitely

Parameters

f	new height

◆ setHighlighted()

void vrui::coBackground::setHighlighted ( bool hl )

virtual

Set highlight state of this container and all its children.

Parameters

hl	true = element highlighted

Reimplemented from vrui::coUIContainer.

Reimplemented in vrui::coColoredBackground, vrui::coTexturedBackground, and vrui::coTextureRectBackground.

◆ setMinDepth()

void vrui::coBackground::setMinDepth ( float f )

virtual

set the minimum depth of the background element

Parameters

f	minimum depth

◆ setMinHeight()

void vrui::coBackground::setMinHeight ( float f )

virtual

set the minimum height of the background element

Parameters

f	minimum height

◆ setMinWidth()

void vrui::coBackground::setMinWidth ( float f )

virtual

set the minimum width of the background element

Parameters

f	minimum width

◆ setPos()

void vrui::coBackground::setPos	(	float	x,
		float	y,
		float	z = `0`
	)

virtual

Implements vrui::coUIElement.

◆ setSize() [1/2]

void vrui::coBackground::setSize	(	float	xs,
		float	ys,
		float	zs
	)

virtual

Set UI element size.

Use different values for all dimensions.

Parameters

xs,ys,zs size = scaling factor for respective dimension (1 is default)

Reimplemented from vrui::coUIElement.

◆ setSize() [2/2]

void vrui::coBackground::setSize ( float s )

virtual

Set UI element size, use equal values for all dimensions.

Parameters

s	size = scaling factor (1 is default)

Reimplemented from vrui::coUIElement.

◆ setWidth()

void vrui::coBackground::setWidth ( float f )

virtual

set the width of the background element explicitely

Parameters

f new width

◆ setZOffset()

void vrui::coBackground::setZOffset ( float offset )

virtual

Change the Z offset of the child, default is 5mm.

Parameters

o	new Z offset

◆ shrinkToMin()

void vrui::coBackground::shrinkToMin ( )

virtual

Shrinks itself! This includes shrinking all children.

Reimplemented from vrui::coUIContainer.

Reimplemented in vrui::coTexturedBackground.

Member Data Documentation

◆ minDepth

float vrui::coBackground::minDepth

protected

Background minimal depth.

◆ minHeight

float vrui::coBackground::minHeight

protected

Background minimal height.

◆ minWidth

float vrui::coBackground::minWidth

protected

Background minimal width.

◆ myDepth

float vrui::coBackground::myDepth

protected

Background depth.

◆ myHeight

float vrui::coBackground::myHeight

protected

Background height.

◆ myWidth

float vrui::coBackground::myWidth

protected

Background width.

◆ myX

float vrui::coBackground::myX

protected

Background position X.

◆ myY

float vrui::coBackground::myY

protected

Background position Y.

◆ myZ

float vrui::coBackground::myZ

protected

Background position Z.

◆ myZOffset

float vrui::coBackground::myZOffset

protected

Z offset of child.

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

◆ coBackground()

◆ ~coBackground()

Member Function Documentation

◆ addElement()

◆ getClassName()

◆ getDepth()

◆ getHeight()

◆ getWidth()

◆ getXpos()

◆ getYpos()

◆ getZpos()

◆ isOfClassName()

◆ realign()

◆ removeElement()

◆ resizeGeometry()

◆ resizeToParent()

◆ setDepth()

◆ setEnabled()

◆ setHeight()

◆ setHighlighted()

◆ setMinDepth()

◆ setMinHeight()

◆ setMinWidth()

◆ setPos()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setWidth()

◆ setZOffset()

◆ shrinkToMin()

Member Data Documentation

◆ minDepth

◆ minHeight

◆ minWidth

◆ myDepth

◆ myHeight

◆ myWidth

◆ myX

◆ myY

◆ myZ

◆ myZOffset