Ra::Engine::Scene::VolumeComponent Class Reference

Main class to convert Ra::Core::Asset::VolumeData to Ra::Engine::VolumeObject. More...

#include <Engine/Scene/GeometryComponent.hpp>

Inheritance diagram for Ra::Engine::Scene::VolumeComponent:

Collaboration diagram for Ra::Engine::Scene::VolumeComponent:

Public Member Functions
	VolumeComponent (const std::string &name, Entity *entity, const Ra::Core::Asset::VolumeData *data)
void	initialize () override
	Pure virtual method to be overridden by any component. When this method is called you are guaranteed that all other startup systems have been loaded.
void	setupIO (const std::string &id)
void	setContentName (const std::string &name)
Ra::Core::Utils::Index	getRenderObjectIndex () const
	Returns the index of the associated RO (the display volume)
Data::VolumeObject *	getDisplayVolume ()
Public Member Functions inherited from Ra::Engine::Scene::Component
	Component (const std::string &name, Entity *entity)
	CONSTRUCTOR.
virtual	~Component ()
	DESTRUCTOR.
virtual void	setEntity (Entity *entity)
	Set entity the component is part of. This method is called by the entity.
virtual Entity *	getEntity () const
	Return the entity the component belongs to.
virtual const std::string &	getName () const
	Return the component's name.
virtual void	setSystem (System *system)
	Set the system to which the component belongs.
virtual System *	getSystem () const
	Returns the system to which the component belongs.
Core::Utils::Index	addRenderObject (Rendering::RenderObject *renderObject)
	Add a new render object to the component. This adds the RO to the manager for drawing.
void	removeRenderObject (const Core::Utils::Index &roIdx)
	Remove the render object from the component.
virtual bool	canEdit (const Core::Utils::Index &) const
	Returns true if a transform can be edited with the render object index given as a key.
virtual Core::Transform	getTransform (const Core::Utils::Index &) const
	Get the transform associated with the given RO index key.
virtual void	setTransform (const Core::Utils::Index &, const Core::Transform &)
	Set the new transform associated with the RO index key.
void	notifyRenderObjectExpired (const Core::Utils::Index &idx)
virtual Core::Aabb	computeAabb ()
void	invalidateAabb ()
const std::vector< Core::Utils::Index > &	getRenderObjects ()

Additional Inherited Members
Public Attributes inherited from Ra::Engine::Scene::Component
std::vector< Core::Utils::Index >	m_renderObjects
Static Protected Member Functions inherited from Ra::Engine::Scene::Component
static Rendering::RenderObjectManager *	getRoMgr ()
	Shortcut to access the render object manager.
Protected Attributes inherited from Ra::Engine::Scene::Component
std::string	m_name {}
Entity *	m_entity { nullptr }
System *	m_system { nullptr }

Detailed Description

Main class to convert Ra::Core::Asset::VolumeData to Ra::Engine::VolumeObject.

Exports access to the volume:

• VolumeObject: get, rw

Definition at line 185 of file GeometryComponent.hpp.

Constructor & Destructor Documentation

VolumeComponent()

Ra::Engine::Scene::VolumeComponent::VolumeComponent	(	const std::string &	name,
		Entity *	entity,
		const Ra::Core::Asset::VolumeData *	data )

Definition at line 151 of file GeometryComponent.cpp.

Member Function Documentation

getDisplayVolume()

Data::VolumeObject * Ra::Engine::Scene::VolumeComponent::getDisplayVolume

(

)

Definition at line 192 of file GeometryComponent.cpp.

getRenderObjectIndex()

Index Ra::Engine::Scene::VolumeComponent::getRenderObjectIndex

(

)

const

Returns the index of the associated RO (the display volume)

Definition at line 197 of file GeometryComponent.cpp.

initialize()

void Ra::Engine::Scene::VolumeComponent::initialize ( )

overridevirtual

Pure virtual method to be overridden by any component. When this method is called you are guaranteed that all other startup systems have been loaded.

Implements Ra::Engine::Scene::Component.

Definition at line 160 of file GeometryComponent.cpp.

setContentName()

void Ra::Engine::Scene::VolumeComponent::setContentName

(

const std::string &

name

)

Definition at line 202 of file GeometryComponent.cpp.

setupIO()

void Ra::Engine::Scene::VolumeComponent::setupIO

(

const std::string &

id

)

Definition at line 206 of file GeometryComponent.cpp.

---

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

• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Scene/GeometryComponent.hpp
• /home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Engine/Scene/GeometryComponent.cpp