Tulip  4.0.0
Better Visualization Through Research
 All Classes Files Functions Variables Enumerations Enumerator Properties Groups Pages
tlp::GlBox Class Reference

#include <GlBox.h>

Inherits tlp::GlSimpleEntity.

Public Member Functions

 GlBox ()
 
 GlBox (const Coord &position, const Size &size, const Color &fillColor, const Color &outlineColor, bool filled=true, bool outlined=true, const std::string &textureName="", float outlineSize=1.)
 
virtual ~GlBox ()
 
virtual void draw (float lod, Camera *camera)
 
Color getFillColor () const
 
Color getOutlineColor () const
 
float getOutlineSize () const
 
Coord * getPosition () const
 
Size getSize () const
 
std::string getTextureName () const
 
virtual void getXML (std::string &outString)
 
void setFillColor (const Color &color)
 
void setOutlineColor (const Color &color)
 
void setOutlineSize (float size)
 
void setPosition (const Coord &position)
 
void setSize (const Size &size)
 
void setTextureName (const std::string &textureName)
 
virtual void setWithXML (const std::string &inString, unsigned int &currentPosition)
 
virtual void translate (const Coord &mouvement)
 
- Public Member Functions inherited from tlp::GlSimpleEntity
 GlSimpleEntity ()
 
virtual ~GlSimpleEntity ()
 
virtual BoundingBox getBoundingBox ()
 
int getStencil ()
 
bool isVisible () const
 
virtual void setStencil (int stencil)
 
virtual void setVisible (bool visible)
 

Protected Member Functions

virtual void clearGenerated ()
 

Protected Attributes

GLuint buffers [5]
 
std::vector< Color > fillColors
 
bool filled
 
bool generated
 
float * newCubeCoordArrays
 
std::vector< Color > outlineColors
 
bool outlined
 
float outlineSize
 
Coord position
 
Size size
 
std::string textureName
 
- Protected Attributes inherited from tlp::GlSimpleEntity
BoundingBox boundingBox
 
std::vector< GlComposite * > parents
 
int stencil
 
bool visible
 

Detailed Description

General class used to render boxes as GlSimpleEntity.

Definition at line 35 of file GlBox.h.

Constructor & Destructor Documentation

tlp::GlBox::GlBox ( )

Don't use this constructor.

tlp::GlBox::GlBox ( const Coord &  position,
const Size &  size,
const Color &  fillColor,
const Color &  outlineColor,
bool  filled = true,
bool  outlined = true,
const std::string &  textureName = "",
float  outlineSize = 1. 
)

Constructor.

Parameters
positionThe center of the box.
sizeThe length of each dimension of the box.
fillColorThe fill color of the box.
outlineColorThe outline color of the box
filledFill the box ?
outlinedoutline the box ?
outlineSizeThe size of the outline
virtual tlp::GlBox::~GlBox ( )
virtual

Destructor.

Member Function Documentation

virtual void tlp::GlBox::draw ( float  lod,
Camera camera 
)
virtual

Draw function.

Warning
You don't have to call this function, the Tulip OpenGL engine call it.

Implements tlp::GlSimpleEntity.

Color tlp::GlBox::getFillColor ( ) const

Accessor in reading to the fill color.

Color tlp::GlBox::getOutlineColor ( ) const

Accessor in reading to the outline color.

float tlp::GlBox::getOutlineSize ( ) const

Accessor in reading to the outline size.

Coord* tlp::GlBox::getPosition ( ) const

Accessor in reading to the position.

Size tlp::GlBox::getSize ( ) const

Accessor in reading to the size.

std::string tlp::GlBox::getTextureName ( ) const

Accessor in reading to the texture name.

virtual void tlp::GlBox::getXML ( std::string &  outString)
virtual

Function to export data in outString (in XML format)

Implements tlp::GlSimpleEntity.

void tlp::GlBox::setFillColor ( const Color &  color)

Accessor in writing to the fill color of the box.

void tlp::GlBox::setOutlineColor ( const Color &  color)

Accessor in writing to the outline color of the box.

void tlp::GlBox::setOutlineSize ( float  size)

Accessor in writing to the outline size of the box.

void tlp::GlBox::setPosition ( const Coord &  position)

Accessor in writing to the position.

void tlp::GlBox::setSize ( const Size &  size)

Accessor in writing to the size of the box.

void tlp::GlBox::setTextureName ( const std::string &  textureName)

Accessor in writing to the texture name of the box.

virtual void tlp::GlBox::setWithXML ( const std::string &  inString,
unsigned int &  currentPosition 
)
virtual

Function to set data with inString (in XML format)

Implements tlp::GlSimpleEntity.

virtual void tlp::GlBox::translate ( const Coord &  mouvement)
virtual

Translate entity.

Member Data Documentation

std::vector<Color> tlp::GlBox::fillColors
protected

fillColor of the box

Definition at line 145 of file GlBox.h.

bool tlp::GlBox::filled
protected

the box is filled ?

Definition at line 147 of file GlBox.h.

std::vector<Color> tlp::GlBox::outlineColors
protected

outlineColor of the box

Definition at line 146 of file GlBox.h.

bool tlp::GlBox::outlined
protected

the box is outlined ?

Definition at line 148 of file GlBox.h.

float tlp::GlBox::outlineSize
protected

size of the ouline

Definition at line 150 of file GlBox.h.

Coord tlp::GlBox::position
protected

The position of the center of the box

Definition at line 143 of file GlBox.h.

Size tlp::GlBox::size
protected

size is the "radius" of the box

Definition at line 144 of file GlBox.h.