COLORSPREADMGR Class Reference

Manager for color spreads. More...

#include <mi32/colorspreadmgr.h>

List of all members.

Static Public Member Functions
static double	Compute (COLOR_ARRAY &ColorArray, const COLOR &ColorBegin, const COLOR &ColorEnd, COLORSPREAD::PATH path, int NumColors, int StartIndex=-1)
static const MISTRINGLIST &	GetNameListStd ()
static const MISTRINGLIST &	GetNameListUser ()
static MISTRING	GetTitleStd (const MISTRING &name)
static ERRVALUE	LoadStd (const MISTRING &name, COLOR_ARRAY &ColorArray, int NumColors=0)
static ERRVALUE	LoadUser (const MISTRING &name, COLOR_ARRAY &ColorArray, int NumColors=0)
static ERRVALUE	SaveUser (const MISTRING &name, const COLOR_ARRAY &ColorArray)

---

Detailed Description

Manager for color spreads.

---

Member Function Documentation

static double COLORSPREADMGR::Compute	(	COLOR_ARRAY &	ColorArray,
		const COLOR &	ColorBegin,
		const COLOR &	ColorEnd,
		COLORSPREAD::PATH	path,
		int	NumColors,
		int	StartIndex = -1
	)			[static]

Compute color spread.

Parameters:

	ColorArray	Array to contain
	ColorBegin	Beginning color
	ColorEnd	Ending color
	path	Spread path
	NumColors	Number of colors to compute (or replace if StartIndex != -1)
	StartIndex	Starting index in existing array to replace, -1 to replace all

static const MISTRINGLIST& COLORSPREADMGR::GetNameListStd

(

)

[static]

Get list of standard color spreads.

static const MISTRINGLIST& COLORSPREADMGR::GetNameListUser

(

)

[static]

Get list of user-saved color spreads.

static MISTRING COLORSPREADMGR::GetTitleStd

(

const MISTRING &

name

)

[static]

Get title of standard color spread to display.

Parameters:

name

Standard color spread name

static ERRVALUE COLORSPREADMGR::LoadStd	(	const MISTRING &	name,
		COLOR_ARRAY &	ColorArray,
		int	NumColors = 0
	)			[static]

Load standard color spread.

Parameters:

NumColors

Number of colors in resulting array, 0 to use as originally defined

static ERRVALUE COLORSPREADMGR::LoadUser	(	const MISTRING &	name,
		COLOR_ARRAY &	ColorArray,
		int	NumColors = 0
	)			[static]

Load user-saved color spread.

Parameters:

NumColors

Number of colors in resulting array, 0 to use as originally defined

static ERRVALUE COLORSPREADMGR::SaveUser	(	const MISTRING &	name,
		const COLOR_ARRAY &	ColorArray
	)			[static]

Save user-defined color spread.

---

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

• mi32/colorspreadmgr.h