tlp::GlBox Class Reference

#include <GlBox.h>

Inheritance diagram for tlp::GlBox:

Collaboration diagram for tlp::GlBox:

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.)
	~GlBox () override
void	draw (float lod, Camera *camera) override
Color	getFillColor () const
Color	getOutlineColor () const
float	getOutlineSize () const
Coord *	getPosition () const
Size	getSize () const
std::string	getTextureName () const
void	getXML (std::string &outString) override
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)
void	setWithXML (const std::string &inString, unsigned int &currentPosition) override
void	translate (const Coord &mouvement) override
Public Member Functions inherited from tlp::GlSimpleEntity
	GlSimpleEntity ()
	~GlSimpleEntity () override
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 34 of file GlBox.h.

Constructor & Destructor Documentation

GlBox() [1/2]

tlp::GlBox::GlBox

(

)

Don't use this constructor.

GlBox() [2/2]

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

position	The center of the box.
size	The length of each dimension of the box.
fillColor	The fill color of the box.
outlineColor	The outline color of the box
filled	Fill the box ?
outlined	outline the box ?
outlineSize	The size of the outline

~GlBox()

tlp::GlBox::~GlBox ( )

override

Destructor.

Member Function Documentation

draw()

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

overridevirtual

Draw function.

Warning

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

Implements tlp::GlSimpleEntity.

getFillColor()

Color tlp::GlBox::getFillColor

(

)

const

Accessor in reading to the fill color.

getOutlineColor()

Color tlp::GlBox::getOutlineColor

(

)

const

Accessor in reading to the outline color.

getOutlineSize()

float tlp::GlBox::getOutlineSize

(

)

const

Accessor in reading to the outline size.

getPosition()

Coord* tlp::GlBox::getPosition

(

)

const

Accessor in reading to the position.

getSize()

Size tlp::GlBox::getSize

(

)

const

Accessor in reading to the size.

getTextureName()

std::string tlp::GlBox::getTextureName

(

)

const

Accessor in reading to the texture name.

getXML()

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

overridevirtual

Function to export data in outString (in XML format)

Implements tlp::GlSimpleEntity.

setFillColor()

void tlp::GlBox::setFillColor

(

const Color &

color

)

Accessor in writing to the fill color of the box.

setOutlineColor()

void tlp::GlBox::setOutlineColor

(

const Color &

color

)

Accessor in writing to the outline color of the box.

setOutlineSize()

void tlp::GlBox::setOutlineSize

(

float

size

)

Accessor in writing to the outline size of the box.

setPosition()

void tlp::GlBox::setPosition

(

const Coord &

position

)

Accessor in writing to the position.

setSize()

void tlp::GlBox::setSize

(

const Size &

size

)

Accessor in writing to the size of the box.

setTextureName()

void tlp::GlBox::setTextureName

(

const std::string &

textureName

)

Accessor in writing to the texture name of the box.

setWithXML()

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

overridevirtual

Function to set data with inString (in XML format)

Implements tlp::GlSimpleEntity.

translate()

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

override

Translate entity.

Member Data Documentation

fillColors

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

protected

fillColor of the box

Definition at line 144 of file GlBox.h.

filled

bool tlp::GlBox::filled

protected

the box is filled ?

Definition at line 146 of file GlBox.h.

outlineColors

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

protected

outlineColor of the box

Definition at line 145 of file GlBox.h.

outlined

bool tlp::GlBox::outlined

protected

the box is outlined ?

Definition at line 147 of file GlBox.h.

outlineSize

float tlp::GlBox::outlineSize

protected

size of the ouline

Definition at line 149 of file GlBox.h.

position

Coord tlp::GlBox::position

protected

The position of the center of the box

Definition at line 142 of file GlBox.h.

size

Size tlp::GlBox::size

protected

size is the "radius" of the box

Definition at line 143 of file GlBox.h.