COLORSPREAD Class Reference

Color spread definition. More...

#include <mi32/colorspread.h>

List of all members.

Public Types
enum	PATH {   PATH_Longest = 0, PATH_RGB, PATH_HISCW, PATH_HISCCW,   PATH_HBSCW, PATH_HBSCCW, PATH_COUNT }
enum	TYPE { TYPE_Manual = 0, TYPE_Standard = 1, TYPE_User = 2 }
Public Member Functions
	COLORSPREAD ()
	~COLORSPREAD ()
ERRVALUE	ComputePalette (COLOR_ARRAY &palette, int NumColors) const
const COLOR &	GetColorBegin () const
const COLOR &	GetColorEnd () const
const MISTRING &	GetName () const
PATH	GetPath () const
TYPE	GetType () const
void	IniRead (INIHANDLE *inihnd, const char *IniGroup, const char *IniName)
void	IniWrite (INIHANDLE *inihnd, const char *IniGroup, const char *IniName) const
bool	IsReversed () const
void	SetColorBegin (const COLOR &color)
void	SetColorEnd (const COLOR &color)
void	SetManual (const COLOR &ColorBegin, const COLOR &ColorEnd, PATH path)
void	SetNamed (const MISTRING &name, TYPE type=TYPE_Standard)
void	SetPath (PATH path)
void	SetReversed (bool reversed)
void	SetType (TYPE type)
Static Public Member Functions
static const SERIALIZERITEM *	SerialGetItemDef ()

---

Detailed Description

Color spread definition.

---

Member Enumeration Documentation

enum COLORSPREAD::PATH

Enumerator:

PATH_Longest
PATH_RGB
PATH_HISCW
PATH_HISCCW
PATH_HBSCW
PATH_HBSCCW
PATH_COUNT

enum COLORSPREAD::TYPE

Spread type.

Enumerator:

TYPE_Manual
TYPE_Standard
TYPE_User

---

Constructor & Destructor Documentation

COLORSPREAD::COLORSPREAD

(

)

Default constructor.

COLORSPREAD::~COLORSPREAD

(

)

Destructor.

---

Member Function Documentation

ERRVALUE COLORSPREAD::ComputePalette	(	COLOR_ARRAY &	palette,
		int	NumColors
	)			const

Compute color palette.

Parameters:

	palette	Palette to contain result
	NumColors	Number of colors in resulting array, 0 to use as originally defined for TYPE_Standard and TYPE_User

const COLOR& COLORSPREAD::GetColorBegin

(

)

const [inline]

Get beginning color for manual spread.

const COLOR& COLORSPREAD::GetColorEnd

(

)

const [inline]

Get ending color for manual spread.

const MISTRING& COLORSPREAD::GetName

(

)

const [inline]

Get name for standar/user spread.

PATH COLORSPREAD::GetPath

(

)

const [inline]

Get path for manual spread.

TYPE COLORSPREAD::GetType

(

)

const [inline]

Get spread type.

void COLORSPREAD::IniRead	(	INIHANDLE *	inihnd,
		const char *	IniGroup,
		const char *	IniName
	)

Read values from INI file.

void COLORSPREAD::IniWrite	(	INIHANDLE *	inihnd,
		const char *	IniGroup,
		const char *	IniName
	)			const

Write values to INI file.

bool COLORSPREAD::IsReversed

(

)

const [inline]

Get whether reversed.

static const SERIALIZERITEM* COLORSPREAD::SerialGetItemDef

(

)

[static]

Get serializer item definition array.

void COLORSPREAD::SetColorBegin

(

const COLOR &

color

)

[inline]

Set beginning color for manual spread.

void COLORSPREAD::SetColorEnd

(

const COLOR &

color

)

[inline]

Set ending color for manual spread.

void COLORSPREAD::SetManual	(	const COLOR &	ColorBegin,
		const COLOR &	ColorEnd,
		PATH	path
	)			[inline]

Set to manual spread with start/end colors and path.

void COLORSPREAD::SetNamed	(	const MISTRING &	name,
		TYPE	type = TYPE_Standard
	)			[inline]

Set as "named" spread with TYPE_Standard or TYPE_User.

void COLORSPREAD::SetPath

(

PATH

path

)

[inline]

Set manual path.

void COLORSPREAD::SetReversed

(

bool

reversed

)

[inline]

Set whether reversed if not manual.

Parameters:

reversed

True if reversed, False if not

void COLORSPREAD::SetType

(

TYPE

type

)

[inline]

Set type.

Parameters:

type

Spread type

---

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

• mi32/colorspread.h