Ignition Rendering

API Reference

4.1.0

Ogre2.x implementation of the Object class. More...

#include <Ogre2Object.hh>

Public Member Functions

virtual ~Ogre2Object ()
 Destructor. More...
 
virtual ScenePtr Scene () const override
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual void Destroy () override
 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 override
 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 override
 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 PostRender () override
 Post process this object and any of its children after rendering. More...
 
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. More...
 
- Public Member Functions inherited from enable_shared_from_this< BaseObject >
enable_shared_from_this (T... args)
 
~enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 

Protected Member Functions

 Ogre2Object ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Init ()
 
virtual void Load ()
 

Protected Attributes

Ogre2ScenePtr scene
 Pointer to the ogre scene. More...
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

Ogre2.x implementation of the Object class.

Constructor & Destructor Documentation

◆ Ogre2Object()

Ogre2Object ( )
protected

Constructor.

◆ ~Ogre2Object()

virtual ~Ogre2Object ( )
virtual

Destructor.

Member Function Documentation

◆ Scene()

virtual ScenePtr Scene ( ) const
overridevirtual

Get the Scene that created this object.

Returns
The parent scene

Implements Object.

Member Data Documentation

◆ scene

Ogre2ScenePtr scene
protected

Pointer to the ogre scene.


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