StevEngine::Renderer::RenderComponent Class Reference

Base component for renderable objects. More...

#include <visuals/renderer/RenderComponent.hpp>

Inheritance diagram for StevEngine::Renderer::RenderComponent:

Public Member Functions
	RenderComponent (const Object &object)
	Create render component.
	RenderComponent (const Object &object, Utilities::Vector3 position, Utilities::Quaternion rotation, Utilities::Vector3 scale)
	Create render component with transform.
	RenderComponent (const Object &object, Utilities::Stream &stream)
	Create from serialized data.
virtual std::string	GetType () const
	Get component type.
Object &	GetObject ()
	Local scale modifier.
Visuals::Material &	GetMaterial ()
	Get material.
void	AddShader (ShaderProgram program)
	Add shader program.
void	RemoveShader (ShaderType type)
	Remove shader of specified type.
	~RenderComponent ()
	Clean up component resources.
virtual Utilities::Stream	Export (Utilities::StreamType type) const
	Serialize component to a stream.
Public Member Functions inherited from StevEngine::Component
	Component ()
	Create new component.
virtual	~Component ()
	Clean up component resources.
GameObject &	GetParent () const
	Get parent GameObject.
Scene &	GetScene () const
	Get containing Scene.
virtual void	Start ()
	Initialize component after creation.
virtual void	Deactivate ()
	Clean up when component is deactivated.
virtual void	Update (double deltaTime)
	Update component logic.

Public Attributes
Utilities::Vector3	position = Utilities::Vector3()
Utilities::Quaternion	rotation = Utilities::Quaternion()
	Local position offset.
Utilities::Vector3	scale = Utilities::Vector3(1, 1, 1)
	Local rotation offset.

Protected Attributes
Object	object
	Renderable object.
std::map< ShaderType, ShaderProgram >	shaders
	Shader programs by type.
Protected Attributes inherited from StevEngine::Component
std::vector< std::pair< Utilities::ID, std::string > >	handlers
	Event handler registrations.

Detailed Description

Base component for renderable objects.

Component that adds rendering capability to game objects. Handles transform offsets and shader management.

Constructor & Destructor Documentation

RenderComponent() [1/3]

StevEngine::Renderer::RenderComponent::RenderComponent

(

const Object &

object

)

Create render component.

Parameters

object

Renderable object

RenderComponent() [2/3]

StevEngine::Renderer::RenderComponent::RenderComponent	(	const Object &	object,
		Utilities::Vector3	position,
		Utilities::Quaternion	rotation,
		Utilities::Vector3	scale )

Create render component with transform.

Parameters

object	Renderable object
position	Local position offset
rotation	Local rotation offset
scale	Local scale modifier

RenderComponent() [3/3]

StevEngine::Renderer::RenderComponent::RenderComponent	(	const Object &	object,
		Utilities::Stream &	stream )

Create from serialized data.

Parameters

object	Renderable object
stream	Stream containing serialized component data

Member Function Documentation

AddShader()

void StevEngine::Renderer::RenderComponent::AddShader

(

ShaderProgram

program

)

Add shader program.

Parameters

program

Shader to add

Export()

Utilities::Stream StevEngine::Renderer::RenderComponent::Export ( Utilities::StreamType type ) const

virtual

Serialize component to a stream.

Parameters

type	Type of stream to export to

Returns

Serialized stream

Reimplemented from StevEngine::Component.

Reimplemented in StevEngine::Visuals::CapsulePrimitive, StevEngine::Visuals::CubePrimitive, StevEngine::Visuals::CylinderPrimitive, StevEngine::Visuals::IcospherePrimitive, StevEngine::Visuals::TerrainRenderer, and StevEngine::Visuals::UVSpherePrimitive.

GetMaterial()

Visuals::Material & StevEngine::Renderer::RenderComponent::GetMaterial ( )

inline

Get material.

Returns

Reference to material

GetObject()

Object & StevEngine::Renderer::RenderComponent::GetObject ( )

inline

Local scale modifier.

Get renderable object

Returns

Reference to object

GetType()

virtual std::string StevEngine::Renderer::RenderComponent::GetType ( ) const

inlinevirtual

Get component type.

Returns

Type identifier string

Implements StevEngine::Component.

Reimplemented in StevEngine::Visuals::CapsulePrimitive, StevEngine::Visuals::CubePrimitive, StevEngine::Visuals::CylinderPrimitive, StevEngine::Visuals::IcospherePrimitive, StevEngine::Visuals::TerrainRenderer, and StevEngine::Visuals::UVSpherePrimitive.

RemoveShader()

void StevEngine::Renderer::RenderComponent::RemoveShader

(

ShaderType

type

)

Remove shader of specified type.

Parameters

type	Type of shader to remove

---

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

• visuals/renderer/RenderComponent.hpp
• visuals/renderer/RenderComponent.cpp