The blo Library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
blo::Chromaticity Class Reference

xyz chromaticity. More...

#include <Chromaticity.h>

Public Member Functions

 Chromaticity ()=default
 Default constructor.
 
 Chromaticity (float x, float y, float z)
 Constructs chromaticity and sets coordinates.
 
 Chromaticity (float x, float y)
 Constructs chromaticity and sets coordinates.
 
 Chromaticity (const Chromaticity &rhs)=default
 Copy constructor.
 
 ~Chromaticity ()=default
 Destructor.
 
Chromaticity & operator= (const Chromaticity &rhs)=default
 Assignment operator.
 
void coords (float &x, float &y, float &z) const
 Retrieves chromaticity coordinates.
 
void coords (float &x, float &y) const
 Retrieves chromaticity coordinates.
 
void setCoords (float x, float y, float z)
 Sets chromaticity coordinates.
 
void setCoords (float x, float y)
 Sets chromaticity coordinates.
 
float x () const
 x coordinate of chromaticity.
 
float y () const
 y coordinate of chromaticity.
 
float z () const
 z coordinate of chromaticity.
 

Detailed Description

xyz chromaticity.

Template Parameters
TData type.

Constructor & Destructor Documentation

◆ Chromaticity() [1/4]

blo::Chromaticity::Chromaticity ( )
default

Default constructor.

◆ Chromaticity() [2/4]

blo::Chromaticity::Chromaticity ( float  x,
float  y,
float  z 
)

Constructs chromaticity and sets coordinates.

Note
x + y + z must equal 1
Parameters
xx coordinate of chromaticity.
yy coordinate of chromaticity.
zz coordinate of chromaticity.

◆ Chromaticity() [3/4]

blo::Chromaticity::Chromaticity ( float  x,
float  y 
)

Constructs chromaticity and sets coordinates.

Note
z = 1 - x - y
Parameters
xx coordinate of chromaticity.
yy coordinate of chromaticity.

◆ Chromaticity() [4/4]

blo::Chromaticity::Chromaticity ( const Chromaticity &  rhs)
default

Copy constructor.

◆ ~Chromaticity()

blo::Chromaticity::~Chromaticity ( )
default

Destructor.

Member Function Documentation

◆ coords() [1/2]

void blo::Chromaticity::coords ( float &  x,
float &  y 
) const

Retrieves chromaticity coordinates.

Note
z = 1 - x - y
Parameters
xx coordinate of chromaticity.
yy coordinate of chromaticity.

◆ coords() [2/2]

void blo::Chromaticity::coords ( float &  x,
float &  y,
float &  z 
) const

Retrieves chromaticity coordinates.

Note
x + y + z = 1
Parameters
xx coordinate of chromaticity.
yy coordinate of chromaticity.
zz coordinate of chromaticity.

◆ operator=()

Chromaticity & blo::Chromaticity::operator= ( const Chromaticity &  rhs)
default

Assignment operator.

◆ setCoords() [1/2]

void blo::Chromaticity::setCoords ( float  x,
float  y 
)

Sets chromaticity coordinates.

Note
z = 1 - x - y
Parameters
xx coordinate of chromaticity.
yy coordinate of chromaticity.

◆ setCoords() [2/2]

void blo::Chromaticity::setCoords ( float  x,
float  y,
float  z 
)

Sets chromaticity coordinates.

Note
x + y + z must equal 1
Parameters
xx coordinate of chromaticity.
yy coordinate of chromaticity.
zz coordinate of chromaticity.

◆ x()

float blo::Chromaticity::x ( ) const

x coordinate of chromaticity.

Returns
x coordinate of chromaticity.

◆ y()

float blo::Chromaticity::y ( ) const

y coordinate of chromaticity.

Returns
y coordinate of chromaticity.

◆ z()

float blo::Chromaticity::z ( ) const

z coordinate of chromaticity.

Returns
z coordinate of chromaticity.

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