CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::RenderableComponent Struct Referencefinal

A component that represents an object that can be rendered by a renderer. More...

#include <CeresEngine/Scene/Renderable.hpp>

Inheritance diagram for CeresEngine::RenderableComponent:
CeresEngine::Component< RenderableComponent > CeresEngine::AbstractComponent

Classes

struct  Accessor
 A class that describes access to a RenderableComponent. More...
 

Public Member Functions

virtual CE_DISABLE_WARNING_MISSING_OVERRIDE ::CeresEngine::ClassInfo getClassInfo () const noexcept
 
virtual ::CeresEngine::ClassInfo getClassInfo () noexcept
 
 RenderableComponent () noexcept=default
 Creates a new RenderableComponent with the default values.
 
 ~RenderableComponent () noexcept final=default
 
- Public Member Functions inherited from CeresEngine::Component< RenderableComponent >
const ComponentTypegetComponentType () const noexcept final
 Gets the component type.
 
- Public Member Functions inherited from CeresEngine::AbstractComponent
virtual ~AbstractComponent ()=default
 Defaulted virtual destructor.
 

Static Public Member Functions

template<typename Processor >
static constexpr void reflect (Processor &&RTTI)
 Executes the given processor for every field of the struct.
 

Public Attributes

HMesh mesh
 The mesh to render the component with.
 
RenderableMaterialVector materials
 The material to render the component with. One material per sub mesh.
 
RendererRenderableSettings rendererSettings
 A set of settings that should be used by renderer when rendering the renderable.
 

Additional Inherited Members

- Static Public Attributes inherited from CeresEngine::Component< RenderableComponent >
static const ComponentID componentID
 This component type ID.
 
static const ComponentMask mask
 The component mask.
 
static const ComponentTypecomponentType
 Gets the component type.
 

Detailed Description

A component that represents an object that can be rendered by a renderer.

It holds a mesh and a set of materials to be applied to each sub mesh.

Constructor & Destructor Documentation

◆ RenderableComponent()

CeresEngine::RenderableComponent::RenderableComponent ( )
defaultnoexcept

Creates a new RenderableComponent with the default values.

◆ ~RenderableComponent()

CeresEngine::RenderableComponent::~RenderableComponent ( )
finaldefaultnoexcept

Member Function Documentation

◆ getClassInfo() [1/2]

virtual CE_DISABLE_WARNING_MISSING_OVERRIDE ::CeresEngine::ClassInfo CeresEngine::RenderableComponent::getClassInfo ( ) const
virtualnoexcept

Reimplemented from CeresEngine::AbstractComponent.

◆ getClassInfo() [2/2]

virtual ::CeresEngine::ClassInfo CeresEngine::RenderableComponent::getClassInfo ( )
virtualnoexcept

Reimplemented from CeresEngine::AbstractComponent.

◆ reflect()

template<typename Processor >
static constexpr void CeresEngine::RenderableComponent::reflect ( Processor &&  RTTI)
inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters
RTTIThe processor to be ran for every field.

Member Data Documentation

◆ materials

RenderableMaterialVector CeresEngine::RenderableComponent::materials

The material to render the component with. One material per sub mesh.

◆ mesh

HMesh CeresEngine::RenderableComponent::mesh

The mesh to render the component with.

◆ rendererSettings

RendererRenderableSettings CeresEngine::RenderableComponent::rendererSettings

A set of settings that should be used by renderer when rendering the renderable.


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