Ignition Rendering

API Reference

5.1.0

Ogre implementation of a grid geometry. More...

#include <OgreGrid.hh>

Public Member Functions

virtual ~OgreGrid ()
 Destructor. More...
 
virtual void Init ()
 
virtual MaterialPtr Material () const
 Get the material of this geometry. More...
 
virtual Ogre::MovableObject * OgreObject () const
 
virtual void PreRender ()
 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. More...
 
virtual void SetMaterial (MaterialPtr _material, bool _unique)
 Set the materials of this Geometry. More...
 
- Public Member Functions inherited from BaseGrid< OgreGeometry >
virtual ~BaseGrid ()
 Destructor. More...
 
virtual unsigned int CellCount () const
 Get the number of cells on a planar grid. More...
 
virtual double CellLength () const
 Get the cell length. More...
 
virtual void Destroy ()
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual void SetCellCount (const unsigned int _count)
 Set the number of cells on a planar grid. More...
 
virtual void SetCellLength (const double _len)
 Set the cell length in one direction. The cells are assumed to be square. More...
 
virtual void SetVerticalCellCount (const unsigned int _count)
 Set the vertical cell count of the grid. This makes the grid 3D. More...
 
virtual unsigned int VerticalCellCount () const
 Get the vertical cell count. More...
 
- Public Member Functions inherited from Grid
virtual ~Grid ()
 Destructor. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Destructor. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
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. More...
 
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. More...
 
virtual void PostRender ()=0
 Post process this object and any of its children after rendering. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from OgreGeometry
virtual ~OgreGeometry ()
 
virtual bool HasParent () const
 Determine if this Geometry is attached to a Visual. More...
 
virtual VisualPtr Parent () const
 Get the parent Visual. More...
 
- Public Member Functions inherited from BaseGeometry< OgreObject >
virtual ~BaseGeometry ()
 
virtual void RemoveParent () override
 Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...
 
virtual void SetMaterial (const std::string &_material, 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. More...
 
- 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. More...
 
virtual void SetMaterialImpl (OgreMaterialPtr _material)
 Set material to grid geometry. More...
 
- Protected Member Functions inherited from BaseGrid< OgreGeometry >
 BaseGrid ()
 Constructor. More...
 
- 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. More...
 
double cellLength
 Length of a single cell. More...
 
bool gridDirty
 Flag to indicate grid properties have changed. More...
 
double heightOffset
 vertical offset of the XY plane from origin More...
 
unsigned int verticalCellCount
 Number of cells in vertical direction. More...
 
- 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()

virtual ~OgreGrid ( )
virtual

Destructor.

Member Function Documentation

◆ Init()

virtual void Init ( )
virtual

Reimplemented from BaseObject.

◆ Material()

virtual MaterialPtr Material ( ) const
virtual

Get the material of this geometry.

Returns
Material used by this geometry

Implements Geometry.

◆ OgreObject()

virtual Ogre::MovableObject* OgreObject ( ) const
virtual

Implements OgreGeometry.

◆ PreRender()

virtual void PreRender ( )
virtual

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()

virtual void SetMaterial ( MaterialPtr  _material,
bool  _unique 
)
virtual

Set the materials of this Geometry.

Parameters
[in]_materialNew Material to be assigned
[in]_uniqueTrue if the given material should be cloned

Implements Geometry.

◆ SetMaterialImpl()

virtual void SetMaterialImpl ( OgreMaterialPtr  _material)
protectedvirtual

Set material to grid geometry.

Parameters
[in]_materialOgre material.

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