Ogre2 implementation of a grid geometry. More...

#include <Ogre2Grid.hh>

Public Member Functions
virtual	~Ogre2Grid ()
	Destructor. More...

virtual void	Init ()

virtual MaterialPtr	Material () const
	Get the material of this geometry. More...

virtual Ogre::MovableObject *	OgreObject () const
	Get the ogre object representing this geometry. More...

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< Ogre2Geometry >
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...

virtual unsigned int	CellCount () const =0
	Get the number of cells on a planar grid. More...

virtual double	CellLength () const =0
	Get the cell length. More...

virtual unsigned int	VerticalCellCount () const =0
	Get the vertical cell count. More...

Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor. More...

virtual GeometryPtr	Clone () const =0
	Clone the geometry. 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 Ogre2Geometry
virtual	~Ogre2Geometry ()
	Destructor. More...

virtual bool	HasParent () const override
	Determine if this Geometry is attached to a Visual. More...

virtual VisualPtr	Parent () const override
	Get the parent Visual. More...

Public Member Functions inherited from BaseGeometry< Ogre2Object >
virtual	~BaseGeometry ()

virtual GeometryPtr	Clone () const override
	Clone the geometry. More...

virtual VisualPtr	Parent () const override=0
	Get the parent Visual. More...

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 Ogre2Object
virtual	~Ogre2Object ()
	Destructor. More...

virtual ScenePtr	Scene () const override

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
	Ogre2Grid ()
	Constructor. More...

virtual void	SetMaterialImpl (Ogre2MaterialPtr _material)
	Set material to grid geometry. More...

Protected Member Functions inherited from BaseGrid< Ogre2Geometry >
	BaseGrid ()
	Constructor. More...

Protected Member Functions inherited from Ogre2Geometry
	Ogre2Geometry ()
	Constructor. More...

virtual void	SetParent (Ogre2VisualPtr _parent)
	Set the parent of this ogre geometry. More...

Protected Member Functions inherited from BaseGeometry< Ogre2Object >
	BaseGeometry ()

Protected Member Functions inherited from Ogre2Object
	Ogre2Object ()
	Constructor. More...

Protected Member Functions inherited from BaseObject
	BaseObject ()

virtual void	Load ()

Additional Inherited Members
Protected Attributes inherited from BaseGrid< Ogre2Geometry >
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 Ogre2Geometry
Ogre2VisualPtr	parent
	Parent visual. More...

Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr	scene
	Pointer to the ogre scene. More...

Protected Attributes inherited from BaseObject
unsigned int	id

std::string	name

Detailed Description

Ogre2 implementation of a grid geometry.

Constructor & Destructor Documentation

◆ Ogre2Grid()

Ogre2Grid ( )

protected

Constructor.

◆ ~Ogre2Grid()

virtual ~Ogre2Grid ( )

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

Get the ogre object representing this geometry.

Returns: Pointer to an ogre movable object

Implements Ogre2Geometry.

◆ 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< Ogre2Geometry >.

◆ SetMaterial()

virtual void SetMaterial	(	MaterialPtr	_material,
		bool	_unique
	)

virtual

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

protectedvirtual

Set material to grid geometry.

Parameters

[in] _material Ogre material.

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

gz/rendering/ogre2/Ogre2Grid.hh

Gazebo Rendering

API Reference

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ogre2Grid()

◆ ~Ogre2Grid()

Member Function Documentation

◆ Init()

◆ Material()

◆ OgreObject()

◆ PreRender()

◆ SetMaterial()

◆ SetMaterialImpl()