Blue Brain BioExplorer
core::engine::optix::OptiXRenderer Class Reference

#include <OptiXRenderer.h>

Inheritance diagram for core::engine::optix::OptiXRenderer:
Collaboration diagram for core::engine::optix::OptiXRenderer:

Public Member Functions

 OptiXRenderer (const AnimationParameters &animationParameters, const RenderingParameters &renderingParameters)
 
void render (FrameBufferPtr frameBuffer) final
 Virtual method to render a FrameBuffer This method is implemented in specific engine renderers to draw the FrameBuffer. More...
 
void commit () final
 This virtual method is implemented in specific engine renderers to signal that rendering is complete. More...
 
void setCamera (CameraPtr camera) final
 Set camera for renderer This virtual method is implemented in specific engine renderers to set the camera for rendering. More...
 
PickResult pick (const Vector2f &pickPos) final
 Pick method This method is used to pick a point on the scene and returns PickResult struct with hit boolean value and position. More...
 
- Public Member Functions inherited from core::Renderer
virtual float getVariance () const
 Get variance from previous render() This method returns the variance from the previous render() call. More...
 
PLATFORM_API Renderer (const AnimationParameters &animationParameters, const RenderingParameters &renderingParameters)
 Constructs the Renderer object with animationParameters and renderingParameters. More...
 
void setEngine (Engine *engine)
 Sets the _scene pointer to a specified ScenePtr. More...
 
PLATFORM_API bool getHeadLight () const
 
PLATFORM_API void setHeadLight (const bool value)
 
PLATFORM_API void setMaxAccumFrames (const size_t value)
 
PLATFORM_API size_t getMaxAccumFrames () const
 
PLATFORM_API uint32_t getSamplesPerPixel () const
 
PLATFORM_API void setSamplesPerPixel (const uint32_t value)
 
PLATFORM_API uint32_t getSubsampling () const
 
PLATFORM_API void setSubsampling (const uint32_t subsampling)
 
PLATFORM_API const Vector3dgetBackgroundColor () const
 
PLATFORM_API void setBackgroundColor (const Vector3d &value)
 
PLATFORM_API bool getAccumulation () const
 
- Public Member Functions inherited from core::PropertyObject
void setCurrentType (const std::string &type)
 
const std::string & getCurrentType () const
 
template<typename T >
void updateProperty (const std::string &name, const T &value, const bool triggerCallback=true)
 
bool hasProperty (const std::string &name) const
 
template<typename T >
getProperty (const std::string &name) const
 
template<typename T >
getPropertyOrValue (const std::string &name, T val) const
 
void setProperties (const PropertyMap &properties)
 
void setProperties (const std::string &type, const PropertyMap &properties)
 
void updateProperties (const PropertyMap &properties)
 
const auto & getPropertyMap () const
 
const auto & getPropertyMap (const std::string &type) const
 
strings getTypes () const
 
void clonePropertiesFrom (const PropertyObject &obj)
 
- Public Member Functions inherited from core::BaseObject
 BaseObject ()=default
 
virtual ~BaseObject ()=default
 
 BaseObject (const BaseObject &)
 
BaseObjectoperator= (const BaseObject &rhs)
 
bool isModified () const
 
void resetModified ()
 
void markModified (const bool triggerCallback=true)
 
void onModified (const ModifiedCallback &callback)
 
void clearModifiedCallback ()
 

Additional Inherited Members

- Public Types inherited from core::BaseObject
using ModifiedCallback = std::function< void(const BaseObject &)>
 
- Protected Member Functions inherited from core::BaseObject
template<typename T >
void _updateValue (T &member, const T &newValue, const bool triggerCallback=true)
 
template<class T >
bool _isEqual (const T &a, const T &b, typename std::enable_if< std::is_floating_point< T >::value >::type *=0)
 
template<class T >
bool _isEqual (const T &a, const T &b, typename std::enable_if<!std::is_floating_point< T >::value >::type *=0)
 
- Protected Attributes inherited from core::Renderer
const AnimationParameters_animationParameters
 
const RenderingParameters_renderingParameters
 
Engine_engine {nullptr}
 
bool _accumulation {true}
 
bool _headLight {true}
 
Vector3d _backgroundColor {0., 0., 0.}
 
uint32_t _spp {1}
 
uint32_t _subsampling {1}
 
size_t _maxAccumFrames {100}
 
- Protected Attributes inherited from core::PropertyObject
std::string _currentType
 
std::map< std::string, PropertyMap_properties
 

Detailed Description

OptiX specific renderer

This object is the OptiX specific implementation of a renderer

Definition at line 41 of file OptiXRenderer.h.

Constructor & Destructor Documentation

◆ OptiXRenderer()

core::engine::optix::OptiXRenderer::OptiXRenderer ( const AnimationParameters animationParameters,
const RenderingParameters renderingParameters 
)

Definition at line 40 of file OptiXRenderer.cpp.

Member Function Documentation

◆ commit()

void core::engine::optix::OptiXRenderer::commit ( )
finalvirtual

This virtual method is implemented in specific engine renderers to signal that rendering is complete.

Implements core::Renderer.

Definition at line 68 of file OptiXRenderer.cpp.

◆ pick()

Renderer::PickResult core::engine::optix::OptiXRenderer::pick ( const Vector2f )
finalvirtual

Pick method This method is used to pick a point on the scene and returns PickResult struct with hit boolean value and position.

Parameters
pickPosVector2f with pick position coordinates
Returns
PickResult returns PickResult struct that contains boolean hit value and vector position

Reimplemented from core::Renderer.

Definition at line 124 of file OptiXRenderer.cpp.

◆ render()

void core::engine::optix::OptiXRenderer::render ( FrameBufferPtr  frameBuffer)
finalvirtual

Virtual method to render a FrameBuffer This method is implemented in specific engine renderers to draw the FrameBuffer.

Parameters
frameBufferPtr to FrameBuffer that will be drawn

Implements core::Renderer.

Definition at line 47 of file OptiXRenderer.cpp.

◆ setCamera()

void core::engine::optix::OptiXRenderer::setCamera ( CameraPtr  camera)
finalvirtual

Set camera for renderer This virtual method is implemented in specific engine renderers to set the camera for rendering.

Parameters
cameraCameraPtr of a camera object to set

Implements core::Renderer.

Definition at line 117 of file OptiXRenderer.cpp.


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