Zivid C++ API 2.12.0+6afd4961-1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
Zivid::Settings::Processing::Filters::Hole::Repair::Strictness Class Reference

Level of strictness when considering if a point should be filled. A higher level of strictness requires a missing point to be surrounded by valid points on more sides in order to be filled. Increasing this will fill fewer points, but it will be less likely to fill gaps that are not circular, for example between two edges. More...

#include <Zivid/Settings.h>

Public Types

using ValueType = int32_t
 The type of the underlying value.
 

Public Member Functions

 Strictness ()=default
 Default constructor.
 
constexpr Strictness (int32_t value)
 Constructor.
 
int32_t value () const
 Get the value.
 
bool hasValue () const
 Check if the value is set.
 
void reset ()
 Reset the node to unset state.
 
std::string toString () const
 Get the value as string.
 
bool operator== (const Strictness &other) const
 Comparison operator.
 
bool operator!= (const Strictness &other) const
 Comparison operator.
 
bool operator< (const Strictness &other) const
 Comparison operator.
 
bool operator> (const Strictness &other) const
 Comparison operator.
 
bool operator<= (const Strictness &other) const
 Comparison operator.
 
bool operator>= (const Strictness &other) const
 Comparison operator.
 

Static Public Member Functions

static constexpr Range< int32_tvalidRange ()
 The range of valid values for Strictness.
 

Static Public Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue
 The type of this node.
 
static constexpr const charpath { "Processing/Filters/Hole/Repair/Strictness" }
 The full path for this value.
 
static constexpr const charname { "Strictness" }
 The name of this value.
 
static constexpr const chardescription
 The description for this value.
 

Friends

struct DataModel::Detail::Befriend< Strictness >
 
std::ostream & operator<< (std::ostream &stream, const Strictness &value)
 Operator to serialize the value to a stream.
 

Detailed Description

Level of strictness when considering if a point should be filled. A higher level of strictness requires a missing point to be surrounded by valid points on more sides in order to be filled. Increasing this will fill fewer points, but it will be less likely to fill gaps that are not circular, for example between two edges.

Member Typedef Documentation

◆ ValueType

The type of the underlying value.

Constructor & Destructor Documentation

◆ Strictness() [1/2]

Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::Strictness ( )
default

Default constructor.

◆ Strictness() [2/2]

constexpr Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::Strictness ( int32_t value)
inlineexplicitconstexpr

Constructor.

Member Function Documentation

◆ hasValue()

bool Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::hasValue ( ) const

Check if the value is set.

◆ operator!=()

bool Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::operator!= ( const Strictness & other) const
inline

Comparison operator.

◆ operator<()

bool Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::operator< ( const Strictness & other) const
inline

Comparison operator.

◆ operator<=()

bool Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::operator<= ( const Strictness & other) const
inline

Comparison operator.

◆ operator==()

bool Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::operator== ( const Strictness & other) const
inline

Comparison operator.

◆ operator>()

bool Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::operator> ( const Strictness & other) const
inline

Comparison operator.

◆ operator>=()

bool Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::operator>= ( const Strictness & other) const
inline

Comparison operator.

◆ reset()

void Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::reset ( )

Reset the node to unset state.

◆ toString()

std::string Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::toString ( ) const

Get the value as string.

◆ validRange()

static constexpr Range< int32_t > Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::validRange ( )
inlinestaticconstexpr

The range of valid values for Strictness.

◆ value()

int32_t Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::value ( ) const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Strictness >

friend struct DataModel::Detail::Befriend< Strictness >
friend

◆ operator<<

std::ostream & operator<< ( std::ostream & stream,
const Strictness & value )
friend

Operator to serialize the value to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::description
staticconstexpr
Initial value:
{
R"description(Level of strictness when considering if a point should be filled. A higher level of
strictness requires a missing point to be surrounded by valid points on more sides in
order to be filled. Increasing this will fill fewer points, but it will be less likely to
fill gaps that are not circular, for example between two edges.
)description"
}

The description for this value.

◆ name

constexpr const char* Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::name { "Strictness" }
staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::nodeType = DataModel::NodeType::leafValue
staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::Settings::Processing::Filters::Hole::Repair::Strictness::path { "Processing/Filters/Hole/Repair/Strictness" }
staticconstexpr

The full path for this value.


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