AnalogousPalette Class Reference

Functionality for constructing and manipulating Analogous colour schemes. More...

#include <AnalogousPalette.h>

Inheritance diagram for AnalogousPalette:

Public Member Functions
SharedPtrColVec	createPalette (const ofColor &_seedColour)
	Main method for creating analogous colour schemes from a seed colour. More...
void	setAngleDif (const int &_angDif)
	Adjusts the angDif (the difference between the hue angles), and updates the colour vec. More...
	AnalogousPalette (int _angDif=15)
	Construct an Analogous Palette object and set relevant vars. More...
	AnalogousPalette (const AnalogousPalette &old)
	AnalogousPalette's copy constructor. More...
Public Member Functions inherited from TheoryPalette
	TheoryPalette ()
	Constructor used to instantiate member objects, viz. 'colours'.
void	populatePalette (const ColVec &oldVec)
	Populates the colours vector. More...
SharedPtrColVec	generateRandom ()
	Generate a random colour scheme. Useful for quickly generating pleasing colours to use.
Public Member Functions inherited from ColourPalette
	ColourPalette ()
	Constructor used to instantiate member objects, viz. 'colours'.
	ColourPalette (const ColourPalette &old)
	ABS's copy constructor. Creates a 'unique' shared pointer from the old one as we don't want it to point to the previous instantiation's 'colours'.
void	operator= (const ColourPalette &old)
	ABS's assignment operator. Creates a 'unique' shared pointer from the old one as we don't want it to point to the previous instantiation's 'colours'.
SharedPtrColVec	getPalette () const
	Generic colour scheme getter. Returns a shared pointer to the colour scheme itself. More...
void	sortPalette (string channel="hue")
	Used to sort the palette of colours based on chosen channel. More...
void	darken (unsigned int percent)
	Used to darken a colour scheme by a given percentage. More...
void	lighten (unsigned int percent)
	Used to lighten a colour scheme by a given percentage. More...
void	saturate (unsigned int percent)
	Used to saturate a colour scheme by a given percentage. More...
void	desaturate (unsigned int percent)
	Used to desaturate a colour scheme by a given percentage. More...
void	adjustHue (int percent)
	Used to adjust the hue by a given percentage - n.b. can be a negative value. More...

Additional Inherited Members
Static Public Member Functions inherited from ColourPalette
static ofColor	darken (ofColor &col, unsigned int percent)
	Used to darken a colour by a given percentage. More...
static ofColor	lighten (ofColor &col, unsigned int percent)
	Used to lighten a colour by a given percentage. More...
static ofColor	saturate (ofColor &col, unsigned int percent)
	Used to saturate a colour by a given percentage. More...
static ofColor	desaturate (ofColor &col, unsigned int percent)
	Used to desaturate a colour by a given percentage. More...
static ofColor	adjustHue (ofColor &col, int percent)
	Used to adjust the hue by a given percentage - n.b. can be a negative value. More...
Protected Attributes inherited from ColourPalette
SharedPtrColVec	colours
	stores the of representation of the generated colours.
ofColor	seedColour = ofColor(255, 255, 255)
	the base colour with which to generate a scheme from.

Detailed Description

Functionality for constructing and manipulating Analogous colour schemes.

Author

James Oldfield.

Constructor & Destructor Documentation

AnalogousPalette::AnalogousPalette

(

int

_angDif = 15

)

Construct an Analogous Palette object and set relevant vars.

Parameters

_angDif

The amount to space out the colours by.

AnalogousPalette::AnalogousPalette

(

const AnalogousPalette &

old

)

AnalogousPalette's copy constructor.

Parameters

old	A reference to the old palette to copy over.

Member Function Documentation

shared_ptr< vector< ofColor > > AnalogousPalette::createPalette ( const ofColor &  _seedColour )

virtual

Main method for creating analogous colour schemes from a seed colour.

Parameters

_seedColour

The ofColor seed/base colour with which to construct the palette from.

Returns

A shared_ptr<vector<ofColor>> (typedef'd - SharedPtrColVec) to the vector of of colours.

< stores the hue values

< hue angle of the seed colour

Implements TheoryPalette.

void AnalogousPalette::setAngleDif

(

const int &

_angDif

)

Adjusts the angDif (the difference between the hue angles), and updates the colour vec.

Parameters

_angDif

The value to offset the hue values by in the colour scheme by.

---

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

• src/AnalogousPalette.h
• src/AnalogousPalette.cpp