BaseGeometry< T > Class Template Reference

#include <BaseGeometry.hh>

Public Member Functions
virtual	~BaseGeometry ()
virtual GeometryPtr	Clone () const override
	Clone the geometry.
virtual void	Destroy () override
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
virtual VisualPtr	Parent () const override=0
	Get the parent Visual.
virtual void	RemoveParent () override
	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 &_material, bool _unique=true) override
	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) override=0
	Set the materials of this Geometry.
Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.
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.
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 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.

Protected Member Functions
	BaseGeometry ()

Constructor & Destructor Documentation

BaseGeometry()

template<class T >

BaseGeometry ( )

protected

~BaseGeometry()

template<class T >

~BaseGeometry ( )

virtual

Member Function Documentation

Clone()

template<class T >

GeometryPtr Clone ( ) const

overridevirtual

Clone the geometry.

Returns

The cloned geometry.

Implements Geometry.

Reimplemented in BaseCapsule< Ogre2Geometry >, BaseCapsule< OgreGeometry >, BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

References gzwarn.

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.

Reimplemented in BaseGrid< Ogre2Geometry >, BaseGrid< OgreGeometry >, BaseWireBox< Ogre2Geometry >, BaseWireBox< OgreGeometry >, BaseHeightmap< Ogre2Geometry >, BaseHeightmap< OgreGeometry >, BaseMarker< Ogre2Geometry >, BaseMarker< OgreGeometry >, BaseMesh< Ogre2Geometry >, BaseMesh< OgreGeometry >, BaseText< OgreGeometry >, OgreCapsule, OgreMarker, OgreMesh, Ogre2Capsule, Ogre2Heightmap, Ogre2Marker, and Ogre2Mesh.

Parent()

template<class T >

virtual VisualPtr Parent ( ) const

overridepure virtual

Get the parent Visual.

Returns

the parent Visual

Implements Geometry.

Implemented in OgreGeometry, and Ogre2Geometry.

RemoveParent()

template<class T >

void RemoveParent ( )

overridevirtual

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

Implements Geometry.

References std::dynamic_pointer_cast().

SetMaterial() [1/2]

template<class T >

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

overridevirtual

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

Implements Geometry.

Reimplemented in BaseMesh< Ogre2Geometry >, and BaseMesh< OgreGeometry >.

References Scene::Material().

SetMaterial() [2/2]

template<class T >

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

overridepure 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

Implements Geometry.

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

---

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

• BaseGeometry.hh