Ogre2Capsule Class Reference

Ogre 2.x implementation of a Capsule Geometry. More...

#include <Ogre2Capsule.hh>

Public Member Functions
virtual	~Ogre2Capsule ()
	Destructor.
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	Init () override
virtual MaterialPtr	Material () const override
	Get the material of this geometry.
virtual Ogre::MovableObject *	OgreObject () const override
	Get the ogre object representing this geometry.
virtual void	PreRender () override
	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 void	SetMaterial (MaterialPtr _material, bool _unique) override
	Set the materials of this Geometry.
Public Member Functions inherited from BaseCapsule< Ogre2Geometry >
virtual	~BaseCapsule ()
virtual GeometryPtr	Clone () const override
	Clone the geometry.
virtual double	Length () const override
	Get the length of the capsule.
virtual double	Radius () const override
	Get the radius of the capsule.
virtual void	SetLength (double _length) override
	Set the length of the capsule.
virtual void	SetRadius (double _radius) override
	Set the radius of the capsule.
Public Member Functions inherited from Capsule
virtual	~Capsule ()
	Destructor.
Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.
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 ScenePtr	Scene () const =0
	Get the Scene that created this object.
Public Member Functions inherited from Ogre2Geometry
virtual	~Ogre2Geometry ()
	Destructor.
virtual bool	HasParent () const override
	Determine if this Geometry is attached to a Visual.
virtual VisualPtr	Parent () const override
	Get the parent Visual.
Public Member Functions inherited from BaseGeometry< Ogre2Object >
virtual	~BaseGeometry ()
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.
Public Member Functions inherited from Ogre2Object
virtual	~Ogre2Object ()
	Destructor.
virtual ScenePtr	Scene () const override
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const override
virtual std::string	Name () const override
virtual void	PostRender () override

Protected Member Functions
	Ogre2Capsule ()
	Constructor.
Protected Member Functions inherited from BaseCapsule< Ogre2Geometry >
	BaseCapsule ()
Protected Member Functions inherited from Ogre2Geometry
	Ogre2Geometry ()
	Constructor.
virtual void	SetParent (Ogre2VisualPtr _parent)
	Set the parent of this ogre geometry.
Protected Member Functions inherited from BaseGeometry< Ogre2Object >
	BaseGeometry ()
Protected Member Functions inherited from Ogre2Object
	Ogre2Object ()
	Constructor.
Protected Member Functions inherited from BaseObject
	BaseObject ()
virtual void	Load ()

Additional Inherited Members
Protected Attributes inherited from BaseCapsule< Ogre2Geometry >
bool	capsuleDirty
	Flag to indicate capsule properties have changed.
double	length
	Length of the capsule.
double	radius
	Radius of the capsule.
Protected Attributes inherited from Ogre2Geometry
Ogre2VisualPtr	parent
	Parent visual.
Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr	scene
	Pointer to the ogre scene.
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Detailed Description

Ogre 2.x implementation of a Capsule Geometry.

Constructor & Destructor Documentation

Ogre2Capsule()

Ogre2Capsule ( )

protected

Constructor.

~Ogre2Capsule()

virtual ~Ogre2Capsule ( )

virtual

Destructor.

Member Function Documentation

Destroy()

virtual 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.

Init()

virtual void Init ( )

overridevirtual

Reimplemented from BaseObject.

Material()

virtual MaterialPtr Material ( ) const

overridevirtual

Get the material of this geometry.

Returns

Material used by this geometry

Implements Geometry.

OgreObject()

virtual Ogre::MovableObject * OgreObject ( ) const

overridevirtual

Get the ogre object representing this geometry.

Returns

Pointer to an ogre movable object

Implements Ogre2Geometry.

PreRender()

virtual void PreRender ( )

overridevirtual

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.

SetMaterial()

virtual void SetMaterial ( MaterialPtr  _material, bool  _unique  )

overridevirtual

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.

---

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

• Ogre2Capsule.hh