Blue Brain BioExplorer
core::engine::ospray::OSPRayRenderer Class Reference

#include <OSPRayRenderer.h>

Inheritance diagram for core::engine::ospray::OSPRayRenderer:
Collaboration diagram for core::engine::ospray::OSPRayRenderer:

Public Member Functions

 OSPRayRenderer (const AnimationParameters &animationParameters, const RenderingParameters &renderingParameters)
 
 ~OSPRayRenderer ()
 
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...
 
float getVariance () const final
 Get variance from previous render() This method returns the variance from the previous render() call. 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...
 
void setClipPlanes (const Planes &planes)
 
OSPRenderer impl ()
 
- Public Member Functions inherited from core::Renderer
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

Definition at line 38 of file OSPRayRenderer.h.

Constructor & Destructor Documentation

◆ OSPRayRenderer()

core::engine::ospray::OSPRayRenderer::OSPRayRenderer ( const AnimationParameters animationParameters,
const RenderingParameters renderingParameters 
)

Definition at line 45 of file OSPRayRenderer.cpp.

◆ ~OSPRayRenderer()

core::engine::ospray::OSPRayRenderer::~OSPRayRenderer ( )

Definition at line 51 of file OSPRayRenderer.cpp.

Member Function Documentation

◆ commit()

void core::engine::ospray::OSPRayRenderer::commit ( )
finalvirtual

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

Implements core::Renderer.

Definition at line 73 of file OSPRayRenderer.cpp.

◆ getVariance()

float core::engine::ospray::OSPRayRenderer::getVariance ( ) const
inlinefinalvirtual

Get variance from previous render() This method returns the variance from the previous render() call.

Returns
float Variance value

Reimplemented from core::Renderer.

Definition at line 46 of file OSPRayRenderer.h.

◆ impl()

OSPRenderer core::engine::ospray::OSPRayRenderer::impl ( )
inline

Gets the OSPRay implementation of the renderer object

Returns
OSPRay implementation of the renderer object

Definition at line 57 of file OSPRayRenderer.h.

◆ pick()

Renderer::PickResult core::engine::ospray::OSPRayRenderer::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 186 of file OSPRayRenderer.cpp.

◆ render()

void core::engine::ospray::OSPRayRenderer::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 63 of file OSPRayRenderer.cpp.

◆ setCamera()

void core::engine::ospray::OSPRayRenderer::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 177 of file OSPRayRenderer.cpp.

◆ setClipPlanes()

void core::engine::ospray::OSPRayRenderer::setClipPlanes ( const Planes planes)

Definition at line 233 of file OSPRayRenderer.cpp.


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