gls_map_symbology.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsMapSymbology 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_GLSMAPSYMBOLOGY_H
#define INCLUDED_GLSMAPSYMBOLOGY_H

#include "gls_map_symbology_data_source.h"
#include "gls_map_view.h"

#include "events.h"
#include "group.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
{
class GlsMapSymbologyStdDataSource;

/** 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.
  */
class GlsMapSymbology : public Group
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef Group _BaseClass;
    typedef Group BaseClass;
    friend class GlsMapSymbologyEditor;

    /** Create a new GlsMapSymbology.
      * \param generateInstance  Whether or not to generate an instance name
      * for this inputdevice */
    GLSGEN_GLSMAPSYMBOLOGY_EXPORT GlsMapSymbology( bool generateInstance = false );

    /** Destructs a GlsMapSymbology object */
    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT ~GlsMapSymbology();

    static GLSGEN_GLSMAPSYMBOLOGY_EXPORT DisplayObject* CreateInstance();

    //////////////////////////////////////////////////
    // Overridden base class methods
    //////////////////////////////////////////////////

    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT void SetAvailableAttributes( unsigned int value );
    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT DisplayObject* CloneObject( bool generateNames = false );
    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT void           CopyProperties( DisplayObject* src );

    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL );
    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array );

    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler );
    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT void Draw( void );

    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT DisplayObject* Pick3D( const Vector& winLoc,
        const Vector&                                                          logicalCoords,
        float                                                                  scale,
        const Vector&                                                          directionVector,
        Vector&                                                                collisionWinLoc /*Returned*/,
        const OpenGLMatrices&                                                  drawnMatrices );

    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT DisplayObject* handle( DisplayEvent* ev );

    virtual GLSGEN_GLSMAPSYMBOLOGY_EXPORT void SetValue( int spec, va_list& args );

    //////////////////////////////////////////////////
    // GlsMapSymbology specific operations
    //////////////////////////////////////////////////

    /** \returns pointer to the GlsMapView that the symbology will use for rendering
      * or NULL if not found. */
    inline GlsMapView* GetMapView()
    {
        return GetParentMapView( this );
    }

    /** Set the MapSymbologyDataSource to use for rendering.
      * The creator of the MapSymbologyDataSource instance is responsible for deleting it.
      * \param database Pointer to the MapSymbologyDataSource to use
      */
    virtual void SetDataSource( GlsMapSymbologyDataSource* database );

    /** Returns the MapSymbologyDataSource that this object is using.
      * This may be the default GlsMapSymbologyStdDataSource or another data source
      * that was provided using the SetDataSource() method.
      * \returns pointer to the MapSymbologyDataSource this GlsMapSymbology is using. */
    inline GlsMapSymbologyDataSource* GetDataSource() { return _dataSource; }

    /** \returns pointer to the GlsMapSymbologyStdDataSource for this symbology or
      * NULL if another type of data source is being used. */
    GlsMapSymbologyStdDataSource* GetStdDataSource();

    /** Utility method that can be called by the user from the GlsMapView event callback
      * to determine if any symbols were picked.  If the method returns true, 
      * then iconsHit and pathsHit will contain the list of icons and paths
      * that were picked.
      * NOTE: This method uses the generic MapSymbologyDataSource interface in it's picking
      * algorithm.  If you are using a derived DataSource class that has it's own picking
      * method, it will probably be faster than this method.
      * \param view The GlsMapView that was picked
      * \param lev A LocationEvent indicating the point that was picked
      * \param iconsHit IconIDList to receive the list of icons that were picked
      * \param pathsHit PathIDList to receive the list of paths that were picked
      * \returns true if an icon or path was picked */
    virtual bool PickSymbols( GlsMapView* view, LocationEvent* lev, GlsMapSymbologyDataSource::IconIDList* iconsHit, GlsMapSymbologyDataSource::PathIDList* pathsHit );

    /** Set the default color for path lines
      * This is only used if the MapSymbologyDataSource does not
      * provide geometry for the paths */
    void     SetDefaultPathColor( const glsColor& value );
    glsColor GetDefaultPathColor();

protected:
    GlsMapSymbologyDataSource*    _dataSource;
    GlsMapSymbologyStdDataSource* _internalDataSource;

    DisplayObject* _defaultPathGeometry;
};

} // namespace disti

// Included after GlsMapSymbology has been defined
#include "gls_map_symbology_basic_data_source.h"
#include "gls_map_symbology_standard_data_source.h"

#endif