OpenCOVER
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vrui::coUIContainer Class Reference

#include <coUIContainer.h>

Inheritance diagram for vrui::coUIContainer:
Inheritance graph
[legend]
Collaboration diagram for vrui::coUIContainer:
Collaboration graph
[legend]

Public Types

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 Member Functions

 coUIContainer ()
 
virtual ~coUIContainer ()
 
virtual void setEnabled (bool enabled)
 
virtual void setHighlighted (bool highlighted)
 
virtual void resizeToParent (float x, float y, float z, bool shrink=true)
 
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 ()
 
virtual void createGeometry ()
 
virtual void setParent (coUIContainer *)
 
virtual coUIContainergetParent ()
 
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 setPos (float, float, float)=0
 
virtual void setSize (float, float, float)
 
virtual void setSize (float)
 
virtual float getResizePref ()
 
virtual void setUserData (coUIUserData *)
 
virtual coUIUserDatagetUserData () const
 
virtual vruiTransformNodegetDCS ()
 
virtual vruiUIElementProvidergetUIElementProvider () 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
 

Public Attributes

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

Protected Member Functions

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

Protected Attributes

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

Member Enumeration Documentation

anonymous enum

Alignment specification for children.

Enumerator
CENTER 
MIN 
MAX 
BOTH 

Constructor & Destructor Documentation

vrui::coUIContainer::coUIContainer ( )
virtual vrui::coUIContainer::~coUIContainer ( )
virtual

Member Function Documentation

virtual void vrui::coUIContainer::addElement ( coUIElement element)
virtual

Appends a child to this container.

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

virtual const char* vrui::coUIContainer::getClassName ( ) const
virtual
float vrui::coUIContainer::getMaxD ( ) const

maximum size in D direction

float vrui::coUIContainer::getMaxH ( ) const

maximum size in H direction

float vrui::coUIContainer::getMaxW ( ) const

maximum size in W direction

int vrui::coUIContainer::getSize ( )
inline
float vrui::coUIContainer::getSumD ( ) const

sum of sizes in D direction

float vrui::coUIContainer::getSumH ( ) const

sum of sizes in H direction

float vrui::coUIContainer::getSumW ( ) const

sum of sizes in W direction

virtual bool vrui::coUIContainer::isOfClassName ( const char *  ) const
virtual
virtual void vrui::coUIContainer::removeElement ( coUIElement element)
virtual

Removes a child from this container.

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

virtual void vrui::coUIContainer::removeLastElement ( )
virtual

Removes a child from this container.

virtual void vrui::coUIContainer::resizeGeometry ( )
protectedvirtual

Reimplemented from vrui::coUIElement.

Reimplemented in vrui::coBackground.

virtual void vrui::coUIContainer::resizeToParent ( float  x,
float  y,
float  z,
bool  shrink = true 
)
virtual
virtual void vrui::coUIContainer::setEnabled ( bool  enabled)
virtual
virtual void vrui::coUIContainer::setHighlighted ( bool  highlighted)
virtual
void vrui::coUIContainer::setXAlignment ( int  a)

set the alignment in X direction of the children

void vrui::coUIContainer::setYAlignment ( int  a)

set the alignment in Y direction of the children

void vrui::coUIContainer::setZAlignment ( int  a)

set the alignment in Z direction of the children

virtual void vrui::coUIContainer::showElement ( coUIElement element)
virtual

Adds the specified element to the scenegraph.

Reimplemented in vrui::coPanel.

virtual void vrui::coUIContainer::shrinkToMin ( )
virtual

Member Data Documentation

enum { ... } vrui::coUIContainer::alignments

Alignment specification for children.

std::list<coUIElement *> vrui::coUIContainer::elements
protected

List of children elements.

float vrui::coUIContainer::prefHeight
protected
float vrui::coUIContainer::prefWidth
protected

try to get That high/wide if possible

int vrui::coUIContainer::xAlignment
protected

alignment on children in X direction

int vrui::coUIContainer::yAlignment
protected

alignment on children in Y direction

int vrui::coUIContainer::zAlignment
protected

alignment on children in Z direction


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