vrui::OSGVruiTexturedBackground Class Reference

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

#include <OSGVruiTexturedBackground.h>

Inheritance diagram for vrui::OSGVruiTexturedBackground:

Public Member Functions
	OSGVruiTexturedBackground (coTexturedBackground *background)
	Constructor. More...
virtual	~OSGVruiTexturedBackground ()
	Destructor. More...
virtual void	createGeometry ()
	create the geometry More...
virtual void	resizeGeometry ()
virtual void	update ()
virtual void	setEnabled (bool en)
	Set activation state of this background and all its children. More...
virtual void	setHighlighted (bool hl)
Public Member Functions inherited from vrui::OSGVruiUIContainer
	OSGVruiUIContainer (coUIContainer *container)
virtual	~OSGVruiUIContainer ()
Public Member Functions inherited from vrui::OSGVruiUIElement
	OSGVruiUIElement (coUIElement *element)
virtual	~OSGVruiUIElement ()
vruiTransformNode *	getDCS ()
Public Member Functions inherited from vrui::vruiUIElementProvider
	vruiUIElementProvider (coUIElement *element)
virtual	~vruiUIElementProvider ()
virtual void	createGeometry ()=0
virtual vruiTransformNode *	getDCS ()=0
virtual void	resizeGeometry ()=0
virtual void	setEnabled (bool)
virtual void	setHighlighted (bool)
virtual void	update ()
virtual float	getWidth () const
virtual float	getHeight () const
virtual float	getDepth () const

Protected Member Functions
void	createSharedLists ()
	create geometry elements shared by all OSGVruiTexturedBackgrounds More...
void	rescaleTexture ()
	resize the texture if texture width or height is set to 0 More...
void	createTexturesFromFiles ()
	create texture from files More...
void	createTexturesFromArrays (const uint *normalImage, const uint *highlightImage, const uint *disabledImage, int comp, int ns, int nt, int nr)
	create texture from arrays More...

Protected Attributes
coTexturedBackground *	background
coTexturedBackground::TextureSet *	tex
Protected Attributes inherited from vrui::OSGVruiUIContainer
coUIContainer *	container
Protected Attributes inherited from vrui::OSGVruiUIElement
OSGVruiTransformNode *	myDCS
	main DCS of this UI Element More...
Protected Attributes inherited from vrui::vruiUIElementProvider
coUIElement *	element

Detailed Description

This class provides background for GUI elements.

The color of this background changes according to the elements state (normal/highlighted/disabled) A background should contain only one child, use another container to layout multiple chlidren inside the frame.

Constructor & Destructor Documentation

OSGVruiTexturedBackground()

vrui::OSGVruiTexturedBackground::OSGVruiTexturedBackground

(

coTexturedBackground *

background

)

Constructor.

Parameters

backgroundMaterial	normal color
highlightMaterial	highlighted color
disableMaterial	disabled color

See also

coUIElement for color definition

~OSGVruiTexturedBackground()

vrui::OSGVruiTexturedBackground::~OSGVruiTexturedBackground ( )

virtual

Destructor.

Member Function Documentation

createGeometry()

void vrui::OSGVruiTexturedBackground::createGeometry ( )

virtual

create the geometry

Implements vrui::vruiUIElementProvider.

createSharedLists()

void vrui::OSGVruiTexturedBackground::createSharedLists ( )

protected

create geometry elements shared by all OSGVruiTexturedBackgrounds

createTexturesFromArrays()

void vrui::OSGVruiTexturedBackground::createTexturesFromArrays ( const uint *  normalImage, const uint *  highlightImage, const uint *  disabledImage, int  comp, int  ns, int  nt, int  nr  )

protected

create texture from arrays

createTexturesFromFiles()

void vrui::OSGVruiTexturedBackground::createTexturesFromFiles ( )

protected

create texture from files

rescaleTexture()

void vrui::OSGVruiTexturedBackground::rescaleTexture ( )

protected

resize the texture if texture width or height is set to 0

resizeGeometry()

void vrui::OSGVruiTexturedBackground::resizeGeometry ( )

virtual

Implements vrui::vruiUIElementProvider.

setEnabled()

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

virtual

Set activation state of this background and all its children.

if this background is disabled, the color is always the disabled color, regardless of the highlighted state

Parameters

en	true = elements enabled

Reimplemented from vrui::vruiUIElementProvider.

setHighlighted()

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

virtual

Reimplemented from vrui::vruiUIElementProvider.

update()

void vrui::OSGVruiTexturedBackground::update ( )

virtual

Reimplemented from vrui::vruiUIElementProvider.

Member Data Documentation

background

coTexturedBackground* vrui::OSGVruiTexturedBackground::background

protected

tex

coTexturedBackground::TextureSet* vrui::OSGVruiTexturedBackground::tex

protected

---

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

• OSGVruiTexturedBackground.h
• OSGVruiTexturedBackground.cpp