gls_dnc_std_appearance.h

Go to the documentation of this file.

#ifndef GLS_DNC_STD_APPEARANCE_H
#define GLS_DNC_STD_APPEARANCE_H

/*! \file
  \brief GlsDNCStdAppearance class declaration

  \par Copyright Information

  Copyright (C) 2006 by Distributed Simulation Technology, Inc.<br>
  Orlando, FL USA<br>
  All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of 
  Distributed Simulation Technology, Inc., and embodies substantial creative 
  efforts as well as confidential information, ideas, and expressions.  No part 
  or all of this software may be reproduced in any form, or by any means of 
  electronic, mechanical, or otherwise, without the written permission of 
  Distributed Simulation Technology, Inc.

  This library is distributed in the hope that it will be useful, but 
  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  or FITNESS FOR A PARTICULAR PURPOSE. 

  Use of this software implies acceptance of the GL Studio licensing terms.

*/

#include "gls_map_dnc.h"

#define LIB_BASE_NAME "gls_dnc_std_appearance"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME

namespace disti
{
class GlsDNCStdAppearanceData;

/** The GlsDNCStdAppearance class contains the data and methods
  * to configure a DNCMapChartDataSource with a standard set of
  * icons and features.
  */
class GlsDNCStdAppearance
{
public:
    /// Constructor
    GlsDNCStdAppearance();

    /// Destructor
    ~GlsDNCStdAppearance();

    /** 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.
      *
      * \sa DNCMapChartDataSource::SetConfigLibCB
      */
    static void ConfigLibrary( void* const userData, DNCMapChartDataSource& dncSource, const int libNum );

    /// Color palette IDs
    enum Palette
    {
        PALETTE_DAY,
        PALETTE_NIGHT
    };

    /** Select which color palette to use for rendering.
      * \param pal The id of the palette to use
      */
    void SetPalette( const Palette pal );

    /** \returns The id of the currently selected color palette
      */
    Palette GetPalette( void );

    /// Color palette enumeration
    enum PaletteColor
    {
        PALETTE_ECR_ECRAREA_GROUND_SURFACE = 0, // The main land surface
        PALETTE_ECR_ECRAREA_ISLAND,             // Any land that is an island
        PALETTE_ECR_ECRAREA_WATER,              // All water areas (not really seen because other areas usually overide it)
        PALETTE_ECR_ECRAREA_FORESHORE_WATER,    // Areas exposed by the low tide and covered by high tide
        PALETTE_ECR_COASTL_COASTLINE,           // Lines seperating land / water
        PALETTE_ECR_ECRTEXT_NAMED_LOCATION,     // Area names
        PALETTE_ECR_FORESHOL_FORESHORE_WATER,   // Lines seperating foreshore land / water

        PALETTE_LCR_LANDAREA_EMBANK, // Embankment (marsh/swamp)

        PALETTE_LIM_LIMBNDYA_LIMIT_BOUNDARY,  // Water lane area
        PALETTE_LIM_LIMBNDYL_LIMIT_BOUNDARY,  // Water lane seperating line
        PALETTE_LIM_LIMBNDYA_ANCHORAGE,       // Anchorage area
        PALETTE_LIM_LIMBNDYL_ANCHORAGE,       // Anchorage line
        PALETTE_LIM_LIMBNDYA_RESTRICTED_AREA, // Restricted area
        PALETTE_LIM_LIMBNDYL_RESTRICTED_AREA, // Restricted area line

        PALETTE_HYD_SOUNDP_SOUNDING_PT_SHALLOW,  // Shallow water sounding text
        PALETTE_HYD_SOUNDP_SOUNDING_PT_DEEP,     // Deep water sounding text
        PALETTE_HYD_HYDAREA_DEPTH_CURVE_SHALLOW, // Shallow water areas (overides PALETTE_ECR_ECRAREA_WATER)
        PALETTE_HYD_HYDAREA_DEPTH_CURVE_DEEP,    // Deep water areas (overides PALETTE_ECR_ECRAREA_WATER)

        PALETTE_IWY_LAKEA_LAKE,              // Lake area
        PALETTE_IWY_LAKEA_RESERVOIR,         // Reservoir area
        PALETTE_IWY_RIVERL_INLAND_SHORELINE, // Lines separating lake / land
        PALETTE_IWY_RIVERA_RIVER_STREAM,     // River area
        PALETTE_IWY_RIVERL_RIVER_STREAM,     // Lines seperating river / land
        PALETTE_IWY_CANALA_CANAL,            // Canal area
        PALETTE_IWY_CANALL_CANAL,            // Canal line

        PALETTE_CUL_LANDMRKA_BUILT_UP_AREA,          // Built up areas
        PALETTE_CUL_LANDMRKA_BUILT_UP_AREA_BOUNDARY, // Lines seperating built up areas / land
        PALETTE_CUL_TRANSL_ROAD,                     // Road lines
        PALETTE_CUL_RAILRDL_RAILROAD,                // Railroad lines

        PALETTE_OBS_BRIDGEL_BRIDGE, // Bridge line

        PALETTE_POR_STRUCTRL_BREAKWATER,
        PALETTE_POR_PIERL_PIER, // Pier lines extending from shore

        PALETTE_NUM_ENTRIES
    };

    /** Change the color in a palette
      * \param pal The id of the palette
      * \param colorEnum The id of the color
      * \param colorVal The new color value
      */
    void SetPaletteColor( const Palette pal, PaletteColor colorEnum, const glsColor& colorVal );

    /** Get a palette color value
      * \param pal The id of the palette
      * \param colorEnum The id of the color 
      */
    const glsColor& GetPaletteColor( const Palette pal, PaletteColor colorEnum );

    /** Reset the given color palette to use the default colors
      * \param pal The id of the palette to reset
      */
    void ResetPaletteColors( const Palette pal );

private:
    // Internal appearance library data
    GlsDNCStdAppearanceData* _data;

    // Disable copy and assignment
    GlsDNCStdAppearance( const GlsDNCStdAppearance& );
    const GlsDNCStdAppearance& operator=( const GlsDNCStdAppearance& );
};

} // namespace disti

#endif