gls_map_symbology_standard_data_source.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsMapSymbologyStdDataSource class.

  \par Copyright Information

  Copyright (c) 2008 The DiSTI Corporation.<br>
  11486 Corporate Blvd; Suite 190<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef INCLUDED_GLS_MAP_SYMBOLOGY_STANDARD_DATA_SOURCE_H_
#define INCLUDED_GLS_MAP_SYMBOLOGY_STANDARD_DATA_SOURCE_H_

#include "gls_map_symbology_basic_data_source.h"
#include "gls_map_symbology_data_source.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSMAPSYMBOLOGY ) || defined( GLSGEN_IMPORT_GLSMAPSYMBOLOGY ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSMAPSYMBOLOGY ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSMAPSYMBOLOGY_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSMAPSYMBOLOGY_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSMAPSYMBOLOGY_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

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

namespace disti
{
/** The GlsMapSymbology class is a Group that contains a collection of DisplayObjects
  * that can be thought of as 'icon templates'.  When drawing, the MapSymbologyLayer will query
  * it's MapSymbologyDataSource for the list of visible icons and paths, then render them to 
  * the map using the icon templates.  The MapSymbologyDataSource interface is simple, while 
  * still allowing the MapSymbologyDataSource the ability to override the appearance
  * of icons and paths.
  * 
  * When a new GlsMapSymbology instance is first created, it will create it's
  * own GlsMapSymbologyStdDataSource which provides an interface for the user to create/update icons and paths
  * without having to write their own MapSymbologyDataSource class.  While this class provides
  * much of the common functionality that is needed, some users will still want to create their
  * own MapSymbologyDataSource to provide the best performance when working with their own datasets.
  * These users have the option of deriving from the BasicDataSource class (a template class which
  * provides basic functionality) or deriving directly from MapSymbologyDataSource interface
  * to optimize all of the MapSymbologyDataSource code for their data set.
  */
////////////////////////////////////////////////////////
// GlsMapSymbologyStdDataSource
////////////////////////////////////////////////////////

/** Resource storage class used by GlsMapSymbologyStdResourceList */
class GlsMapSymbologyStdNameValuePair
{
public:
    // Get the resource name.  May return NULL.
    const char* GetName() const { return _name; }
    // Get the resource value.  May return NULL.
    const char* GetValue() const { return _value; }

    // Set the resource name.  Passing NULL will free internal storage.
    GLSGEN_GLSMAPSYMBOLOGY_EXPORT void SetName( const char* );
    // Set the resource value.  Passing NULL will free internal storage.
    GLSGEN_GLSMAPSYMBOLOGY_EXPORT void SetValue( const char* );

    GlsMapSymbologyStdNameValuePair()
        : _name( 0 )
        , _nameBufSize( 0 )
        , _value( 0 )
        , _valueBufSize( 0 )
    {}
    GLSGEN_GLSMAPSYMBOLOGY_EXPORT ~GlsMapSymbologyStdNameValuePair();

    GlsMapSymbologyStdNameValuePair& operator=( const GlsMapSymbologyStdNameValuePair& o )
    {
        SetName( o.GetName() );
        SetValue( o.GetValue() );
        return *this;
    }

    GlsMapSymbologyStdNameValuePair( const GlsMapSymbologyStdNameValuePair& o )
        : _name( 0 )
        , _nameBufSize( 0 )
        , _value( 0 )
        , _valueBufSize( 0 )
    {
        *this = o;
    }

protected:
    char* _name;
    int   _nameBufSize;
    char* _value;
    int   _valueBufSize;
};

/** Resource storage class */
class GlsMapSymbologyStdResourceList
{
    friend class GlsMapSymbologyStdDataSource;

public:
    /// Set the value of a resource
    /// The resource is added to the list if it is
    /// not already included
    /// \param name The name of the resource to set
    /// \param value The new value of the resource
    GLSGEN_GLSMAPSYMBOLOGY_EXPORT void SetResource( const char* name, const char* value );

    /// Get the given resource value.  May return NULL.
    const char* GetResource( const char* name );

    GlsMapSymbologyStdNameValuePair* LookupResource( const char* name );

protected:
    typedef DynamicArray<GlsMapSymbologyStdNameValuePair, false> ListType;
    ListType                                                     _resources;
};

/** Icon data storage class used by GlsMapSymbologyStdDataSource
  * Extends GlsMapSymbologyBasicIcon to store resource values that
  * are applied to the geometry before drawing. */
class GlsMapSymbologyStdIcon : public GlsMapSymbologyBasicIcon
{
    friend class GlsMapSymbologyStdDataSource;

public:
    /// Set a resource (property) value for the icon
    inline void SetResource( const char* name, const char* value ) { _resources.SetResource( name, value ); }
    /// Get a resource (property) value for the icon
    inline const char* GetResource( const char* name ) { return _resources.GetResource( name ); }

protected:
    GlsMapSymbologyStdResourceList _resources;
};

/** Path data storage class used by GlsMapSymbologyStdDataSource
  * Extends GlsMapSymbologyBasicPath to store resource values that
  * are applied to the geometry before drawing. */
class GlsMapSymbologyStdPath : public GlsMapSymbologyBasicPath
{
    friend class GlsMapSymbologyStdDataSource;

public:
    /// Set a resource (property) value for the path
    inline void SetResource( const char* name, const char* value ) { _resources.SetResource( name, value ); }
    /// Set a resource (property) value for the path
    inline const char* GetResource( const char* name ) { return _resources.GetResource( name ); }

protected:
    GlsMapSymbologyStdResourceList _resources;
};

/** Std data source used by the GlsMapSymbology class by default.
  * Extends the GlsMapSymbologyBasicDataSource to store resource values that
  * will be applied to the paths/icons when they are drawn. */
class GlsMapSymbologyStdDataSource : public GlsMapSymbologyBasicDataSource<GlsMapSymbologyStdIcon, GlsMapSymbologyStdPath>
{
    GLSGEN_GLSMAPSYMBOLOGY_EXPORT virtual void SetupIconForRendering( GlsMapSymbology* layer, long iconID, DisplayObject* iconGeometry );
    GLSGEN_GLSMAPSYMBOLOGY_EXPORT virtual void SetupPathForRendering( GlsMapSymbology* layer, long pathID, DisplayObject* pathGeometry );
};

} // namespace disti

#endif