The spica renderer
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
spica::RGBSpectrum Class Reference

RGB spectrum. More...

#include <spectrum.h>

Public Member Functions

 RGBSpectrum ()
 The RGBSpectrum constructor. More...
 
 RGBSpectrum (double l)
 
 RGBSpectrum (double red, double green, double blue)
 The RGBSpectrum constructor. More...
 
 RGBSpectrum (const std::vector< double > &nm, const std::vector< double > &values)
 The RGBSpectrum constructor.
 
 RGBSpectrum (const RGBSpectrum &RGBSpectrum)
 The RGBSpectrum constructor (copy)
 
 ~RGBSpectrum ()
 The RGBSpectrum destructor.
 
RGBSpectrumoperator= (const RGBSpectrum &c)
 Assignment operator.
 
bool operator== (const RGBSpectrum &c) const
 Equal operator.
 
bool operator!= (const RGBSpectrum &c) const
 Not equal operator.
 
RGBSpectrumoperator+= (const RGBSpectrum &c)
 Plus operator.
 
RGBSpectrumoperator+= (double x)
 Plus operator. More...
 
RGBSpectrumoperator-= (const RGBSpectrum &c)
 Minus operator. More...
 
RGBSpectrumoperator-= (double x)
 Minus operator. More...
 
RGBSpectrumoperator*= (const RGBSpectrum &c)
 Component-wise multiplication. More...
 
RGBSpectrumoperator*= (double s)
 Scalar multiplication. More...
 
RGBSpectrumoperator/= (const RGBSpectrum &c)
 Component-wise division.
 
RGBSpectrumoperator/= (double s)
 Scalar division.
 
RGBSpectrum operator- () const
 Negation operator.
 
bool isBlack () const
 
bool isInf () const
 
bool isNaN () const
 
bool isValid () const
 
double dot (const RGBSpectrum &RGBSpectrum) const
 
double norm () const
 
double squaredNorm () const
 
double gray () const
 
double red () const
 Red component. More...
 
double green () const
 Green component.
 
double blue () const
 Blue component.
 
double operator[] (int i) const
 Element accessor. More...
 
double & ref (int i)
 Element accessor. More...
 
RGBSpectrum toRGB () const
 Convert to RGB spcetrum. More...
 
std::string toString () const
 Covert to string. More...
 

Static Public Member Functions

static RGBSpectrum fromXYZ (double x, double y, double z)
 
static RGBSpectrum minimum (const RGBSpectrum &c1, const RGBSpectrum &c2)
 
static RGBSpectrum maximum (const RGBSpectrum &c1, const RGBSpectrum &c2)
 
static RGBSpectrum sqrt (const RGBSpectrum &c)
 
static RGBSpectrum exp (const RGBSpectrum &c)
 
static RGBSpectrum log (const RGBSpectrum &c)
 
static RGBSpectrum clamp (const RGBSpectrum &c, const RGBSpectrum &lo=RGBSpectrum(0.0, 0.0, 0.0), const RGBSpectrum &hi=RGBSpectrum(INFTY, INFTY, INFTY))
 

Static Public Attributes

static const int channels = 3
 

Detailed Description

RGB spectrum.

Constructor & Destructor Documentation

spica::RGBSpectrum::RGBSpectrum ( )

The RGBSpectrum constructor.

spica::RGBSpectrum::RGBSpectrum ( double  red,
double  green,
double  blue 
)

The RGBSpectrum constructor.

Parameters
redRed component.
greenGreen component.
blueBlue component.

Member Function Documentation

RGBSpectrum & spica::RGBSpectrum::operator*= ( const RGBSpectrum c)

Component-wise multiplication.

RGBSpectrum & spica::RGBSpectrum::operator*= ( double  s)

Scalar multiplication.

RGBSpectrum & spica::RGBSpectrum::operator+= ( double  x)

Plus operator.

Add the same value x to each RGBSpectrum component.

RGBSpectrum & spica::RGBSpectrum::operator-= ( const RGBSpectrum c)

Minus operator.

RGBSpectrum & spica::RGBSpectrum::operator-= ( double  x)

Minus operator.

Subtract the same value x from each RGBSpectrum component

double spica::RGBSpectrum::operator[] ( int  i) const
inline

Element accessor.

double spica::RGBSpectrum::red ( ) const
inline

Red component.

double& spica::RGBSpectrum::ref ( int  i)
inline

Element accessor.

RGBSpectrum spica::RGBSpectrum::toRGB ( ) const
inline

Convert to RGB spcetrum.

std::string spica::RGBSpectrum::toString ( ) const

Covert to string.


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