Base implementation of a grid geometry. More...
#include <BaseGrid.hh>
Public Member Functions | |
| 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 | 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 | 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... | |
| virtual GeometryPtr | Clone () const =0 |
| Clone the geometry. More... | |
| virtual bool | HasParent () const =0 |
| Determine if this Geometry is attached to a Visual. More... | |
| virtual MaterialPtr | Material () const =0 |
| Get the material of this geometry. More... | |
| virtual VisualPtr | Parent () const =0 |
| Get the parent Visual. More... | |
| virtual void | RemoveParent ()=0 |
| 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 &_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. More... | |
| virtual void | SetMaterial (MaterialPtr _material, bool _unique=true)=0 |
| Set the materials of this 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... | |
Protected Member Functions | |
| BaseGrid () | |
| Constructor. More... | |
Protected Attributes | |
| unsigned int | cellCount = 10u |
| Number of cells in grid. More... | |
| double | cellLength = 1.0 |
| Length of a single cell. More... | |
| bool | gridDirty = false |
| Flag to indicate grid properties have changed. More... | |
| double | heightOffset = 0.0 |
| vertical offset of the XY plane from origin More... | |
| unsigned int | verticalCellCount = 0 |
| Number of cells in vertical direction. More... | |
Detailed Description
template<class T>
class ignition::rendering::BaseGrid< T >
Base implementation of a grid geometry.
Constructor & Destructor Documentation
◆ BaseGrid()
|
protected |
Constructor.
◆ ~BaseGrid()
|
virtual |
Destructor.
Member Function Documentation
◆ CellCount()
|
virtual |
◆ CellLength()
|
virtual |
◆ Destroy()
|
virtual |
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
Implements Object.
◆ 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.
Implements Object.
Reimplemented in OgreGrid.
◆ SetCellCount()
|
virtual |
◆ SetCellLength()
|
virtual |
Set the cell length in one direction. The cells are assumed to be square.
- Parameters
-
[in] _len The cell length
Implements Grid.
◆ SetVerticalCellCount()
|
virtual |
Set the vertical cell count of the grid. This makes the grid 3D.
- Parameters
-
[in] _count Number of cells in vertical direction.
Implements Grid.
◆ VerticalCellCount()
|
virtual |
Member Data Documentation
◆ cellCount
|
protected |
Number of cells in grid.
Referenced by BaseGrid< OgreGeometry >::CellCount(), and BaseGrid< OgreGeometry >::SetCellCount().
◆ cellLength
|
protected |
Length of a single cell.
Referenced by BaseGrid< OgreGeometry >::CellLength(), and BaseGrid< OgreGeometry >::SetCellLength().
◆ gridDirty
|
protected |
Flag to indicate grid properties have changed.
Referenced by BaseGrid< OgreGeometry >::SetCellCount(), BaseGrid< OgreGeometry >::SetCellLength(), and BaseGrid< OgreGeometry >::SetVerticalCellCount().
◆ heightOffset
|
protected |
vertical offset of the XY plane from origin
◆ verticalCellCount
|
protected |
Number of cells in vertical direction.
Referenced by BaseGrid< OgreGeometry >::SetVerticalCellCount(), and BaseGrid< OgreGeometry >::VerticalCellCount().
The documentation for this class was generated from the following file: