ogre_tools::Grid Class Reference

Displays a grid of cells, drawn with lines. More...

#include <grid.h>

List of all members.

Public Types

enum  Style { Lines, Billboards }

Public Member Functions

void create ()
float getCellCount ()
float getCellLength ()
Ogre::ColourValue getColor ()
uint32_t getHeight ()
float getLineWidth ()
Ogre::SceneNode * getSceneNode ()
 Get the Ogre scene node associated with this grid.
Style getStyle ()
 Grid (Ogre::SceneManager *manager, Ogre::SceneNode *parent_node, Style style, uint32_t cell_count, float cell_length, float line_width, const Ogre::ColourValue &color)
 Constructor.
void setCellCount (uint32_t count)
void setCellLength (float len)
void setColor (const Ogre::ColourValue &color)
void setHeight (uint32_t count)
void setLineWidth (float width)
void setStyle (Style style)
void setUserData (const Ogre::Any &data)
 Sets user data on all ogre objects we own.
 ~Grid ()

Private Attributes

BillboardLinebillboard_line_
uint32_t cell_count_
float cell_length_
Ogre::ColourValue color_
uint32_t height_
float line_width_
Ogre::ManualObject * manual_object_
 The manual object used to draw the grid.
Ogre::MaterialPtr material_
Ogre::SceneManager * scene_manager_
Ogre::SceneNode * scene_node_
 The scene node that this grid is attached to.
Style style_

Detailed Description

Displays a grid of cells, drawn with lines.

Displays a grid of cells, drawn with lines. A grid with an identity orientation is drawn along the XZ plane.

Definition at line 61 of file grid.h.


Member Enumeration Documentation

Enumerator:
Lines 
Billboards 

Definition at line 64 of file grid.h.


Constructor & Destructor Documentation

ogre_tools::Grid::Grid ( Ogre::SceneManager *  manager,
Ogre::SceneNode *  parent_node,
Style  style,
uint32_t  cell_count,
float  cell_length,
float  line_width,
const Ogre::ColourValue &  color 
)

Constructor.

Parameters:
manager The scene manager this object is part of
cell_count The number of cells to draw
cell_length The size of each cell
r Red color component, in the range [0, 1]
g Green color component, in the range [0, 1]
b Blue color component, in the range [0, 1]

Definition at line 40 of file grid.cpp.

ogre_tools::Grid::~Grid (  ) 

Definition at line 73 of file grid.cpp.


Member Function Documentation

void ogre_tools::Grid::create (  ) 

Definition at line 136 of file grid.cpp.

float ogre_tools::Grid::getCellCount (  )  [inline]

Definition at line 104 of file grid.h.

float ogre_tools::Grid::getCellLength (  )  [inline]

Definition at line 107 of file grid.h.

Ogre::ColourValue ogre_tools::Grid::getColor (  )  [inline]

Definition at line 101 of file grid.h.

uint32_t ogre_tools::Grid::getHeight (  )  [inline]

Definition at line 113 of file grid.h.

float ogre_tools::Grid::getLineWidth (  )  [inline]

Definition at line 110 of file grid.h.

Ogre::SceneNode* ogre_tools::Grid::getSceneNode (  )  [inline]

Get the Ogre scene node associated with this grid.

Returns:
The Ogre scene node associated with this grid

Definition at line 90 of file grid.h.

Style ogre_tools::Grid::getStyle (  )  [inline]

Definition at line 98 of file grid.h.

void ogre_tools::Grid::setCellCount ( uint32_t  count  ) 

Definition at line 83 of file grid.cpp.

void ogre_tools::Grid::setCellLength ( float  len  ) 

Definition at line 90 of file grid.cpp.

void ogre_tools::Grid::setColor ( const Ogre::ColourValue &  color  ) 

Definition at line 104 of file grid.cpp.

void ogre_tools::Grid::setHeight ( uint32_t  count  ) 

Definition at line 129 of file grid.cpp.

void ogre_tools::Grid::setLineWidth ( float  width  ) 

Definition at line 97 of file grid.cpp.

void ogre_tools::Grid::setStyle ( Style  style  ) 

Definition at line 122 of file grid.cpp.

void ogre_tools::Grid::setUserData ( const Ogre::Any &  data  ) 

Sets user data on all ogre objects we own.

Definition at line 235 of file grid.cpp.


Member Data Documentation

Definition at line 120 of file grid.h.

uint32_t ogre_tools::Grid::cell_count_ [private]

Definition at line 125 of file grid.h.

Definition at line 126 of file grid.h.

Ogre::ColourValue ogre_tools::Grid::color_ [private]

Definition at line 129 of file grid.h.

uint32_t ogre_tools::Grid::height_ [private]

Definition at line 128 of file grid.h.

Definition at line 127 of file grid.h.

Ogre::ManualObject* ogre_tools::Grid::manual_object_ [private]

The manual object used to draw the grid.

Definition at line 118 of file grid.h.

Ogre::MaterialPtr ogre_tools::Grid::material_ [private]

Definition at line 122 of file grid.h.

Ogre::SceneManager* ogre_tools::Grid::scene_manager_ [private]

Definition at line 116 of file grid.h.

Ogre::SceneNode* ogre_tools::Grid::scene_node_ [private]

The scene node that this grid is attached to.

Definition at line 117 of file grid.h.

Definition at line 124 of file grid.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines


ogre_tools
Author(s): Josh Faust
autogenerated on Fri Jan 11 09:10:16 2013