Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
HPS::RGBColor Class Reference

#include <hps.h>

Collaboration diagram for HPS::RGBColor:
Collaboration graph
[legend]

Public Member Functions

HPS_INLINE RGBColor ()
 
HPS_INLINE RGBColor (float r, float g, float b)
 
HPS_INLINE RGBColor (RGB24Color const &c24)
 
HPS_INLINE RGBColor (float gray)
 
HPS_INLINE RGBColor (RGBAS32Color const &c32)
 
HPS_INLINE RGBColor (RGBA32Color const &c32)
 
HPS_INLINE RGBColor (RGBAColor const &c)
 
HPS_INLINE bool IsGray () const
 
HPS_INLINE float Gray () const
 
float Distance (RGBColor const &other_color) const
 
HPS_INLINE bool IsValid () const
 
HPS_INLINE bool operator== (RGBColor const &c) const
 
HPS_INLINE bool operator!= (RGBColor const &c) const
 
HPS_INLINE bool Equals (RGBColor const &c, int in_tolerance=32) const
 
HPS_INLINE RGBColor & operator*= (RGBColor const &c)
 
HPS_INLINE RGBColor & operator+= (RGBColor const &c)
 
HPS_INLINE RGBColor & operator-= (RGBColor const &c)
 
HPS_INLINE RGBColor const operator* (RGBColor const &c) const
 
HPS_INLINE RGBColor const operator+ (RGBColor const &c) const
 
HPS_INLINE RGBColor const operator- (RGBColor const &c) const
 
HPS_INLINE RGBColor & operator*= (float s)
 
HPS_INLINE RGBColor & operator/= (float s)
 
HPS_INLINE RGBColor & operator+= (float s)
 
HPS_INLINE RGBColor & operator-= (float s)
 
HPS_INLINE RGBColor const operator* (float s) const
 
HPS_INLINE RGBColor const operator/ (float s) const
 
HPS_INLINE RGBColor const operator+ (float s) const
 
HPS_INLINE RGBColor const operator- (float s) const
 
void ShowHLS (float &out_hue, float &out_lightness, float &out_saturation) const
 
void ShowHSV (float &out_hue, float &out_saturation, float &out_value) const
 
void ShowHIC (float &out_hue, float &out_intensity, float &out_chromaticity) const
 

Static Public Member Functions

static HPS_INLINE RGBColor Black ()
 
static HPS_INLINE RGBColor White ()
 
static HPS_INLINE RGBColor Invalid ()
 
static RGBColor HLS (float in_hue, float in_lightness, float in_saturation)
 
static RGBColor HSV (float in_hue, float in_saturation, float in_value)
 
static RGBColor HIC (float in_hue, float in_intensity, float in_chromaticity)
 

Public Attributes

float red
 
float green
 
float blue
 

Constructor & Destructor Documentation

◆ RGBColor() [1/7]

HPS_INLINE HPS::RGBColor::RGBColor ( )
inline

◆ RGBColor() [2/7]

HPS_INLINE HPS::RGBColor::RGBColor ( float  r,
float  g,
float  b 
)
inline

◆ RGBColor() [3/7]

HPS_INLINE HPS::RGBColor::RGBColor ( RGB24Color const &  c24)
explicit
Here is the call graph for this function:

◆ RGBColor() [4/7]

HPS_INLINE HPS::RGBColor::RGBColor ( float  gray)
inlineexplicit

◆ RGBColor() [5/7]

HPS_INLINE HPS::RGBColor::RGBColor ( RGBAS32Color const &  c32)
explicit
Here is the call graph for this function:

◆ RGBColor() [6/7]

HPS_INLINE HPS::RGBColor::RGBColor ( RGBA32Color const &  c32)
explicit
Here is the call graph for this function:

◆ RGBColor() [7/7]

HPS_INLINE HPS::RGBColor::RGBColor ( RGBAColor const &  c)
explicit

Member Function Documentation

◆ Black()

static HPS_INLINE RGBColor HPS::RGBColor::Black ( )
inlinestatic
Here is the caller graph for this function:

◆ Distance()

