Blue Brain BioExplorer
core::GeometryParameters Class Reference

#include <GeometryParameters.h>

Inheritance diagram for core::GeometryParameters:
Collaboration diagram for core::GeometryParameters:

Public Member Functions

 GeometryParameters ()
 
void print () final
 
MemoryMode getMemoryMode () const
 
const std::set< BVHFlag > & getDefaultBVHFlags () const
 
GeometryQuality getGeometryQuality () const
 Get the geometry quality (low, medium or high) More...
 
float getSdfEpsilon () const
 Get the epsilon for SDF geometries. More...
 
float getSdfBlendFactor () const
 Get the blending factor for SDF geometries. More...
 
float getSdfBlendLerpFactor () const
 Get the blending lerp factor for SDF geometries. More...
 
float getSdfNbMarchIterations () const
 Get the number of ray-marching iterations for SDF geometries. More...
 
float getSdfOmega () const
 Get the ray-marching omega for SDF geometries. More...
 
float getSdfDistance () const
 Get the distance until which SDF geometries are processed (blending and displacement) More...
 
- Public Member Functions inherited from core::AbstractParameters
 AbstractParameters (const std::string &name)
 
virtual ~AbstractParameters ()=default
 
po::options_description & parameters ()
 
- 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 ()
 

Protected Member Functions

void parse (const po::variables_map &vm) final
 
- 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

std::set< BVHFlag_defaultBVHFlags
 
GeometryQuality _geometryQuality {GeometryQuality::high}
 
float _sdfEpsilon {DEFAULT_GEOMETRY_SDF_EPSILON}
 
uint64_t _sdfNbMarchIterations {DEFAULT_GEOMETRY_SDF_NB_MARCH_ITERATIONS}
 
float _sdfBlendFactor {DEFAULT_GEOMETRY_SDF_BLEND_FACTOR}
 
float _sdfBlendLerpFactor {DEFAULT_GEOMETRY_SDF_BLEND_LERP_FACTOR}
 
float _sdfOmega {DEFAULT_GEOMETRY_SDF_OMEGA}
 
float _sdfDistance {DEFAULT_GEOMETRY_SDF_DISTANCE}
 
MemoryMode _memoryMode {MemoryMode::shared}
 
- Protected Attributes inherited from core::AbstractParameters
std::string _name
 
po::options_description _parameters
 

Additional Inherited Members

- Public Types inherited from core::BaseObject
using ModifiedCallback = std::function< void(const BaseObject &)>
 
- Static Protected Member Functions inherited from core::AbstractParameters
static std::string asString (const bool flag)
 

Detailed Description

Manages geometry parameters

Definition at line 35 of file GeometryParameters.h.

Constructor & Destructor Documentation

◆ GeometryParameters()

core::GeometryParameters::GeometryParameters ( )

Parse the command line parameters and populates according class members

Definition at line 48 of file GeometryParameters.cpp.

Member Function Documentation

◆ getDefaultBVHFlags()

const std::set<BVHFlag>& core::GeometryParameters::getDefaultBVHFlags ( ) const
inline

Definition at line 51 of file GeometryParameters.h.

◆ getGeometryQuality()

GeometryQuality core::GeometryParameters::getGeometryQuality ( ) const
inline

Get the geometry quality (low, medium or high)

Returns
GeometryQuality Geometry quality level

Definition at line 58 of file GeometryParameters.h.

◆ getMemoryMode()

MemoryMode core::GeometryParameters::getMemoryMode ( ) const
inline

Defines what memory mode should be used between Core and the underlying renderer

Definition at line 50 of file GeometryParameters.h.

◆ getSdfBlendFactor()

float core::GeometryParameters::getSdfBlendFactor ( ) const
inline

Get the blending factor for SDF geometries.

Returns
float Blending factor

Definition at line 72 of file GeometryParameters.h.

◆ getSdfBlendLerpFactor()

float core::GeometryParameters::getSdfBlendLerpFactor ( ) const
inline

Get the blending lerp factor for SDF geometries.

Returns
float Blending lerp factor

Definition at line 79 of file GeometryParameters.h.

◆ getSdfDistance()

float core::GeometryParameters::getSdfDistance ( ) const
inline

Get the distance until which SDF geometries are processed (blending and displacement)

Returns
float The distance

Definition at line 100 of file GeometryParameters.h.

◆ getSdfEpsilon()

float core::GeometryParameters::getSdfEpsilon ( ) const
inline

Get the epsilon for SDF geometries.

Returns
float Epsilon

Definition at line 65 of file GeometryParameters.h.

◆ getSdfNbMarchIterations()

float core::GeometryParameters::getSdfNbMarchIterations ( ) const
inline

Get the number of ray-marching iterations for SDF geometries.

Returns
float Number of ray-marching iterations

Definition at line 86 of file GeometryParameters.h.

◆ getSdfOmega()

float core::GeometryParameters::getSdfOmega ( ) const
inline

Get the ray-marching omega for SDF geometries.

Returns
float Value of Omega

Definition at line 93 of file GeometryParameters.h.

◆ parse()

void core::GeometryParameters::parse ( const po::variables_map &  )
finalprotectedvirtual

Parses parameters managed by the class

Parameters
vmthe variables map of all arguments passed by the user

Reimplemented from core::AbstractParameters.

Definition at line 81 of file GeometryParameters.cpp.

◆ print()

void core::GeometryParameters::print ( )
finalvirtual

Displays values of registered parameters

Reimplemented from core::AbstractParameters.

Definition at line 124 of file GeometryParameters.cpp.

Member Data Documentation

◆ _defaultBVHFlags

std::set<BVHFlag> core::GeometryParameters::_defaultBVHFlags
protected

Definition at line 106 of file GeometryParameters.h.

◆ _geometryQuality

GeometryQuality core::GeometryParameters::_geometryQuality {GeometryQuality::high}
protected

Definition at line 109 of file GeometryParameters.h.

◆ _memoryMode

MemoryMode core::GeometryParameters::_memoryMode {MemoryMode::shared}
protected

Definition at line 118 of file GeometryParameters.h.

◆ _sdfBlendFactor

float core::GeometryParameters::_sdfBlendFactor {DEFAULT_GEOMETRY_SDF_BLEND_FACTOR}
protected

Definition at line 112 of file GeometryParameters.h.

◆ _sdfBlendLerpFactor

float core::GeometryParameters::_sdfBlendLerpFactor {DEFAULT_GEOMETRY_SDF_BLEND_LERP_FACTOR}
protected

Definition at line 113 of file GeometryParameters.h.

◆ _sdfDistance

float core::GeometryParameters::_sdfDistance {DEFAULT_GEOMETRY_SDF_DISTANCE}
protected

Definition at line 115 of file GeometryParameters.h.

◆ _sdfEpsilon

float core::GeometryParameters::_sdfEpsilon {DEFAULT_GEOMETRY_SDF_EPSILON}
protected

Definition at line 110 of file GeometryParameters.h.

◆ _sdfNbMarchIterations

uint64_t core::GeometryParameters::_sdfNbMarchIterations {DEFAULT_GEOMETRY_SDF_NB_MARCH_ITERATIONS}
protected

Definition at line 111 of file GeometryParameters.h.

◆ _sdfOmega

float core::GeometryParameters::_sdfOmega {DEFAULT_GEOMETRY_SDF_OMEGA}
protected

Definition at line 114 of file GeometryParameters.h.


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