The ambient light detected by the camera. More...

#include <Zivid/SceneConditions.h>

Classes
class	FlickerClassification
	A classification of the detected ambient light flicker, if any. The values `grid50hz` and `grid60hz` indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value `unknownFlicker` indicates that some significant time-varying ambient light was detected, but it did not match the characteristics of a standard power grid. More...

Public Types
using	Descendants = std::tuple<SceneConditions::AmbientLight::FlickerClassification>

Public Member Functions
	AmbientLight ()
	Default constructor.

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

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

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

const FlickerClassification &	flickerClassification () const
	Get FlickerClassification.

FlickerClassification &	flickerClassification ()
	Get FlickerClassification.

AmbientLight &	set (const FlickerClassification &value)
	Set FlickerClassification.

template<typename T , typename std::enable_if< std::is_same< T, SceneConditions::AmbientLight::FlickerClassification >::value, int >::type = 0>
const SceneConditions::AmbientLight::FlickerClassification &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const SceneConditions::AmbientLight::FlickerClassification &	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 AmbientLight &other) const
	Equality operator.

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

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

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

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

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

Detailed Description

The ambient light detected by the camera.

Member Typedef Documentation

◆ Descendants

using Zivid::SceneConditions::AmbientLight::Descendants = std::tuple<SceneConditions::AmbientLight::FlickerClassification>

Constructor & Destructor Documentation

◆ AmbientLight() [1/2]

Zivid::SceneConditions::AmbientLight::AmbientLight ( )

Default constructor.

◆ AmbientLight() [2/2]

template<typename... Args>

Zivid::SceneConditions::AmbientLight::AmbientLight ( 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 AmbientLight then invoking set(args).

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

SceneConditions::AmbientLight::FlickerClassification

Member Function Documentation

◆ copyWith()

template<typename... Args>

AmbientLight Zivid::SceneConditions::AmbientLight::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 AmbientLight 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 AmbientLight. These types can be provided:

SceneConditions::AmbientLight::FlickerClassification

◆ flickerClassification() [1/2]

FlickerClassification & Zivid::SceneConditions::AmbientLight::flickerClassification ( )

inline

Get FlickerClassification.

◆ flickerClassification() [2/2]

const FlickerClassification & Zivid::SceneConditions::AmbientLight::flickerClassification ( ) const

inline

Get FlickerClassification.

◆ forEach() [1/2]

template<typename F >

void Zivid::SceneConditions::AmbientLight::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::SceneConditions::AmbientLight::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, SceneConditions::AmbientLight::FlickerClassification >::value, int >::type = 0>

const SceneConditions::AmbientLight::FlickerClassification & Zivid::SceneConditions::AmbientLight::get ( ) const

inline

◆ get() [2/2]

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

const SceneConditions::AmbientLight::FlickerClassification & Zivid::SceneConditions::AmbientLight::get ( ) const

inline

◆ operator!=()

bool Zivid::SceneConditions::AmbientLight::operator!= ( const AmbientLight & other ) const

Inequality operator.

◆ operator==()

bool Zivid::SceneConditions::AmbientLight::operator== ( const AmbientLight & other ) const

Equality operator.

◆ set() [1/2]

template<typename... Args>

void Zivid::SceneConditions::AmbientLight::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 AmbientLight. These types can be provided:

SceneConditions::AmbientLight::FlickerClassification

◆ set() [2/2]

AmbientLight & Zivid::SceneConditions::AmbientLight::set ( const FlickerClassification & value )

inline

Set FlickerClassification.

◆ toString()

std::string Zivid::SceneConditions::AmbientLight::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< AmbientLight >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

const char* Zivid::SceneConditions::AmbientLight::description

staticconstexpr

Initial value:

{ R"description(The ambient light detected by the camera.

)description" }

The description for this value.

◆ name

const char* Zivid::SceneConditions::AmbientLight::name { "AmbientLight" }

staticconstexpr

The name of this value.

◆ nodeType

DataModel::NodeType Zivid::SceneConditions::AmbientLight::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

const char* Zivid::SceneConditions::AmbientLight::path { "AmbientLight" }

staticconstexpr

The full path for this value.

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

Zivid/SceneConditions.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ AmbientLight() [1/2]

◆ AmbientLight() [2/2]

Member Function Documentation

◆ copyWith()

◆ flickerClassification() [1/2]

◆ flickerClassification() [2/2]

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ operator!=()

◆ operator==()

◆ set() [1/2]

◆ set() [2/2]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< AmbientLight >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path