Ignition Rendering

API Reference

6.3.1
Geometry Class Referenceabstract

Represents a geometric shape to be rendered. More...

#include <ignition/rendering/Geometry.hh>

Public Member Functions

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 void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. 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 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. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 

Detailed Description

Represents a geometric shape to be rendered.

Constructor & Destructor Documentation

◆ ~Geometry()

Member Function Documentation

◆ Clone()

virtual GeometryPtr Clone ( ) const
pure virtual

Clone the geometry.

Returns
The cloned geometry.

Implemented in BaseMesh< T >, BaseMesh< OgreGeometry >, BaseCapsule< T >, BaseCapsule< OgreGeometry >, BaseGeometry< T >, and BaseGeometry< OgreObject >.

Referenced by Geometry::~Geometry().

◆ HasParent()

virtual bool HasParent ( ) const
pure virtual

Determine if this Geometry is attached to a Visual.

Returns
True if this Geometry has a parent Visual

Implemented in OgreGeometry.

Referenced by Geometry::~Geometry().

◆ Material()

virtual MaterialPtr Material ( ) const
pure virtual

Get the material of this geometry.

Returns
Material used by this geometry

Implemented in BaseMesh< T >, BaseMesh< OgreGeometry >, OgreHeightmap, OgreCapsule, OgreText, OgreGrid, OgreWireBox, and OgreMarker.

Referenced by BaseCapsule< OgreGeometry >::Clone(), Geometry::~Geometry(), and SubMesh::~SubMesh().

◆ Parent()

virtual VisualPtr Parent ( ) const
pure virtual

Get the parent Visual.

Returns
the parent Visual

Implemented in OgreGeometry, BaseGeometry< T >, and BaseGeometry< OgreObject >.

Referenced by Geometry::~Geometry().

◆ RemoveParent()

virtual void RemoveParent ( )
pure virtual

Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.

Implemented in BaseGeometry< T >, and BaseGeometry< OgreObject >.

Referenced by Geometry::~Geometry().

◆ SetMaterial() [1/2]

virtual void SetMaterial ( const std::string _name,
bool  _unique = true 
)
pure virtual

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.

Parameters
[in]_nameName of registered Material
[in]_uniqueTrue if the specified material should be cloned

Implemented in BaseMesh< T >, BaseMesh< OgreGeometry >, BaseGeometry< T >, and BaseGeometry< OgreObject >.

Referenced by Geometry::~Geometry(), and SubMesh::~SubMesh().

◆ SetMaterial() [2/2]

virtual void SetMaterial ( MaterialPtr  _material,
bool  _unique = true 
)
pure virtual

Set the materials of this Geometry.

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

Implemented in BaseMesh< T >, BaseMesh< OgreGeometry >, OgreHeightmap, OgreCapsule, OgreText, OgreGrid, OgreWireBox, OgreMarker, BaseGeometry< T >, and BaseGeometry< OgreObject >.


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