BaseObject Class Reference

#include <BaseObject.hh>

Public Member Functions
virtual	~BaseObject ()
virtual void	Destroy ()
	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
	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
	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	PreRender ()
	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...
Public Member Functions inherited from enable_shared_from_this< BaseObject >
T	enable_shared_from_this (T... args)
T	~enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)
Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. More...
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object. More...

Protected Member Functions
	BaseObject ()
virtual void	Init ()
virtual void	Load ()

Protected Attributes
unsigned int	id
std::string	name

Constructor & Destructor Documentation

BaseObject()

BaseObject ( )

protected

~BaseObject()

virtual ~BaseObject ( )

virtual

Member Function Documentation

Destroy()

virtual void Destroy ( )

virtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements Object.

Reimplemented in BaseVisual< OgreNode >, OgreRenderWindow, OgreRenderTexture, BaseNode< OgreObject >, OgreSubMesh, OgreLight, OgreRenderTarget, BaseMesh< OgreGeometry >, BaseGeometry< OgreObject >, OgreNode, and BaseGrid< OgreGeometry >.

Id()

virtual unsigned int Id ( ) const

virtual

Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.

Returns

The object ID

Implements Object.

Init()

virtual void Init ( )

protectedvirtual

Reimplemented in OgreMaterial, OgreSubMesh, OgreLight, OgreCamera, OgreNode, OgreVisual, OgreGrid, BaseArrowVisual< OgreVisual >, and BaseAxisVisual< OgreVisual >.

Load()

virtual void Load ( )

protectedvirtual

Reimplemented in BaseCamera< OgreSensor >, and OgreNode.

Name()

virtual std::string Name ( ) const

virtual

Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.

Returns

The object name

Implements Object.

PreRender()

virtual void PreRender ( )

virtual

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.

Reimplemented in BaseVisual< OgreNode >, BaseSubMesh< OgreObject >, BaseCamera< OgreSensor >, BaseMaterial< OgreObject >, OgreRenderTarget, BaseMesh< OgreGeometry >, OgreGrid, BaseGrid< OgreGeometry >, and BaseRenderTarget< OgreObject >.

Member Data Documentation

id

unsigned int id

protected

name

std::string name

protected

---

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

• BaseObject.hh