Zivid C++ API 2.13.1+18e79e79-1
Zivid::Settings::Processing::Resampling Class Reference

Settings for changing the output resolution of the point cloud. More...

#include <Zivid/Settings.h>

Classes

class  Mode
 Setting for upsampling or downsampling the point cloud data by some factor. This operation is performed after all other processing has been completed. More...
 

Public Types

using Descendants = std::tuple<Settings::Processing::Resampling::Mode>
 

Public Member Functions

 Resampling ()
 Default constructor.
 
template<typename... Args>
 Resampling (Args &&...args)
 Constructor taking variadic number of arguments.
 
template<typename... Args>
void set (Args &&...args)
 Set multiple arguments.
 
template<typename... Args>
Resampling copyWith (Args &&...args) const
 Returns a copy of this object with the given argument(s) set to the new value(s)
 
const Modemode () const
 Get Mode.
 
Modemode ()
 Get Mode.
 
Resamplingset (const Mode &value)
 Set Mode.
 
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Resampling::Mode >::value, int >::type = 0>
const Settings::Processing::Resampling::Modeget () const
 
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::Processing::Resampling::Modeget () 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 Resampling &other) const
 Equality operator.
 
bool operator!= (const Resampling &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 char * path { "Processing/Resampling" }
 The full path for this value.
 
static constexpr const char * name { "Resampling" }
 The name of this value.
 
static constexpr const char * description
 The description for this value.
 

Friends

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

Detailed Description

Settings for changing the output resolution of the point cloud.

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Resampling() [1/2]

Zivid::Settings::Processing::Resampling::Resampling ( )

Default constructor.

◆ Resampling() [2/2]

template<typename... Args>
Zivid::Settings::Processing::Resampling::Resampling ( 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 Resampling then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>
Resampling Zivid::Settings::Processing::Resampling::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 Resampling 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 Resampling. These types can be provided:

◆ forEach() [1/2]

template<typename F >
void Zivid::Settings::Processing::Resampling::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::Resampling::forEach ( const F & f) const
inline

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

◆ get() [1/2]

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

◆ get() [2/2]

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

◆ mode() [1/2]

Mode & Zivid::Settings::Processing::Resampling::mode ( )
inline

Get Mode.

◆ mode() [2/2]

const Mode & Zivid::Settings::Processing::Resampling::mode ( ) const
inline

Get Mode.

◆ operator!=()

bool Zivid::Settings::Processing::Resampling::operator!= ( const Resampling & other) const

Inequality operator.

◆ operator==()

bool Zivid::Settings::Processing::Resampling::operator== ( const Resampling & other) const

Equality operator.

◆ set() [1/2]

template<typename... Args>
void Zivid::Settings::Processing::Resampling::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 Resampling. These types can be provided:

◆ set() [2/2]

Resampling & Zivid::Settings::Processing::Resampling::set ( const Mode & value)
inline

Set Mode.

◆ toString()

std::string Zivid::Settings::Processing::Resampling::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Resampling >

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

◆ operator<<

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

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::Settings::Processing::Resampling::description
staticconstexpr
Initial value:
{
R"description(Settings for changing the output resolution of the point cloud.
)description"
}

The description for this value.

◆ name

const char* Zivid::Settings::Processing::Resampling::name { "Resampling" }
staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Settings::Processing::Resampling::nodeType = DataModel::NodeType::group
staticconstexpr

The type of this node.

◆ path

const char* Zivid::Settings::Processing::Resampling::path { "Processing/Resampling" }
staticconstexpr

The full path for this value.


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