OgreGeometry Class Reference

#include <OgreGeometry.hh>

Public Member Functions
virtual	~OgreGeometry ()
virtual bool	HasParent () const
	Determine if this Geometry is attached to a Visual.
virtual Ogre::MovableObject *	OgreObject () const =0
virtual VisualPtr	Parent () const
	Get the parent Visual.
Public Member Functions inherited from BaseGeometry< OgreObject >
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 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 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.
Public Member Functions inherited from OgreObject
virtual	~OgreObject ()
virtual ScenePtr	Scene () const
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const override
virtual std::string	Name () const override
virtual void	PostRender () override
virtual void	PreRender () override

Protected Member Functions
	OgreGeometry ()
virtual void	SetParent (OgreVisualPtr _parent)
Protected Member Functions inherited from BaseGeometry< OgreObject >
	BaseGeometry ()
Protected Member Functions inherited from OgreObject
	OgreObject ()
Protected Member Functions inherited from BaseObject
	BaseObject ()
virtual void	Init ()
virtual void	Load ()

Protected Attributes
OgreVisualPtr	parent
Protected Attributes inherited from OgreObject
OgreScenePtr	scene
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Constructor & Destructor Documentation

OgreGeometry()

OgreGeometry ( )

protected

~OgreGeometry()

virtual ~OgreGeometry ( )

virtual

Member Function Documentation

HasParent()

virtual bool HasParent ( ) const

virtual

Determine if this Geometry is attached to a Visual.

Returns

True if this Geometry has a parent Visual

Implements Geometry.

OgreObject()

virtual Ogre::MovableObject * OgreObject ( ) const

pure virtual

Implemented in OgreGrid, OgreCapsule, OgreHeightmap, OgreMarker, OgreMesh, OgreText, and OgreWireBox.

Parent()

virtual VisualPtr Parent ( ) const

virtual

Get the parent Visual.

Returns

the parent Visual

Implements BaseGeometry< OgreObject >.

SetParent()

virtual void SetParent ( OgreVisualPtr  _parent )

protectedvirtual

Member Data Documentation

parent

OgreVisualPtr parent

protected

---

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

• OgreGeometry.hh