A grid color scheme defines how a grid will be colored. More...
Public Member Functions | |
void | ApplyColoringType (ColoringType ColoringType) |
A shortcut to apply new coloring type for each of the breaks of the colors scheme. More... | |
bool | ApplyColors (tkColorSchemeType schemeType, ColorScheme scheme, bool gradientWithinCategories) |
Applies specified colors to the exiting breaks of GridColorScheme. More... | |
void | ApplyGradientModel (GradientModel GradientModel) |
A shortcut to apply gradient model for each of the breaks of the colors scheme. More... | |
void | Clear () |
Clears all color breaks in the color scheme. More... | |
void | DeleteBreak (int Index) |
Deletes the specified color break from the color scheme. More... | |
void | Deserialize (string newVal) |
Restores the setings of the grid from the string generated by Grid.Serialize() method. More... | |
GridColorBreak | get_Break (int Index) |
Gets a break from the color scheme using the specified index. More... | |
string | get_ErrorMsg (int ErrorCode) |
Retrieves the error message associated with the specified error code. More... | |
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. More... | |
void | InsertAt (int Position, GridColorBreak Break) |
Inserts a break at the specified position of the color scheme. More... | |
void | InsertBreak (GridColorBreak BrkInfo) |
Adds a break to the color scheme. More... | |
bool | ReadFromFile (string mwlegFilename, string nodeName) |
Reads color scheme from .mwleg XML file. More... | |
string | Serialize () |
Serializes the setting of the grid to the string. More... | |
void | SetLightSource (double Azimuth, double Elevation) |
Sets the direction of the light source. More... | |
void | UsePredefined (double LowValue, double HighValue, PredefinedColorScheme Preset) |
Loads the values into the color scheme from pre-defined color scheme. More... | |
bool | WriteToFile (string mwlegFilename, string gridName="", int bandIndex=1) |
Writes color scheme to the specified file. More... | |
Properties | |
double | AmbientIntensity [get, set] |
Gets or sets the intensity of the ambient lighting for the color scheme. Only applies when creating hillshaded breaks. More... | |
ICallback | GlobalCallback [get, set] |
The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications. More... | |
string | Key [get, set] |
The key may be used by the programmer to store any string data associated with the object. More... | |
int | LastErrorCode [get] |
Retrieves the last error generated in the object. More... | |
double | LightSourceAzimuth [get] |
Gets the azimuth, or compass heading of the light source. Only applies to hillshaded breaks. More... | |
double | LightSourceElevation [get] |
Gets the elevation of the light source. Only applies to hillshaded breaks. More... | |
double | LightSourceIntensity [get, set] |
Gets or sets the intensity of the light source for the color scheme. Only applies to hillshaded breaks. More... | |
uint | NoDataColor [get, set] |
The color to use for the color scheme when drawing grid cells with a no-data value. More... | |
int | NumBreaks [get] |
Gets the number of color breaks in the color scheme. More... | |
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.
void GridColorScheme.ApplyColoringType | ( | ColoringType | ColoringType | ) |
A shortcut to apply new coloring type for each of the breaks of the colors scheme.
ColoringType | New coloring type. |
bool GridColorScheme.ApplyColors | ( | tkColorSchemeType | schemeType, |
ColorScheme | scheme, | ||
bool | gradientWithinCategories | ||
) |
Applies specified colors to the exiting breaks of GridColorScheme.
schemeType | Type of the scheme. |
scheme | Colors to apply. |
gradientWithinCategories | If true gradient within each category will be set. |
void GridColorScheme.ApplyGradientModel | ( | GradientModel | GradientModel | ) |
A shortcut to apply gradient model for each of the breaks of the colors scheme.
GradientModel | New gradient model. |
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.
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.
newVal | The string with grid settings. |
GridColorBreak GridColorScheme.get_Break | ( | int | Index | ) |
Gets a break from the color scheme using the specified index.
Index | The index of the color break to be returned. |
string GridColorScheme.get_ErrorMsg | ( | int | ErrorCode | ) |
Retrieves the error message associated with the specified error code.
ErrorCode | The error code for which the error message is required. |
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.
void GridColorScheme.InsertAt | ( | int | Position, |
GridColorBreak | Break | ||
) |
Inserts a break at the specified position of the color scheme.
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.
BrkInfo | The grid color break. |
bool GridColorScheme.ReadFromFile | ( | string | mwlegFilename, |
string | nodeName | ||
) |
Reads color scheme from .mwleg XML file.
mwlegFilename | Filename to read color scheme from. |
nodeName | The name of node to read from (usually GridColoringScheme). |
string GridColorScheme.Serialize | ( | ) |
Serializes the setting of the grid to the string.
void GridColorScheme.SetLightSource | ( | double | Azimuth, |
double | Elevation | ||
) |
Sets the direction of the light source.
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.
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. |
bool GridColorScheme.WriteToFile | ( | string | mwlegFilename, |
string | gridName = "" , |
||
int | bandIndex = 1 |
||
) |
Writes color scheme to the specified file.
mwlegFilename | Filename to write color scheme into. |
gridName | The name of the source grid without path (should be located in the same folder). Default value is empty string. |
bandIndex | Band index the color scheme was created for. Default value is 1. |
|
getset |
Gets or sets the intensity of the ambient lighting for the color scheme. Only applies when creating hillshaded breaks.
|
getset |
The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.
|
getset |
The key may be used by the programmer to store any string data associated with the object.
|
get |
Retrieves the last error generated in the object.
|
get |
Gets the azimuth, or compass heading of the light source. Only applies to hillshaded breaks.
|
get |
Gets the elevation of the light source. Only applies to hillshaded breaks.
|
getset |
Gets or sets the intensity of the light source for the color scheme. Only applies to hillshaded breaks.
|
getset |
The color to use for the color scheme when drawing grid cells with a no-data value.
|
get |
Gets the number of color breaks in the color scheme.