gls_map_symbology_data_source.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::MapSymbologyDataSource 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_GLSMAPSYMBOLOGYDATASOURCE_H
#define INCLUDED_GLSMAPSYMBOLOGYDATASOURCE_H

#include "dynamic_array.h"
#include "gls_cpp_lang_support.h"
#include "gls_map_util.h"

namespace disti
{
class DisplayObject;
class GlsMapView;
class GlsMapSymbology;

/** abstract interface to the symbology data
 * This interface allows the user to define a new data source to
 * substitute their data for the standard symbology data source.
 * More than one GlsMapSymbology may reference a single MapSymbologyDataSource
 */
class GlsMapSymbologyDataSource
{
public:
    typedef long IconID;
    typedef long PathID;

    typedef DynamicArray<IconID> IconIDList;
    typedef DynamicArray<PathID> PathIDList;

    /// Constructor
    GlsMapSymbologyDataSource() {} // = default

    /// Destructor
    virtual ~GlsMapSymbologyDataSource() {} // = default

    /// Returns the list of symbols (icons and paths) that are visible in the given region.
    virtual void GetSymbolsInRegion( disti::GlsMapSymbology* symbology, const disti::GeoRect& region, IconIDList& icons, PathIDList& paths ) = 0;

    /// Returns the DisplayObject to use for rendering the given icon or NULL if no icon should be drawn
    /// \param iconID Must be a valid icon ID (obtained from GetSymbolsInRegion())
    /// \param symbology symbology group that contains the DisplayObject that will be used to draw the given icon.
    virtual disti::DisplayObject* GetIconGeometry( IconID iconID, disti::GlsMapSymbology* symbology ) = 0;

    /// Get the location of the given point
    /// \param iconID Must be a valid icon ID (obtained from GetSymbolsInRegion())
    /// \param locationOut Will contain the location of the icon after the method returns
    virtual void GetIconLocation( IconID iconID, disti::GeoCoord& locationOut ) = 0;

    /// Returns the DisplayObject to use for rendering the path or NULL
    /// to use the default path rendering
    virtual disti::DisplayObject* GetPathGeometry( PathID pathID, disti::GlsMapSymbology* symbology ) = 0;

    /// Returns the number of points that make up the path
    virtual long GetPathPointCount( PathID pathID ) = 0;

    /// Returns the location of the given point in the path
    virtual void GetPathPointLocation( PathID pathID, long pointNum, disti::GeoCoord& locationOut ) = 0;

    /// Called immediately before each icon is drawn to allow the data source to make changes to the geometry if desired
    virtual void SetupIconForRendering( disti::GlsMapSymbology* symbology, IconID iconID, disti::DisplayObject* iconGeometry ) = 0;

    /// Called immediately before each path is drawn to allow the data source to make changes to the geometry if desired
    virtual void SetupPathForRendering( disti::GlsMapSymbology* symbology, PathID pathID, disti::DisplayObject* pathGeometry ) = 0;

    /// Called after all the symbols have been drawn to allow the
    /// data source to perform additional rendering if needed.
    virtual void PostDraw( disti::GlsMapView* view, disti::GlsMapSymbology* symbology ) = 0;

private:
    // Disable copying/moving for polymorphic base class
    GlsMapSymbologyDataSource( const GlsMapSymbologyDataSource& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    void operator=( const GlsMapSymbologyDataSource& ) DISTI_SPECIAL_MEM_FUN_DELETE;
};
} // namespace disti

#endif