Loading...
Searching...
No Matches
SBDPaletteQualitative Class Reference

The SBDPaletteQualitative class is a base class for qualitative color palettes. More...

Palette parameters

int hue1
 The starting value for the first coordinate.
 
int hue2
 The end value for the first coordinate.
 
int chroma
 The value of the second coordinate.
 
int luminance
 The value of the third coordinate.
 

Constructors and destructors

 SBDPaletteQualitative ()
 Default constructor.
 
 SBDPaletteQualitative (int hue1, int hue2, int chroma=50, int luminance=70, std::string name=std::string(""))
 
 SBDPaletteQualitative (const SBDPaletteQualitative &otherColorPalette)
 Copy constructor.
 
virtual ~SBDPaletteQualitative ()
 

Serialization

virtual bool isSerializable () const override
 Returns true.
 
virtual void serialize (SBCSerializer *serializer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) const override
 Serializes the document.
 
virtual void unserialize (SBCSerializer *serializer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) override
 Unserializes the document.
 

Cloning

virtual SBDPaletteQualitativeclone () const override
 Clones the color palette.
 

Getter and setter functions

int getHue1 () const
 Returns the starting value for the first coordinate.
 
void setHue1 (int hue1)
 Sets the starting value for the first coordinate.
 
int getHue2 () const
 Returns the end value for the first coordinate.
 
void setHue2 (int hue2)
 Sets the end value for the first coordinate.
 
void setHue (int hue1, int hue2)
 Sets the parameters for the first coordinate.
 
int getChroma () const
 Returns the value for the second coordinate.
 
void setChroma (int chroma)
 Sets the value for the second coordinate.
 
int getLuminance () const
 Returns the value for the third coordinate.
 
void setLuminance (int luminance)
 Sets the value for the third coordinate.
 

Palette functions

virtual void getColor (float *color, float value) const override
 Computes sRGB color color based on this palette for the given intensity value value which should be in the range [0.0, 1.0].
 
virtual void getColorInPaletteColorSpace (float *color, float value) const override
 Computes color coordinates color in this palette's color space for the given intensity value value which should be in the range [0.0, 1.0].
 

Additional Inherited Members

- Public Types inherited from SBDPalette
enum class  PaletteType {
  Custom ,
  Qualitative ,
  Sequential ,
  Diverging ,
  FlexibleDiverging
}
 
- Public Member Functions inherited from SBDPalette
 SBDPalette ()
 Default constructor.
 
virtual ~SBDPalette ()
 
PaletteType getType () const
 Returns the type of the color palette.
 
void setType (SBDPalette::PaletteType paletteType)
 Sets the type of the color palette.
 
const std::string & getName () const
 Returns the palette's name.
 
void setName (const std::string &name)
 Sets the palette's name to name.
 
bool getReverseFlag () const
 Returns the reverse flag - whether the color palette is mirrored or not.
 
void setReverseFlag (bool b)
 Sets the reverse flag - whether to mirror or not the color palette.
 
SBColor getColor (float value) const
 Returns SBColor based on the palette and an intensity value value.
 
- Static Public Member Functions inherited from SBDPalette
static float getValueAlongLinearTrajectory (float y1, float y2, float power, float x)
 Returns a value along the "linear" trajectory.
 
static float getValueAlongTriangularTrajectory (float y1, float ymax, float y2, float power, float x)
 Returns a value along "triangular" trajectory.
 
- Protected Attributes inherited from SBDPalette
PaletteType paletteType
 The palette's type.
 
std::string * name
 The palette's name.
 
bool reverseFlag
 Reverse flag: if true, then the palette is reversed/mirrored.
 

Detailed Description

A qualitative palette is constructed in a 3D color coordinate space with coordinates named h, c, and l, where the coordinate h can have an arbitrary value, and coordinates c and l are constant: h = hue1 + i * (hue2 - hue1), where i is a value (of intensity) based on which the colorization should be done. c = const l = const

Coordinate h can designate e.g. hue (as in HCL, HSV, HSL color spaces). Coordinate c can designate e.g. chroma (as in HCL color space) or saturation (as in HSV, HSL color spaces). Coordinate l can designate e.g. luminance (as in HCL color space), lightning (as in HSL color space), or another value (as in HSV color space).

Member Function Documentation

◆ clone()

SBDPaletteQualitative * SBDPaletteQualitative::clone ( ) const
overridevirtual

Reimplemented from SBDPalette.

Reimplemented in SBDPaletteQualitativeHCL.

◆ getColor()

void SBDPaletteQualitative::getColor ( float *  color,
float  value 
) const
overridevirtual

Reimplemented from SBDPalette.

Reimplemented in SBDPaletteQualitativeHCL.

◆ getColorInPaletteColorSpace()

void SBDPaletteQualitative::getColorInPaletteColorSpace ( float *  color,
float  value 
) const
overridevirtual

SBDPaletteQualitative::getColorInPaletteColorSpace - Computes color coordinates color in this palette's color space for the given intensity value value.

Parameters
color- an array for color coordinates (float[3]).
value- an intensity value based on which the resulting color is computed, the intensity value should be in range [0.0, 1.0] where 1 corresponds to the full intensity.

Reimplemented from SBDPalette.

Reimplemented in SBDPaletteQualitativeHCL.

◆ isSerializable()

bool SBDPaletteQualitative::isSerializable ( ) const
overridevirtual

Reimplemented from SBDPalette.

Reimplemented in SBDPaletteQualitativeHCL.

◆ serialize()

void SBDPaletteQualitative::serialize ( SBCSerializer serializer,
const SBVersionNumber sdkVersionNumber = SB_SDK_VERSION_NUMBER,
const SBVersionNumber classVersionNumber = SBVersionNumber(1, 0, 0) 
) const
overridevirtual

Reimplemented from SBDPalette.

Reimplemented in SBDPaletteQualitativeHCL.

◆ unserialize()

void SBDPaletteQualitative::unserialize ( SBCSerializer serializer,
const SBVersionNumber sdkVersionNumber = SB_SDK_VERSION_NUMBER,
const SBVersionNumber classVersionNumber = SBVersionNumber(1, 0, 0) 
)
overridevirtual

Reimplemented from SBDPalette.

Reimplemented in SBDPaletteQualitativeHCL.