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

#include <OSPRayCamera.h>

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

Public Member Functions

 OSPRayCamera (OSPRayEngine *engine)
 
 ~OSPRayCamera ()
 
void commit () final
 
void setClipPlanes (const Planes &planes)
 
void setEnvironmentMap (const bool environmentMap)
 
OSPCamera impl ()
 
- Public Member Functions inherited from core::Camera
PLATFORM_API Camera ()=default
 Default constructor. More...
 
virtual PLATFORM_API ~Camera ()=default
 Default destructor. More...
 
PLATFORM_API Cameraoperator= (const Camera &rhs)
 Copy constructor. More...
 
PLATFORM_API void set (const Vector3d &position, const Quaterniond &orientation, const Vector3d &target=Vector3d(0.0, 0.0, 0.0))
 Sets the position, orientation quaternion, and target of the camera. More...
 
PLATFORM_API void setInitialState (const Vector3d &position, const Quaterniond &orientation, const Vector3d &target=Vector3d(0.0, 0.0, 0.0))
 Sets the initial state of the camera. More...
 
PLATFORM_API void reset ()
 Resets the camera to its initial values. More...
 
PLATFORM_API void setPosition (const Vector3d &position)
 Sets the camera position. More...
 
PLATFORM_API void setTarget (const Vector3d &target)
 Sets the camera target. More...
 
PLATFORM_API const Vector3dgetPosition () const
 Gets the camera position. More...
 
PLATFORM_API const Vector3dgetTarget () const
 Gets the camera target. More...
 
PLATFORM_API void setOrientation (Quaterniond orientation)
 Sets the camera orientation quaternion. More...
 
PLATFORM_API const QuaterniondgetOrientation () const
 Gets the camera orientation quaternion. More...
 
PLATFORM_API void setBufferTarget (const std::string &target)
 Sets the name of the current rendered frame buffer. More...
 
PLATFORM_API const std::string & getBufferTarget () const
 Gets the name of the current rendered frame buffer. More...
 
PLATFORM_API void setEngine (Engine *engine)
 Set the Engine object. More...
 
- 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::Camera
Engine_engine {nullptr}
 
- Protected Attributes inherited from core::PropertyObject
std::string _currentType
 
std::map< std::string, PropertyMap_properties
 

Detailed Description

OPSRAY specific camera

This object is the OSPRay specific implementation of a Camera

Definition at line 42 of file OSPRayCamera.h.

Constructor & Destructor Documentation

◆ OSPRayCamera()

core::engine::ospray::OSPRayCamera::OSPRayCamera ( OSPRayEngine engine)
inline

Definition at line 45 of file OSPRayCamera.h.

◆ ~OSPRayCamera()

core::engine::ospray::OSPRayCamera::~OSPRayCamera ( )

Definition at line 37 of file OSPRayCamera.cpp.

Member Function Documentation

◆ commit()

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

Commits the changes held by the camera object so that attributes become available to the OSPRay rendering engine

Reimplemented from core::Camera.

Definition at line 42 of file OSPRayCamera.cpp.

◆ impl()

OSPCamera core::engine::ospray::OSPRayCamera::impl ( )
inline

Gets the OSPRay implementation of the camera object

Returns
OSPRay implementation of the camera object

Definition at line 67 of file OSPRayCamera.h.

◆ setClipPlanes()

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

Set the clipping planes to use in this camera. Only implemented in the perspective and orthographic cameras.

Definition at line 85 of file OSPRayCamera.cpp.

◆ setEnvironmentMap()

void core::engine::ospray::OSPRayCamera::setEnvironmentMap ( const bool  environmentMap)

Definition at line 79 of file OSPRayCamera.cpp.


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