Grid Class Reference

Represents a grid geometry drawn along the XY plane. If vertical cell count is specified then the grid becomes 3D. More...

#include <gz/rendering/Grid>

Public Member Functions
virtual	~Grid ()
	Destructor.
virtual unsigned int	CellCount () const =0
	Get the number of cells on a planar grid.
virtual double	CellLength () const =0
	Get the cell length.
virtual void	SetCellCount (const unsigned int _count)=0
	Set the number of cells on a planar grid.
virtual void	SetCellLength (const double _len)=0
	Set the cell length in one direction. The cells are assumed to be square.
virtual void	SetVerticalCellCount (const unsigned int _count)=0
	Set the vertical cell count of the grid. This makes the grid 3D.
virtual unsigned int	VerticalCellCount () const =0
	Get the vertical cell count.
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 void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
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 void	PreRender ()=0
	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.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

Detailed Description

Represents a grid geometry drawn along the XY plane. If vertical cell count is specified then the grid becomes 3D.

Constructor & Destructor Documentation

~Grid()

virtual ~Grid ( )

virtual

Destructor.

Member Function Documentation

CellCount()

virtual unsigned int CellCount ( ) const

pure virtual

Get the number of cells on a planar grid.

Returns

Number of cells

Implemented in BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.

CellLength()

virtual double CellLength ( ) const

pure virtual

Get the cell length.

Returns

The cell length

Implemented in BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.

SetCellCount()

virtual void SetCellCount ( const unsigned int  _count )

pure virtual

Set the number of cells on a planar grid.

Parameters

[in]

_count

The number of cells

Implemented in BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.

SetCellLength()

virtual void SetCellLength ( const double  _len )

pure virtual

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

Parameters

[in]

_len

The cell length

Implemented in BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.

SetVerticalCellCount()

virtual void SetVerticalCellCount ( const unsigned int  _count )

pure virtual

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

Parameters

[in]

_count

Number of cells in vertical direction.

Implemented in BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.

VerticalCellCount()

virtual unsigned int VerticalCellCount ( ) const

pure virtual

Get the vertical cell count.

Returns

The vertical cell count.

Implemented in BaseGrid< T >, BaseGrid< Ogre2Geometry >, and BaseGrid< OgreGeometry >.

---

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

• Grid.hh