Gazebo Rendering

API Reference

9.5.0
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
BaseGrid< T > Class Template Reference

Base implementation of a grid geometry. More...

#include <BaseGrid.hh>

Public Member Functions

 ~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 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 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.
 
virtual GeometryPtr Clone () const =0
 Clone the geometry.
 
virtual bool HasParent () const =0
 Determine if this Geometry is attached to a Visual.
 
virtual MaterialPtr Material () const =0
 Get the material of this geometry.
 
virtual VisualPtr Parent () const =0
 Get the parent Visual.
 
virtual void RemoveParent ()=0
 Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.
 
virtual void SetMaterial (const std::string &_name, bool _unique=true)=0
 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.
 
virtual void SetMaterial (MaterialPtr _material, bool _unique=true)=0
 Set the materials of this Geometry.
 
- 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.
 

Protected Member Functions

 BaseGrid ()
 Constructor.
 

Protected Attributes

unsigned int cellCount = 10u
 Number of cells in grid.
 
double cellLength = 1.0
 Length of a single cell.
 
bool gridDirty = false
 Flag to indicate grid properties have changed.
 
double heightOffset = 0.0
 vertical offset of the XY plane from origin
 
unsigned int verticalCellCount = 0
 Number of cells in vertical direction.
 

Detailed Description

template<class T>
class gz::rendering::BaseGrid< T >

Base implementation of a grid geometry.

Constructor & Destructor Documentation

◆ BaseGrid()

template<class T >
BaseGrid ( )
protected

Constructor.

◆ ~BaseGrid()

template<class T >
~BaseGrid ( )
override

Destructor.

Member Function Documentation

◆ CellCount()

template<class T >
unsigned int CellCount ( ) const
overridevirtual

Get the number of cells on a planar grid.

Returns
Number of cells

Implements Grid.

◆ CellLength()

template<class T >
double CellLength ( ) const
overridevirtual

Get the cell length.

Returns
The cell length

Implements Grid.

◆ Destroy()

template<class T >
void Destroy ( )
overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements Object.

◆ PreRender()

template<class T >
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.

Implements Object.

Reimplemented in OgreGrid, and Ogre2Grid.

◆ SetCellCount()

template<class T >
void SetCellCount ( const unsigned int  _count)
overridevirtual

Set the number of cells on a planar grid.

Parameters
[in]_countThe number of cells

Implements Grid.

◆ SetCellLength()

template<class T >
void SetCellLength ( const double  _len)
overridevirtual

Set the cell length in one direction. The cells are assumed to be square.

Parameters
[in]_lenThe cell length

Implements Grid.

◆ SetVerticalCellCount()

template<class T >
void SetVerticalCellCount ( const unsigned int  _count)
overridevirtual

Set the vertical cell count of the grid. This makes the grid 3D.

Parameters
[in]_countNumber of cells in vertical direction.

Implements Grid.

◆ VerticalCellCount()

template<class T >
unsigned int VerticalCellCount ( ) const
overridevirtual

Get the vertical cell count.

Returns
The vertical cell count.

Implements Grid.

Member Data Documentation

◆ cellCount

template<class T >
unsigned int cellCount = 10u
protected

Number of cells in grid.

◆ cellLength

template<class T >
double cellLength = 1.0
protected

Length of a single cell.

◆ gridDirty

template<class T >
bool gridDirty = false
protected

Flag to indicate grid properties have changed.

◆ heightOffset

template<class T >
double heightOffset = 0.0
protected

vertical offset of the XY plane from origin

◆ verticalCellCount

template<class T >
unsigned int verticalCellCount = 0
protected

Number of cells in vertical direction.

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