CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::RendererSceneObject Class Reference

A base class for all renderer scene objects. More...

#include <CeresEngine/Renderer/RendererSceneObject.hpp>

Inheritance diagram for CeresEngine::RendererSceneObject:
CeresEngine::RendererObject CeresEngine::TRendererObject< RendererCamera, RendererSceneObject > CeresEngine::TRendererObject< RendererEnvironment, RendererSceneObject > CeresEngine::TRendererObject< RendererLight, RendererSceneObject > CeresEngine::TRendererObject< RendererRenderable, RendererSceneObject > CeresEngine::TRendererObject< RendererTerrain, RendererSceneObject > CeresEngine::TRendererObject< SelfType, RendererSceneObject >

Public Member Functions

 RendererSceneObject (RendererScene &scene)
 Creates a new RendererSceneObject instance.
 
RendererScenegetScene () const
 A reference to the owning scene.
 
const TransformgetTransform () const noexcept
 The latest object transform.
 
- Public Member Functions inherited from CeresEngine::RendererObject
 RendererObject ()=default
 Creates a new RendererObject instance.
 
virtual ~RendererObject () noexcept=default
 Destroys an existing RendererObject instance.
 
virtual void destroy ()=0
 Destroys the RendererObject.
 
RendererObjectID getID () const noexcept
 An identifier that uniquely identifies this object in the renderer.
 

Protected Attributes

RendererScenemScene
 A reference to the owning scene.
 
Transform mTransform
 The latest object transform.
 
- Protected Attributes inherited from CeresEngine::RendererObject
RendererObjectID mID
 An identifier that uniquely identifies this object in the renderer.
 

Friends

template<typename , typename , typename >
class TRendererSceneObjectManager
 

Additional Inherited Members

- Public Attributes inherited from CeresEngine::RendererObject
Event< void(RendererObjectID newID)> willChangeID
 An event called whenever the object is about to change it's ID.
 
Event< void(RendererObjectID oldID)> didChangeID
 An event called whenever the object changes it's ID.
 

Detailed Description

A base class for all renderer scene objects.

Constructor & Destructor Documentation

◆ RendererSceneObject()

CeresEngine::RendererSceneObject::RendererSceneObject ( RendererScene scene)
explicit

Creates a new RendererSceneObject instance.

Parameters
sceneThe scene that the object belongs to.

Member Function Documentation

◆ getScene()

RendererScene & CeresEngine::RendererSceneObject::getScene ( ) const
inline

A reference to the owning scene.

◆ getTransform()

const Transform & CeresEngine::RendererSceneObject::getTransform ( ) const
inlinenoexcept

The latest object transform.

Friends And Related Symbol Documentation

◆ TRendererSceneObjectManager

Member Data Documentation

◆ mScene

RendererScene& CeresEngine::RendererSceneObject::mScene
protected

A reference to the owning scene.

◆ mTransform

Transform CeresEngine::RendererSceneObject::mTransform
protected

The latest object transform.


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