GridColorScheme Class Reference

A grid color scheme defines how a grid will be colored. More...

List of all members.

Public Member Functions
void	Clear ()
	Clears all color breaks in the color scheme.
void	DeleteBreak (int Index)
	Deletes the specified color break from the color scheme.
void	Deserialize (string newVal)
	Restores the setings of the grid from the string generated by Grid.Serialize() method.
GridColorBreak	get_Break (int Index)
	Gets a break from the color scheme using the specified index.
string	get_ErrorMsg (int ErrorCode)
	Retrieves the error message associated with the specified error code.
Vector	GetLightSource ()
	Gets the direction the light source is pointing for the color scheme in the form of a vector which originates from the light source. This only applies to hillshaded breaks.
void	InsertAt (int Position, GridColorBreak Break)
	Inserts a break at the specified position of the color scheme.
void	InsertBreak (GridColorBreak BrkInfo)
	Adds a break to the color scheme.
string	Serialize ()
	Serializes the setting of the grid to the string.
void	SetLightSource (double Azimuth, double Elevation)
	Sets the direction of the light source.
void	UsePredefined (double LowValue, double HighValue, PredefinedColorScheme Preset)
	Loads the values into the color scheme from pre-defined color scheme.
Properties
double	AmbientIntensity [get, set]
	Gets or sets the intensity of the ambient lighting for the color scheme. Only applies when creating hillshaded breaks.
ICallback	GlobalCallback [get, set]
	The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.
string	Key [get, set]
	The key may be used by the programmer to store any string data associated with the object.
int	LastErrorCode [get]
	Retrieves the last error generated in the object.
double	LightSourceAzimuth [get]
	Gets the azimuth, or compass heading of the light source. Only applies to hillshaded breaks.
double	LightSourceElevation [get]
	Gets the elevation of the light source. Only applies to hillshaded breaks.
double	LightSourceIntensity [get, set]
	Gets or sets the intensity of the light source for the color scheme. Only applies to hillshaded breaks.
uint	NoDataColor [get, set]
	The color to use for the color scheme when drawing grid cells with a no-data value.
int	NumBreaks [get]
	Gets the number of color breaks in the color scheme.

---

Detailed Description

A grid color scheme defines how a grid will be colored.

A grid color scheme may either contain grid color breaks created by the user, or may use a predefined color scheme.

---

Member Function Documentation

void GridColorScheme.Clear

(

)

Clears all color breaks in the color scheme.

void GridColorScheme.DeleteBreak

(

int

Index

)

Deletes the specified color break from the color scheme.

Parameters:

Index

The index of the color break to be removed.

void GridColorScheme.Deserialize

(

string

newVal

)

Restores the setings of the grid from the string generated by Grid.Serialize() method.

Parameters:

newVal

The string with grid settings.

GridColorBreak GridColorScheme.get_Break

(

int

Index

)

Gets a break from the color scheme using the specified index.

Parameters:

Index

The index of the color break to be returned.

Returns:

The color break specified by the index.

string GridColorScheme.get_ErrorMsg

(

int

ErrorCode

)

Retrieves the error message associated with the specified error code.

Parameters:

ErrorCode

The error code for which the error message is required.

Returns:

The error message description for the specified error code.

Vector GridColorScheme.GetLightSource

(

)

Gets the direction the light source is pointing for the color scheme in the form of a vector which originates from the light source. This only applies to hillshaded breaks.

Returns:

The direction the light source is pointing represented by a vector.

void GridColorScheme.InsertAt	(	int	Position,
		GridColorBreak	Break
	)

Inserts a break at the specified position of the color scheme.

Parameters:

Position	The position to insert the break at.
Break	The grid color break.

void GridColorScheme.InsertBreak

(

GridColorBreak

BrkInfo

)

Adds a break to the color scheme.

Parameters:

BrkInfo

The grid color break.

string GridColorScheme.Serialize

(

)

Serializes the setting of the grid to the string.

Returns:

The string with serialized setting of empty string on failure.

void GridColorScheme.SetLightSource	(	double	Azimuth,
		double	Elevation
	)

Sets the direction of the light source.

Parameters:

Azimuth	The azimuth heading of the light source. Also known as the compass heading.
Elevation	The elevation of the light source.

void GridColorScheme.UsePredefined	(	double	LowValue,
		double	HighValue,
		PredefinedColorScheme	Preset
	)

Loads the values into the color scheme from pre-defined color scheme.

Parameters:

LowValue	The lowest value in the grid.
HighValue	The highes value in the grid.
Preset	Optional. The pre-defined color scheme to be used. The default is MapWinGIS.PredefinedColorScheme.SummerMountains.

---

Property Documentation

double GridColorScheme.AmbientIntensity [get, set]

Gets or sets the intensity of the ambient lighting for the color scheme. Only applies when creating hillshaded breaks.

ICallback GridColorScheme.GlobalCallback [get, set]

The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.

string GridColorScheme.Key [get, set]

The key may be used by the programmer to store any string data associated with the object.

int GridColorScheme.LastErrorCode [get]

Retrieves the last error generated in the object.

double GridColorScheme.LightSourceAzimuth [get]

Gets the azimuth, or compass heading of the light source. Only applies to hillshaded breaks.

double GridColorScheme.LightSourceElevation [get]

Gets the elevation of the light source. Only applies to hillshaded breaks.

double GridColorScheme.LightSourceIntensity [get, set]

Gets or sets the intensity of the light source for the color scheme. Only applies to hillshaded breaks.

uint GridColorScheme.NoDataColor [get, set]

The color to use for the color scheme when drawing grid cells with a no-data value.

int GridColorScheme.NumBreaks [get]

Gets the number of color breaks in the color scheme.