Tulip  4.6.0
Better Visualization Through Research
tlp::GlGrid Class Reference

#include <GlGrid.h>

+ Inheritance diagram for tlp::GlGrid:
+ Collaboration diagram for tlp::GlGrid:

List of all members.

Public Member Functions

 GlGrid ()
 GlGrid (const Coord &frontTopLeft, const Coord &backBottomRight, const Size &cell, const Color &color, bool displays[3])
virtual void draw (float lod, Camera *camera)
void getDisplayDim (bool displayDim[3]) const
virtual void getXML (std::string &outString)
void setDisplayDim (bool displayDim[3])
virtual void setWithXML (const std::string &inString, unsigned int &currentPosition)
virtual void translate (const Coord &mouvement)

Protected Attributes

Coord backBottomRight
Size cell
Color color
bool displayDim [3]
Coord frontTopLeft
bool hollowGrid

Detailed Description

General class used to render grids as GlSimpleEntity.

Definition at line 36 of file GlGrid.h.


Constructor & Destructor Documentation

tlp::GlGrid::GlGrid ( ) [inline]

Constructor.

Warning:
Don't use this constructor : see other constructor

Definition at line 44 of file GlGrid.h.

tlp::GlGrid::GlGrid ( const Coord &  frontTopLeft,
const Coord &  backBottomRight,
const Size &  cell,
const Color &  color,
bool  displays[3] 
)

Constructor.

Parameters:
frontTopLeftThe minimum of the bounding box of the grid.
backBottomRightThe maximum of the bounding box of the grid.
cellThe size of a single cell of the grid.
colorThe color of the lines of the grid.
displaysThe dimensions of the grid to display.
hollowGridIndicates if the grid chould be hollowed.

Member Function Documentation

virtual void tlp::GlGrid::draw ( float  lod,
Camera camera 
) [virtual]

Virtual function used to draw the grid.

Implements tlp::GlSimpleEntity.

void tlp::GlGrid::getDisplayDim ( bool  displayDim[3]) const

Accessor in reading to the dimensions to display.

virtual void tlp::GlGrid::getXML ( std::string &  outString) [virtual]

Function to export data in outString (in XML format)

Implements tlp::GlSimpleEntity.

void tlp::GlGrid::setDisplayDim ( bool  displayDim[3])

Accessor in writing to the dimensions to display.

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

Function to set data with inString (in XML format)

Implements tlp::GlSimpleEntity.

virtual void tlp::GlGrid::translate ( const Coord &  mouvement) [virtual]

Translate entity.


Member Data Documentation

Coord tlp::GlGrid::backBottomRight [protected]

Back bottom right point of the grid, the "maximum"

Definition at line 91 of file GlGrid.h.

Size tlp::GlGrid::cell [protected]

The size of a cell of the grid

Definition at line 93 of file GlGrid.h.

Color tlp::GlGrid::color [protected]

The color of the grid

Definition at line 92 of file GlGrid.h.

bool tlp::GlGrid::displayDim[3] [protected]

Which dimensions should be displayed ? Note that only one dimension at most should be disabled

Definition at line 88 of file GlGrid.h.

Coord tlp::GlGrid::frontTopLeft [protected]

Front top left point of the grid, the "minimum"

Definition at line 90 of file GlGrid.h.

bool tlp::GlGrid::hollowGrid [protected]

Should the grid be hollowed ?

Definition at line 89 of file GlGrid.h.

 All Classes Files Functions Variables Enumerations Enumerator Properties