OgreGrid Class Reference

Ogre implementation of a grid geometry. More...

#include <OgreGrid.hh>

Public Member Functions
	~OgreGrid () override
	Destructor.
void	Init () override
MaterialPtr	Material () const override
	Get the material of this geometry.
Ogre::MovableObject *	OgreObject () const override
void	PreRender () override
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.
void	SetMaterial (MaterialPtr _material, bool _unique) override
	Set the materials of this Geometry.
Public Member Functions inherited from BaseGrid< OgreGeometry >
	~BaseGrid () override
	Destructor.
unsigned int	CellCount () const override
	Get the number of cells on a planar grid.
double	CellLength () const override
	Get the cell length.
void	Destroy () override
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
void	SetCellCount (const unsigned int _count) override
	Set the number of cells on a planar grid.
void	SetCellLength (const double _len) override
	Set the cell length in one direction. The cells are assumed to be square.
void	SetVerticalCellCount (const unsigned int _count) override
	Set the vertical cell count of the grid. This makes the grid 3D.
unsigned int	VerticalCellCount () const override
	Get the vertical cell count.
Public Member Functions inherited from Grid
virtual	~Grid ()
	Destructor.
Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.
Public Member Functions inherited from OgreGeometry
	~OgreGeometry () override
bool	HasParent () const override
	Determine if this Geometry is attached to a Visual.
VisualPtr	Parent () const override
	Get the parent Visual.
Public Member Functions inherited from BaseGeometry< OgreObject >
	~BaseGeometry () override
GeometryPtr	Clone () const override
	Clone the geometry.
void	RemoveParent () override
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.
void	SetMaterial (const std::string &_name, bool _unique=true) override
	Set the materials of this Geometry. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done.
Public Member Functions inherited from OgreObject
virtual	~OgreObject ()
virtual ScenePtr	Scene () const
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const override
virtual std::string	Name () const override
virtual void	PostRender () override

Protected Member Functions
	OgreGrid ()
	Constructor.
virtual void	SetMaterialImpl (OgreMaterialPtr _material)
	Set material to grid geometry.
Protected Member Functions inherited from BaseGrid< OgreGeometry >
	BaseGrid ()
	Constructor.
Protected Member Functions inherited from OgreGeometry
	OgreGeometry ()
virtual void	SetParent (OgreVisualPtr _parent)
Protected Member Functions inherited from BaseGeometry< OgreObject >
	BaseGeometry ()
Protected Member Functions inherited from OgreObject
	OgreObject ()
Protected Member Functions inherited from BaseObject
	BaseObject ()
virtual void	Load ()

Additional Inherited Members
Protected Attributes inherited from BaseGrid< OgreGeometry >
unsigned int	cellCount
	Number of cells in grid.
double	cellLength
	Length of a single cell.
bool	gridDirty
	Flag to indicate grid properties have changed.
double	heightOffset
	vertical offset of the XY plane from origin
unsigned int	verticalCellCount
	Number of cells in vertical direction.
Protected Attributes inherited from OgreGeometry
OgreVisualPtr	parent
Protected Attributes inherited from OgreObject
OgreScenePtr	scene
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Detailed Description

Ogre implementation of a grid geometry.

Constructor & Destructor Documentation

OgreGrid()

OgreGrid ( )

protected

Constructor.

~OgreGrid()

~OgreGrid ( )

override

Destructor.

Member Function Documentation

Init()

void Init ( )

overridevirtual

Reimplemented from BaseObject.

Material()

MaterialPtr Material ( ) const

overridevirtual

Get the material of this geometry.

Returns

Material used by this geometry

Implements Geometry.

OgreObject()

Ogre::MovableObject * OgreObject ( ) const

overridevirtual

Implements OgreGeometry.

PreRender()

void PreRender ( )

overridevirtual

Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.

Reimplemented from BaseGrid< OgreGeometry >.

SetMaterial()

void SetMaterial ( MaterialPtr  _material, bool  _unique  )

overridevirtual

Set the materials of this Geometry.

Parameters

[in]	_material	New Material to be assigned
[in]	_unique	True if the given material should be cloned

Implements Geometry.

SetMaterialImpl()

virtual void SetMaterialImpl ( OgreMaterialPtr  _material )

protectedvirtual

Set material to grid geometry.

Parameters

[in]

_material

Ogre material.

---

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

• OgreGrid.hh