ACloudViewer  3.9.4
A Modern Library for 3D Data Processing
ccScalarField::Range Class Reference

Scalar field range structure. More...

#include <ecvScalarField.h>

Public Member Functions

 Range ()
 Default constructor. More...
 
ScalarType min () const
 
ScalarType start () const
 
ScalarType stop () const
 
ScalarType max () const
 
ScalarType range () const
 
ScalarType maxRange () const
 
void setBounds (ScalarType minVal, ScalarType maxVal, bool resetStartStop=true)
 
void setStart (ScalarType value)
 
void setStop (ScalarType value)
 
ScalarType inbound (ScalarType val) const
 Returns the nearest inbound value. More...
 
bool isInbound (ScalarType val) const
 Returns whether a value is inbound or not. More...
 
bool isInRange (ScalarType val) const
 Returns whether a value is inside range or not. More...
 

Protected Member Functions

void updateRange ()
 Updates actual range. More...
 

Protected Attributes

ScalarType m_min
 
ScalarType m_start
 
ScalarType m_stop
 
ScalarType m_max
 
ScalarType m_range
 

Detailed Description

Scalar field range structure.

Definition at line 36 of file ecvScalarField.h.

Constructor & Destructor Documentation

◆ Range()

ccScalarField::Range::Range ( )
inline

Default constructor.

Definition at line 39 of file ecvScalarField.h.

Member Function Documentation

◆ inbound()

ScalarType ccScalarField::Range::inbound ( ScalarType  val) const
inline

Returns the nearest inbound value.

Definition at line 78 of file ecvScalarField.h.

Referenced by define_ccScalarField(), and cloudViewer::utility::pybind_scalarfield().

◆ isInbound()

bool ccScalarField::Range::isInbound ( ScalarType  val) const
inline

Returns whether a value is inbound or not.

Definition at line 82 of file ecvScalarField.h.

Referenced by define_ccScalarField(), and cloudViewer::utility::pybind_scalarfield().

◆ isInRange()

bool ccScalarField::Range::isInRange ( ScalarType  val) const
inline

Returns whether a value is inside range or not.

Definition at line 86 of file ecvScalarField.h.

Referenced by define_ccScalarField(), ccSNECloud::drawMeOnly(), and cloudViewer::utility::pybind_scalarfield().

◆ max()

◆ maxRange()

ScalarType ccScalarField::Range::maxRange ( ) const
inline

◆ min()

◆ range()

ScalarType ccScalarField::Range::range ( ) const
inline

◆ setBounds()

void ccScalarField::Range::setBounds ( ScalarType  minVal,
ScalarType  maxVal,
bool  resetStartStop = true 
)
inline

◆ setStart()

void ccScalarField::Range::setStart ( ScalarType  value)
inline

◆ setStop()

void ccScalarField::Range::setStop ( ScalarType  value)
inline

◆ start()

◆ stop()

◆ updateRange()

void ccScalarField::Range::updateRange ( )
inlineprotected

Updates actual range.

Definition at line 92 of file ecvScalarField.h.

References max(), and ZERO_TOLERANCE_SCALAR.

Member Data Documentation

◆ m_max

ScalarType ccScalarField::Range::m_max
protected

Minimum value

Definition at line 99 of file ecvScalarField.h.

◆ m_min

ScalarType ccScalarField::Range::m_min
protected

Minimum value

Definition at line 96 of file ecvScalarField.h.

◆ m_range

ScalarType ccScalarField::Range::m_range
protected

Actual range: start-stop (but can't be ZERO!)

Definition at line 101 of file ecvScalarField.h.

◆ m_start

ScalarType ccScalarField::Range::m_start
protected

Current start value (in [min,max])

Definition at line 97 of file ecvScalarField.h.

◆ m_stop

ScalarType ccScalarField::Range::m_stop
protected

Current stop value (in [min,max])

Definition at line 98 of file ecvScalarField.h.


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