GL Studio C++ Runtime API
GlsDNCStdAppearance Class Reference

#include <gls_dnc_std_appearance.h>

Public Types

enum  Palette
 Color palette IDs.
 
enum  PaletteColor
 Color palette enumeration.
 

Public Member Functions

 GlsDNCStdAppearance ()
 Constructor.
 
 ~GlsDNCStdAppearance ()
 Destructor.
 
void SetPalette (const Palette pal)
 
Palette GetPalette (void)
 
void SetPaletteColor (const Palette pal, PaletteColor colorEnum, const glsColor &colorVal)
 
const glsColorGetPaletteColor (const Palette pal, PaletteColor colorEnum)
 
void ResetPaletteColors (const Palette pal)
 

Static Public Member Functions

static void ConfigLibrary (void *const userData, DNCMapChartDataSource &dncSource, const int libNum)
 

Detailed Description

The GlsDNCStdAppearance class contains the data and methods to configure a DNCMapChartDataSource with a standard set of icons and features.

Member Function Documentation

static void ConfigLibrary ( void *const  userData,
DNCMapChartDataSource dncSource,
const int  libNum 
)
static

The GlsDNCStdAppearance::ConfigLibrary routine is called by the DNCMapChartDataSource whenever a new library is loaded in order to allow the appearance library to setup the library render settings.

See also
DNCMapChartDataSource::SetConfigLibCB
Palette GetPalette ( void  )
Returns
The id of the currently selected color palette
const glsColor& GetPaletteColor ( const Palette  pal,
PaletteColor  colorEnum 
)

Get a palette color value

Parameters
palThe id of the palette
colorEnumThe id of the color
void ResetPaletteColors ( const Palette  pal)

Reset the given color palette to use the default colors

Parameters
palThe id of the palette to reset
void SetPalette ( const Palette  pal)

Select which color palette to use for rendering.

Parameters
palThe id of the palette to use
void SetPaletteColor ( const Palette  pal,
PaletteColor  colorEnum,
const glsColor colorVal 
)

Change the color in a palette

Parameters
palThe id of the palette
colorEnumThe id of the color
colorValThe new color value

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