Radium Engine  1.5.0
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::VolumeObjectgetDisplayVolume ()
 
- 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. More...
 
virtual EntitygetEntity () 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 SystemgetSystem () 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 {}
 
Entitym_entity { nullptr }
 
Systemm_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 178 of file GeometryComponent.hpp.


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