gls_map_grid.h

Go to the documentation of this file.

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

  \par Copyright Information

  Copyright (c) 2017 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<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_GLSMAPGRID_H
#define INCLUDED_GLSMAPGRID_H

#include "display.h"
#include "events.h"
#include "gls_map_util.h"
#include "gls_map_view.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSMAPGRID ) || defined( GLSGEN_IMPORT_GLSMAPGRID ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSMAPGRID ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSMAPGRID_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSMAPGRID_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSMAPGRID_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

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

namespace disti
{
/** \brief A customizable object that allows the user to display a map grid that can be configured to measure 
  * in degrees for Latitude and Longitude, or meters for Universal Transverse Mercator (UTM) coordinate system.
  */
class GlsMapGrid : public DisplayObject
{
public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef DisplayObject _BaseClass;
    typedef DisplayObject BaseClass;
    friend class GlsMapGridEditor;

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

    /** Destructs a GlsMapGrid object */
    virtual GLSGEN_GLSMAPGRID_EXPORT ~GlsMapGrid();

    static GLSGEN_GLSMAPGRID_EXPORT DisplayObject* CreateInstance();

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

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

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

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

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

    virtual GLSGEN_GLSMAPGRID_EXPORT DisplayObject* handle( DisplayEvent* ev );

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

    //////////////////////////////////////////////////
    // GlsMapGrid 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 default color for the lines
      * \param value color of the line in RGBA
      */
    void     SetColor( const glsColor& value );
    glsColor GetColor();

    enum EGridReference
    {
        GRID_LAT_LON, // Default
        GRID_UTM,
        GRID_MGRS,
        GRID_UTM_SINGLE
    };

    /** Get the current grid reference */
    EGridReference GetGridReference() const { return _referenceSystem; }

    /** Set Display Geo Lat/Lon
      * \param gridLevel is from 1.0 arc-seconds to 20.0 degrees
      */
    void SetDisplayGeoLatLon( double gridLevel );

    /** Set Display in UTM (Universal Transverse Mercator) with a given grid scale (from 10m to 100,000 m) 
      * /param gridScale scale of the grid from 10m to 100,000m
      */
    void SetDisplayUTM( double gridScale );

    /** Set Display in UTM (Universal Transverse Mercator) over the specified zone and band with a given grid scale (from 10m to 100,000 m)
      * /param gridScale scale of the grid from 10m to 100,000m
      * /param zoneNumber zone to set the display in from 1 to 60
      * /param latitudeBandLetter latitude to display
      */
    void SetDisplayUTM( double gridScale, int zoneNumber, char latitudeBandLetter );

protected:
    // The line geometry
    DisplayObject* _defaultPathGeometry;

    // Current grid reference and scale
    EGridReference _referenceSystem;
    double         _scale;
    int            _UTMdrawZone;
    int            _UTMdrawLatBand;

    // Grid Reference work
    void DrawGeoLatLon();
    void DrawGeoLatLonTransverseMercator();
    void DrawUTM();
    void DrawUTM( int zone, int latZoneIndex );
};

} // namespace disti

#endif