#include <coFrame.h>

Inheritance diagram for vrui::coFrame:

Collaboration diagram for vrui::coFrame:

Public Member Functions
	coFrame (const std::string &textureName="UI/Frame")

virtual	~coFrame ()

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

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

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

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

virtual float	getDepth () const

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

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

virtual float	getZpos () const

virtual float	getBorderWidth () const

virtual float	getBorderHeight () const

virtual const std::string &	getTextureName () const

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

virtual void	setWidth (float)

virtual void	setHeight (float)

virtual void	setDepth (float)

virtual void	setBorderWidth (float)

virtual void	setBorderHeight (float)

virtual void	setBorderDepth (float)

virtual void	setSize (float s)

virtual void	setSize (float nw, float nh, float nd)

virtual void	setBorder (float nw, float nh, float nd)

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

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

virtual void	fitToParent ()

virtual void	fitToChild ()

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 ()

virtual	~coUIContainer ()

virtual void	setEnabled (bool enabled)

virtual void	setHighlighted (bool highlighted)

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

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 ()

virtual void	createGeometry ()

virtual void	setParent (coUIContainer *)

virtual coUIContainer *	getParent ()

virtual void	setVisible (bool visible)

virtual bool	isEnabled () const

virtual bool	isHighlighted () const

virtual bool	isVisible () const

virtual void	childResized (bool shrink=true)

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

Protected Member Functions
void	realign ()

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

Protected Member Functions inherited from vrui::coUIElement
virtual const vruiMatrix *	getTransformMatrix ()

Protected Attributes
std::string	textureName
	name of the texture file More...

float	myX
	Frame position X. More...

float	myY
	Frame position Y. More...

float	myZ
	Frame position Z. More...

float	myWidth
	Frame width. More...

float	myHeight
	Frame height. More...

float	myDepth
	Frame depth. More...

float	bw
	Border width. More...

float	bh
	Border height. More...

float	bd
	Border depth. More...

bool	fitParent
	wether to fit the frame to its parent or 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, NUM_MATERIALS }
	Color definitions, to be used whenever a material is needed. More...

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

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

Detailed Description

This class provides a flat textured frame arround objects. A frame should contain only one child, use another container to layout multiple chlidren inside the frame. A frame can be configured to fit tight around its child or to maximize its size to always fit into its parent container

Constructor & Destructor Documentation

vrui::coFrame::coFrame ( const std::string & textureName = "UI/Frame" )

virtual vrui::coFrame::~coFrame ( )

virtual

Member Function Documentation

virtual void vrui::coFrame::addElement ( coUIElement * element )

virtual

Appends a child to this container.

Reimplemented from vrui::coUIContainer.

virtual void vrui::coFrame::fitToChild ( )

virtual

virtual void vrui::coFrame::fitToParent ( )

virtual

virtual float vrui::coFrame::getBorderHeight ( ) const

inlinevirtual

virtual float vrui::coFrame::getBorderWidth ( ) const

inlinevirtual

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

virtual

get the Element's classname

Reimplemented from vrui::coUIContainer.

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

inlinevirtual

Reimplemented from vrui::coUIElement.

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

inlinevirtual

Returns element height.

Implements vrui::coUIElement.

virtual const std::string& vrui::coFrame::getTextureName ( ) const

inlinevirtual

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

inlinevirtual

Returns element width.

Implements vrui::coUIElement.

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

inlinevirtual

Returns element x position.

Implements vrui::coUIElement.

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

inlinevirtual

Returns element y position.

Implements vrui::coUIElement.

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

inlinevirtual

Reimplemented from vrui::coUIElement.

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

virtual

check if the Element or any ancestor is this classname

Reimplemented from vrui::coUIContainer.

void vrui::coFrame::realign ( )

protected

virtual void vrui::coFrame::removeElement ( coUIElement * element )

virtual

Removes a child from this container.

Reimplemented from vrui::coUIContainer.

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

virtual

Reimplemented from vrui::coUIContainer.

virtual void vrui::coFrame::setBorder	(	float	nw,
		float	nh,
		float	nd
	)

virtual

virtual void vrui::coFrame::setBorderDepth ( float )

virtual

virtual void vrui::coFrame::setBorderHeight ( float )

virtual

virtual void vrui::coFrame::setBorderWidth ( float )

virtual

virtual void vrui::coFrame::setDepth ( float )

virtual

virtual void vrui::coFrame::setHeight ( float )

virtual

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

virtual

Implements vrui::coUIElement.

virtual void vrui::coFrame::setSize ( float s )

virtual

Reimplemented from vrui::coUIElement.

virtual void vrui::coFrame::setSize	(	float	nw,
		float	nh,
		float	nd
	)

virtual

Reimplemented from vrui::coUIElement.

virtual void vrui::coFrame::setWidth ( float )

virtual

virtual void vrui::coFrame::shrinkToMin ( )

virtual

Set element location in space.

Reimplemented from vrui::coUIContainer.

Member Data Documentation

float vrui::coFrame::bd

protected

Border depth.

float vrui::coFrame::bh

protected

Border height.

float vrui::coFrame::bw

protected

Border width.

bool vrui::coFrame::fitParent

protected

wether to fit the frame to its parent or child

float vrui::coFrame::myDepth

protected

Frame depth.

float vrui::coFrame::myHeight

protected

Frame height.

float vrui::coFrame::myWidth

protected

Frame width.

float vrui::coFrame::myX

protected

Frame position X.

float vrui::coFrame::myY

protected

Frame position Y.

float vrui::coFrame::myZ

protected

Frame position Z.

std::string vrui::coFrame::textureName

protected

name of the texture file

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

OpenVRUI/coFrame.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation