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

Contains filters that can be used to deal with holes in the point cloud. More...

#include <Zivid/Settings.h>

Classes

class  Repair
 Fills in point cloud holes by interpolating remaining surrounding points. More...
 

Public Types

using Descendants
 

Public Member Functions

 Hole ()
 Default constructor.
 
template<typename... Args>
 Hole (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
Hole copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const Repairrepair () const
 Get Repair.
 
Repairrepair ()
 Get Repair.
 
Holeset (const Repair &value)
 Set Repair.
 
Holeset (const Repair::Enabled &value)
 Set Repair::Enabled.
 
Holeset (const Repair::HoleSize &value)
 Set Repair::HoleSize.
 
Holeset (const Repair::Strictness &value)
 Set Repair::Strictness.
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repairget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::Enabledget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::HoleSize >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::HoleSizeget () const
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Strictness >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::Strictnessget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Hole::Repairget () const
 
template<typename F >
void forEach (const F &f) const
 Run the given function on each direct member with the value of the member as parameter.
 
template<typename F >
void forEach (const F &f)
 Run the given function on each direct member with the value of the member as parameter.
 
bool operator== (const Hole &other) const
 Equality operator.
 
bool operator!= (const Hole &other) const
 Inequality operator.
 
std::string toString () const
 Get the value as string.
 

Static Public Attributes

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

Friends

struct DataModel::Detail::Befriend< Hole >
 
std::ostream & operator<< (std::ostream &stream, const Hole &value)
 Operator to send the value as string to a stream.
 

Detailed Description

Contains filters that can be used to deal with holes in the point cloud.

Member Typedef Documentation

◆ Descendants

Initial value:
std::tuple<
Settings::Processing::Filters::Hole::Repair,
Settings::Processing::Filters::Hole::Repair::Enabled,
Settings::Processing::Filters::Hole::Repair::HoleSize,
Settings::Processing::Filters::Hole::Repair::Strictness>

Constructor & Destructor Documentation

◆ Hole() [1/2]

Zivid::Settings::Processing::Filters::Hole::Hole ( )

Default constructor.

◆ Hole() [2/2]

template<typename... Args>
Zivid::Settings::Processing::Filters::Hole::Hole ( Args &&... args)
inlineexplicit

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Hole then invoking set(args).

The provided arguments must be descendants of Hole. These types can be provided:

Member Function Documentation

◆ copyWith()

template<typename... Args>
Hole Zivid::Settings::Processing::Filters::Hole::copyWith ( Args &&... args) const
inline

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Hole object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Hole. These types can be provided:

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings::Processing::Filters::Hole::forEach ( const F & f)
inline

Run the given function on each direct member with the value of the member as parameter.

◆ forEach() [2/2]

template<typename F >
void Zivid::Settings::Processing::Filters::Hole::forEach ( const F & f) const
inline

Run the given function on each direct member with the value of the member as parameter.

◆ get() [1/5]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair & Zivid::Settings::Processing::Filters::Hole::get ( ) const
inline

◆ get() [2/5]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Enabled >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::Enabled & Zivid::Settings::Processing::Filters::Hole::get ( ) const
inline

◆ get() [3/5]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::HoleSize >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::HoleSize & Zivid::Settings::Processing::Filters::Hole::get ( ) const
inline

◆ get() [4/5]

template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Filters::Hole::Repair::Strictness >::value, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair::Strictness & Zivid::Settings::Processing::Filters::Hole::get ( ) const
inline

◆ get() [5/5]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Filters::Hole::Repair & Zivid::Settings::Processing::Filters::Hole::get ( ) const
inline

◆ operator!=()

Inequality operator.

◆ operator==()

Equality operator.

◆ repair() [1/2]

Repair & Zivid::Settings::Processing::Filters::Hole::repair ( )
inline

Get Repair.

◆ repair() [2/2]

const Repair & Zivid::Settings::Processing::Filters::Hole::repair ( ) const
inline

Get Repair.

◆ set() [1/5]

template<typename... Args>
void Zivid::Settings::Processing::Filters::Hole::set ( Args &&... args)
inline

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Hole. These types can be provided:

◆ set() [2/5]

Hole & Zivid::Settings::Processing::Filters::Hole::set ( const Repair & value)
inline

Set Repair.

◆ set() [3/5]

Hole & Zivid::Settings::Processing::Filters::Hole::set ( const Repair::Enabled & value)
inline

◆ set() [4/5]

Hole & Zivid::Settings::Processing::Filters::Hole::set ( const Repair::HoleSize & value)
inline

◆ set() [5/5]

Hole & Zivid::Settings::Processing::Filters::Hole::set ( const Repair::Strictness & value)
inline

◆ toString()

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

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Hole >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings::Processing::Filters::Hole::description
staticconstexpr
Initial value:
{
R"description(Contains filters that can be used to deal with holes in the point cloud.)description"
}

The description for this value.

◆ name

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

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings::Processing::Filters::Hole::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

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

The full path for this value.


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