float HPS::RGBColor::Distance ( RGBColor const &  other_color) const

◆ Equals()

HPS_INLINE bool HPS::RGBColor::Equals ( RGBColor const &  c,
int  in_tolerance = 32 
) const
inline
Here is the call graph for this function:

◆ Gray()

HPS_INLINE float HPS::RGBColor::Gray ( ) const
inline

◆ HIC()

static RGBColor HPS::RGBColor::HIC ( float  in_hue,
float  in_intensity,
float  in_chromaticity 
)
static

◆ HLS()

static RGBColor HPS::RGBColor::HLS ( float  in_hue,
float  in_lightness,
float  in_saturation 
)
static

◆ HSV()

static RGBColor HPS::RGBColor::HSV ( float  in_hue,
float  in_saturation,
float  in_value 
)
static

◆ Invalid()

static HPS_INLINE RGBColor HPS::RGBColor::Invalid ( )
inlinestatic

◆ IsGray()

HPS_INLINE bool HPS::RGBColor::IsGray ( ) const
inline

◆ IsValid()

HPS_INLINE bool HPS::RGBColor::IsValid ( ) const
inline
Here is the call graph for this function:

◆ operator!=()

HPS_INLINE bool HPS::RGBColor::operator!= ( RGBColor const &  c) const
inline

◆ operator*() [1/2]

HPS_INLINE RGBColor const HPS::RGBColor::operator* ( RGBColor const &  c) const
inline

◆ operator*() [2/2]

HPS_INLINE RGBColor const HPS::RGBColor::operator* ( float  s) const
inline

◆ operator*=() [1/2]

HPS_INLINE RGBColor& HPS::RGBColor::operator*= ( RGBColor const &  c)
inline

◆ operator*=() [2/2]

HPS_INLINE RGBColor& HPS::RGBColor::operator*= ( float  s)
inline

◆ operator+() [1/2]

HPS_INLINE RGBColor const HPS::RGBColor::operator+ ( RGBColor const &  c) const
inline

◆ operator+() [2/2]

HPS_INLINE RGBColor const HPS::RGBColor::operator+ ( float  s) const
inline

◆ operator+=() [1/2]

HPS_INLINE RGBColor& HPS::RGBColor::operator+= ( RGBColor const &  c)
inline

◆ operator+=() [2/2]

HPS_INLINE RGBColor& HPS::RGBColor::operator+= ( float  s)
inline

◆ operator-() [1/2]

HPS_INLINE RGBColor const HPS::RGBColor::operator- ( RGBColor const &  c) const
inline

◆ operator-() [2/2]

HPS_INLINE RGBColor const HPS::RGBColor::operator- ( float  s) const
inline

◆ operator-=() [1/2]

HPS_INLINE RGBColor& HPS::RGBColor::operator-= ( RGBColor const &  c)
inline

◆ operator-=() [2/2]

HPS_INLINE RGBColor& HPS::RGBColor::operator-= ( float  s)
inline

◆ operator/()

HPS_INLINE RGBColor const HPS::RGBColor::operator/ ( float  s) const
inline
Here is the call graph for this function:

◆ operator/=()

HPS_INLINE RGBColor& HPS::RGBColor::operator/= ( float  s)
inline

◆ operator==()

HPS_INLINE bool HPS::RGBColor::operator== ( RGBColor const &  c) const
inline

◆ ShowHIC()

void HPS::RGBColor::ShowHIC ( float &  out_hue,
float &  out_intensity,
float &  out_chromaticity 
) const

◆ ShowHLS()

void HPS::RGBColor::ShowHLS ( float &  out_hue,
float &  out_lightness,
float &  out_saturation 
) const

◆ ShowHSV()

void HPS::RGBColor::ShowHSV ( float &  out_hue,
float &  out_saturation,
float &  out_value 
) const

◆ White()

static HPS_INLINE RGBColor HPS::RGBColor::White ( )
inlinestatic

Member Data Documentation

◆ blue

float HPS::RGBColor::blue

◆ green

float HPS::RGBColor::green

◆ red

float HPS::RGBColor::red
The documentation for this class was generated from the following file: