Ignition Rendering

API Reference

4.0.0

#include <BaseObject.hh>

Public Member Functions

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...
 
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()

◆ Id()

virtual unsigned int Id ( ) const
overridevirtual

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()

◆ Load()

virtual void Load ( )
protectedvirtual

◆ Name()

virtual std::string Name ( ) const
overridevirtual

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.

◆ PostRender()

◆ PreRender()

Member Data Documentation

◆ id

unsigned int id
protected

◆ name

std::string name
protected

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