#include <VolumeParameters.h>

Inheritance diagram for core::VolumeParameters:

Collaboration diagram for core::VolumeParameters:

Public Member Functions
	VolumeParameters ()

void	print () final

const Vector3ui &	getDimensions () const

void	setDimensions (const Vector3ui &dim)

const Vector3d &	getElementSpacing () const

void	setElementSpacing (const Vector3d &spacing)

const Vector3d &	getOffset () const

void	setGradientShading (const bool enabled)

bool	getGradientShading () const

void	setGradientOffset (const double value)

double	getGradientOffset () const

void	setSingleShade (const bool enabled)

bool	getSingleShade () const

void	setPreIntegration (const bool enabled)

bool	getPreIntegration () const

void	setAdaptiveSampling (const bool enabled)

bool	getAdaptiveSampling () const

void	setAdaptiveMaxSamplingRate (const double value)

double	getAdaptiveMaxSamplingRate () const

void	setSamplingRate (const double value)

double	getSamplingRate () const

void	setSpecular (const Vector3d &value)

const Vector3d &	getSpecular () const

void	setUserParameters (const Vector3d &value)

const Vector3d &	getUserParameters () const

void	setClipBox (const Boxd &value)

const Boxd &	getClipBox () const

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 &)

BaseObject &	operator= (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
Vector3ui	_dimensions

Vector3d	_elementSpacing

Vector3d	_offset

bool	_gradientShading {false}

double	_gradientOffset {0.001}

bool	_singleShade {true}

bool	_preIntegration {false}

double	_adaptiveMaxSamplingRate {2.}

bool	_adaptiveSampling {true}

double	_samplingRate {0.125}

Vector3d	_specular {0.3, 0.3, 0.3}

Boxd	_clipBox

Vector3d	_userParameters

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

Definition at line 31 of file VolumeParameters.h.

Constructor & Destructor Documentation

◆ VolumeParameters()

core::VolumeParameters::VolumeParameters ( )

Definition at line 32 of file VolumeParameters.cpp.

Member Function Documentation

◆ getAdaptiveMaxSamplingRate()

double core::VolumeParameters::getAdaptiveMaxSamplingRate ( ) const

inline

Definition at line 66 of file VolumeParameters.h.

◆ getAdaptiveSampling()

bool core::VolumeParameters::getAdaptiveSampling ( ) const

inline

Definition at line 63 of file VolumeParameters.h.

◆ getClipBox()

const Boxd& core::VolumeParameters::getClipBox ( ) const

inline

Definition at line 78 of file VolumeParameters.h.

◆ getDimensions()

const Vector3ui& core::VolumeParameters::getDimensions ( ) const

inline

Volume dimensions

Definition at line 40 of file VolumeParameters.h.

◆ getElementSpacing()

const Vector3d& core::VolumeParameters::getElementSpacing ( ) const

inline

Volume scale

Definition at line 44 of file VolumeParameters.h.

◆ getGradientOffset()

double core::VolumeParameters::getGradientOffset ( ) const

inline

Definition at line 54 of file VolumeParameters.h.

◆ getGradientShading()

bool core::VolumeParameters::getGradientShading ( ) const

inline

Definition at line 51 of file VolumeParameters.h.

◆ getOffset()

const Vector3d& core::VolumeParameters::getOffset ( ) const

inline

Volume offset

Definition at line 48 of file VolumeParameters.h.

◆ getPreIntegration()

bool core::VolumeParameters::getPreIntegration ( ) const

inline

Definition at line 60 of file VolumeParameters.h.

◆ getSamplingRate()

double core::VolumeParameters::getSamplingRate ( ) const

inline

Definition at line 69 of file VolumeParameters.h.

◆ getSingleShade()

bool core::VolumeParameters::getSingleShade ( ) const

inline

Definition at line 57 of file VolumeParameters.h.

◆ getSpecular()

const Vector3d& core::VolumeParameters::getSpecular ( ) const

inline

Definition at line 72 of file VolumeParameters.h.

◆ getUserParameters()

const Vector3d& core::VolumeParameters::getUserParameters ( ) const

inline

Definition at line 75 of file VolumeParameters.h.

◆ parse()

void core::VolumeParameters::parse ( const po::variables_map & )

finalprotectedvirtual

Parses parameters managed by the class

Parameters

vm	the variables map of all arguments passed by the user

Reimplemented from core::AbstractParameters.

Definition at line 46 of file VolumeParameters.cpp.

◆ print()

void core::VolumeParameters::print ( )

finalvirtual

Displays values of registered parameters

Reimplemented from core::AbstractParameters.

Definition at line 66 of file VolumeParameters.cpp.

◆ setAdaptiveMaxSamplingRate()

void core::VolumeParameters::setAdaptiveMaxSamplingRate ( const double value )

inline

Definition at line 65 of file VolumeParameters.h.

◆ setAdaptiveSampling()

void core::VolumeParameters::setAdaptiveSampling ( const bool enabled )

inline

Definition at line 62 of file VolumeParameters.h.

◆ setClipBox()

void core::VolumeParameters::setClipBox ( const Boxd & value )

inline

Definition at line 77 of file VolumeParameters.h.

◆ setDimensions()

void core::VolumeParameters::setDimensions ( const Vector3ui & dim )

inline

Definition at line 41 of file VolumeParameters.h.

◆ setElementSpacing()

void core::VolumeParameters::setElementSpacing ( const Vector3d & spacing )

inline

Definition at line 45 of file VolumeParameters.h.

◆ setGradientOffset()

void core::VolumeParameters::setGradientOffset ( const double value )

inline

Definition at line 53 of file VolumeParameters.h.

◆ setGradientShading()

void core::VolumeParameters::setGradientShading ( const bool enabled )

inline

Definition at line 50 of file VolumeParameters.h.

◆ setPreIntegration()

void core::VolumeParameters::setPreIntegration ( const bool enabled )

inline

Definition at line 59 of file VolumeParameters.h.

◆ setSamplingRate()

void core::VolumeParameters::setSamplingRate ( const double value )

inline

Definition at line 68 of file VolumeParameters.h.

◆ setSingleShade()

void core::VolumeParameters::setSingleShade ( const bool enabled )

inline

Definition at line 56 of file VolumeParameters.h.

◆ setSpecular()

void core::VolumeParameters::setSpecular ( const Vector3d & value )

inline

Definition at line 71 of file VolumeParameters.h.

◆ setUserParameters()

void core::VolumeParameters::setUserParameters ( const Vector3d & value )

inline

Definition at line 74 of file VolumeParameters.h.

Member Data Documentation

◆ _adaptiveMaxSamplingRate

double core::VolumeParameters::_adaptiveMaxSamplingRate {2.}

protected

Definition at line 91 of file VolumeParameters.h.

◆ _adaptiveSampling

bool core::VolumeParameters::_adaptiveSampling {true}

protected

Definition at line 92 of file VolumeParameters.h.

◆ _clipBox

Boxd core::VolumeParameters::_clipBox

protected

Definition at line 95 of file VolumeParameters.h.

◆ _dimensions

Vector3ui core::VolumeParameters::_dimensions

protected

Definition at line 83 of file VolumeParameters.h.

◆ _elementSpacing

Vector3d core::VolumeParameters::_elementSpacing

protected

Definition at line 84 of file VolumeParameters.h.

◆ _gradientOffset

double core::VolumeParameters::_gradientOffset {0.001}

protected

Definition at line 88 of file VolumeParameters.h.

◆ _gradientShading

bool core::VolumeParameters::_gradientShading {false}

protected

Definition at line 87 of file VolumeParameters.h.

◆ _offset

Vector3d core::VolumeParameters::_offset

protected

Definition at line 85 of file VolumeParameters.h.

◆ _preIntegration

bool core::VolumeParameters::_preIntegration {false}

protected

Definition at line 90 of file VolumeParameters.h.

◆ _samplingRate

double core::VolumeParameters::_samplingRate {0.125}

protected

Definition at line 93 of file VolumeParameters.h.

◆ _singleShade

bool core::VolumeParameters::_singleShade {true}

protected

Definition at line 89 of file VolumeParameters.h.

◆ _specular

Vector3d core::VolumeParameters::_specular {0.3, 0.3, 0.3}

protected

Definition at line 94 of file VolumeParameters.h.

◆ _userParameters

Vector3d core::VolumeParameters::_userParameters

protected

Definition at line 96 of file VolumeParameters.h.

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

platform/core/parameters/VolumeParameters.h
platform/core/parameters/VolumeParameters.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VolumeParameters()

Member Function Documentation

◆ getAdaptiveMaxSamplingRate()

◆ getAdaptiveSampling()

◆ getClipBox()

◆ getDimensions()

◆ getElementSpacing()

◆ getGradientOffset()

◆ getGradientShading()

◆ getOffset()

◆ getPreIntegration()

◆ getSamplingRate()

◆ getSingleShade()

◆ getSpecular()

◆ getUserParameters()

◆ parse()

◆ print()

◆ setAdaptiveMaxSamplingRate()

◆ setAdaptiveSampling()

◆ setClipBox()

◆ setDimensions()

◆ setElementSpacing()

◆ setGradientOffset()

◆ setGradientShading()

◆ setPreIntegration()

◆ setSamplingRate()

◆ setSingleShade()

◆ setSpecular()

◆ setUserParameters()

Member Data Documentation

◆ _adaptiveMaxSamplingRate

◆ _adaptiveSampling

◆ _clipBox

◆ _dimensions

◆ _elementSpacing

◆ _gradientOffset

◆ _gradientShading

◆ _offset

◆ _preIntegration

◆ _samplingRate

◆ _singleShade

◆ _specular

◆ _userParameters