Removes points that reside outside of a depth range, meaning that their Z coordinate falls above a given maximum or below a given minimum. More...

#include <Zivid/Settings.h>

Classes
class	Enabled
	Enable or disable depth filter. More...

class	Range
	Specify the minimum and maximum Z value that will be included. More...

Public Types
using	Descendants

Public Member Functions
	Depth ()
	Default constructor.

template<typename... Args>
	Depth (Args &&...args)
	Constructor taking variadic number of arguments.

template<typename... Args>
void	set (Args &&...args)
	Set multiple arguments.

template<typename... Args>
Depth	copyWith (Args &&...args) const
	Returns a copy of this object with the given argument(s) set to the new value(s)

const Enabled &	isEnabled () const
	Get Enabled.

Enabled &	isEnabled ()
	Get Enabled.

Depth &	set (const Enabled &value)
	Set Enabled.

const Range &	range () const
	Get Range.

Range &	range ()
	Get Range.

Depth &	set (const Range &value)
	Set Range.

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Enabled >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth::Enabled &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Range >::value, int >::type = 0>
const Settings::RegionOfInterest::Depth::Range &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings::RegionOfInterest::Depth::Enabled &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings::RegionOfInterest::Depth::Range &	get () 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 Depth &other) const
	Equality operator.

bool	operator!= (const Depth &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 { "RegionOfInterest/Depth" }
	The full path for this value.

static constexpr const char *	name { "Depth" }
	The name of this value.

static constexpr const char *	description
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< Depth >

std::ostream &	operator<< (std::ostream &stream, const Depth &value)
	Operator to send the value as string to a stream.

Detailed Description

Removes points that reside outside of a depth range, meaning that their Z coordinate falls above a given maximum or below a given minimum.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings::RegionOfInterest::Depth::Descendants

Initial value:

std::tuple<Settings::RegionOfInterest::Depth::Enabled, Settings::RegionOfInterest::Depth::Range>

Constructor & Destructor Documentation

◆ Depth() [1/2]

Zivid::Settings::RegionOfInterest::Depth::Depth ( )

Default constructor.

◆ Depth() [2/2]

template<typename... Args>

Zivid::Settings::RegionOfInterest::Depth::Depth ( 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 Depth then invoking set(args).

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

Member Function Documentation

◆ copyWith()

template<typename... Args>

Depth Zivid::Settings::RegionOfInterest::Depth::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 Depth 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 Depth. These types can be provided:

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings::RegionOfInterest::Depth::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::RegionOfInterest::Depth::forEach ( const F & f ) const

inline

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

◆ get() [1/4]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Enabled >::value, int >::type = 0>

const Settings::RegionOfInterest::Depth::Enabled & Zivid::Settings::RegionOfInterest::Depth::get ( ) const

inline

◆ get() [2/4]

template<typename T , typename std::enable_if< std::is_same< T, Settings::RegionOfInterest::Depth::Range >::value, int >::type = 0>

const Settings::RegionOfInterest::Depth::Range & Zivid::Settings::RegionOfInterest::Depth::get ( ) const

inline

◆ get() [3/4]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const Settings::RegionOfInterest::Depth::Enabled & Zivid::Settings::RegionOfInterest::Depth::get ( ) const

inline

◆ get() [4/4]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const Settings::RegionOfInterest::Depth::Range & Zivid::Settings::RegionOfInterest::Depth::get ( ) const

inline

◆ isEnabled() [1/2]

Enabled & Zivid::Settings::RegionOfInterest::Depth::isEnabled ( )

inline

Get Enabled.

◆ isEnabled() [2/2]

const Enabled & Zivid::Settings::RegionOfInterest::Depth::isEnabled ( ) const

inline

Get Enabled.

◆ operator!=()

bool Zivid::Settings::RegionOfInterest::Depth::operator!= ( const Depth & other ) const

Inequality operator.

◆ operator==()

bool Zivid::Settings::RegionOfInterest::Depth::operator== ( const Depth & other ) const

Equality operator.

◆ range() [1/2]

Range & Zivid::Settings::RegionOfInterest::Depth::range ( )

inline

Get Range.

◆ range() [2/2]

const Range & Zivid::Settings::RegionOfInterest::Depth::range ( ) const

inline

Get Range.

◆ set() [1/3]

template<typename... Args>

void Zivid::Settings::RegionOfInterest::Depth::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 Depth. These types can be provided:

◆ set() [2/3]

Depth & Zivid::Settings::RegionOfInterest::Depth::set ( const Enabled & value )

inline

Set Enabled.

◆ set() [3/3]

Depth & Zivid::Settings::RegionOfInterest::Depth::set ( const Range & value )

inline

Set Range.

◆ toString()

std::string Zivid::Settings::RegionOfInterest::Depth::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Depth >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::Settings::RegionOfInterest::Depth::description

staticconstexpr

Initial value:

{
                    R"description(Removes points that reside outside of a depth range, meaning that their Z coordinate
falls above a given maximum or below a given minimum.
)description"
                }

The description for this value.

◆ name

const char* Zivid::Settings::RegionOfInterest::Depth::name { "Depth" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::Settings::RegionOfInterest::Depth::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::Settings::RegionOfInterest::Depth::path { "RegionOfInterest/Depth" }

staticconstexpr

The full path for this value.

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

Zivid/Settings.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Depth() [1/2]

◆ Depth() [2/2]

Member Function Documentation

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/4]

◆ get() [2/4]

◆ get() [3/4]

◆ get() [4/4]

◆ isEnabled() [1/2]

◆ isEnabled() [2/2]

◆ operator!=()

◆ operator==()

◆ range() [1/2]

◆ range() [2/2]

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Depth >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path