Geometry Class Reference

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

#include <gz/rendering/Geometry.hh>

Public Member Functions
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 geometric shape to be rendered.

Constructor & Destructor Documentation

~Geometry()

virtual ~Geometry ( )

virtual

Destructor.

Member Function Documentation

Clone()

virtual GeometryPtr Clone ( ) const

pure virtual

Clone the geometry.

Returns

The cloned geometry.

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

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

Material()

virtual MaterialPtr Material ( ) const

pure virtual

Get the material of this geometry.

Returns

Material used by this geometry

Implemented in OgreGrid, Ogre2Grid, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, OgreCapsule, OgreHeightmap, OgreMarker, OgreText, OgreWireBox, Ogre2Capsule, Ogre2Heightmap, Ogre2Marker, and Ogre2WireBox.

Parent()

virtual VisualPtr Parent ( ) const

pure virtual

Get the parent Visual.

Returns

the parent Visual

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

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 >, BaseGeometry< Ogre2Object >, and BaseGeometry< OgreObject >.

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]	_name	Name of registered Material
[in]	_unique	True if the specified material should be cloned

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

SetMaterial() [2/2]

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

pure 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

Implemented in OgreGrid, Ogre2Grid, OgreCapsule, OgreHeightmap, OgreMarker, OgreText, OgreWireBox, Ogre2Capsule, Ogre2Heightmap, Ogre2Marker, Ogre2WireBox, BaseMesh< T >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, BaseGeometry< T >, BaseGeometry< Ogre2Object >, and BaseGeometry< OgreObject >.

---

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

• Geometry.hh