Color settings. More...

#include <Zivid/Settings2D.h>

Classes
class	Balance
	Color balance settings. More...

class	Gamma
	Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker. More...

Public Types
using	Descendants

Public Member Functions
	Color ()
	Default constructor.

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

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

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

const Balance &	balance () const
	Get Balance.

Balance &	balance ()
	Get Balance.

Color &	set (const Balance &value)
	Set Balance.

Color &	set (const Balance::Blue &value)
	Set Balance::Blue.

Color &	set (const Balance::Green &value)
	Set Balance::Green.

Color &	set (const Balance::Red &value)
	Set Balance::Red.

const Gamma &	gamma () const
	Get Gamma.

Gamma &	gamma ()
	Get Gamma.

Color &	set (const Gamma &value)
	Set Gamma.

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Blue &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Green &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0>
const Settings2D::Processing::Color::Balance::Red &	get () const

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Gamma >::value, int >::type = 0>
const Settings2D::Processing::Color::Gamma &	get () const

template<size_t i, typename std::enable_if< i==0, int >::type = 0>
const Settings2D::Processing::Color::Balance &	get () const

template<size_t i, typename std::enable_if< i==1, int >::type = 0>
const Settings2D::Processing::Color::Gamma &	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 Color &other) const
	Equality operator.

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

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

static constexpr const char *	description { R"description(Color settings.)description" }
	The description for this value.

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

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

Detailed Description

Color settings.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings2D::Processing::Color::Descendants

Initial value:

 std::tuple<
                    Settings2D::Processing::Color::Balance,
                    Settings2D::Processing::Color::Balance::Blue,
                    Settings2D::Processing::Color::Balance::Green,
                    Settings2D::Processing::Color::Balance::Red,
                    Settings2D::Processing::Color::Gamma>

Constructor & Destructor Documentation

◆ Color() [1/2]

Zivid::Settings2D::Processing::Color::Color ( )

Default constructor.

◆ Color() [2/2]

template<typename... Args>

Zivid::Settings2D::Processing::Color::Color ( 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 Color then invoking set(args).

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

Member Function Documentation

◆ balance() [1/2]

Balance & Zivid::Settings2D::Processing::Color::balance ( )

inline

Get Balance.

◆ balance() [2/2]

const Balance & Zivid::Settings2D::Processing::Color::balance ( ) const

inline

Get Balance.

◆ copyWith()

template<typename... Args>

Color Zivid::Settings2D::Processing::Color::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 Color 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 Color. These types can be provided:

◆ forEach() [1/2]

template<typename F >

void Zivid::Settings2D::Processing::Color::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::Settings2D::Processing::Color::forEach ( const F & f ) const

inline

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

◆ gamma() [1/2]

Gamma & Zivid::Settings2D::Processing::Color::gamma ( )

inline

Get Gamma.

◆ gamma() [2/2]

const Gamma & Zivid::Settings2D::Processing::Color::gamma ( ) const

inline

Get Gamma.

◆ get() [1/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance & Zivid::Settings2D::Processing::Color::get ( ) const

inline

◆ get() [2/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance::Blue & Zivid::Settings2D::Processing::Color::get ( ) const

inline

◆ get() [3/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance::Green & Zivid::Settings2D::Processing::Color::get ( ) const

inline

◆ get() [4/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0>

const Settings2D::Processing::Color::Balance::Red & Zivid::Settings2D::Processing::Color::get ( ) const

inline

◆ get() [5/7]

template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Gamma >::value, int >::type = 0>

const Settings2D::Processing::Color::Gamma & Zivid::Settings2D::Processing::Color::get ( ) const

inline

◆ get() [6/7]

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

const Settings2D::Processing::Color::Balance & Zivid::Settings2D::Processing::Color::get ( ) const

inline

◆ get() [7/7]

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

const Settings2D::Processing::Color::Gamma & Zivid::Settings2D::Processing::Color::get ( ) const

inline

◆ operator!=()

bool Zivid::Settings2D::Processing::Color::operator!= ( const Color & other ) const

Inequality operator.

◆ operator==()

bool Zivid::Settings2D::Processing::Color::operator== ( const Color & other ) const

Equality operator.

◆ set() [1/6]

template<typename... Args>

void Zivid::Settings2D::Processing::Color::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 Color. These types can be provided:

◆ set() [2/6]

Color & Zivid::Settings2D::Processing::Color::set ( const Balance & value )

inline

Set Balance.

◆ set() [3/6]

Color & Zivid::Settings2D::Processing::Color::set ( const Balance::Blue & value )

inline

Set Balance::Blue.

◆ set() [4/6]

Color & Zivid::Settings2D::Processing::Color::set ( const Balance::Green & value )

inline

Set Balance::Green.

◆ set() [5/6]

Color & Zivid::Settings2D::Processing::Color::set ( const Balance::Red & value )

inline

Set Balance::Red.

◆ set() [6/6]

Color & Zivid::Settings2D::Processing::Color::set ( const Gamma & value )

inline

Set Gamma.

◆ toString()

std::string Zivid::Settings2D::Processing::Color::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Color >

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

friend

◆ operator<<

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

friend

Operator to send the value as string to a stream.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings2D::Processing::Color::description { R"description(Color settings.)description" }

staticconstexpr

The description for this value.

◆ name

constexpr const char* Zivid::Settings2D::Processing::Color::name { "Color" }

staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings2D::Processing::Color::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

constexpr const char* Zivid::Settings2D::Processing::Color::path { "Processing/Color" }

staticconstexpr

The full path for this value.

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

Zivid/Settings2D.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Color() [1/2]

◆ Color() [2/2]

Member Function Documentation

◆ balance() [1/2]

◆ balance() [2/2]

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ gamma() [1/2]

◆ gamma() [2/2]

◆ get() [1/7]

◆ get() [2/7]

◆ get() [3/7]

◆ get() [4/7]

◆ get() [5/7]

◆ get() [6/7]

◆ get() [7/7]

◆ operator!=()

◆ operator==()

◆ set() [1/6]

◆ set() [2/6]

◆ set() [3/6]

◆ set() [4/6]

◆ set() [5/6]

◆ set() [6/6]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Color >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path