GL Studio C++ Runtime API
GlsMapSymbologyDataSource Class Referenceabstract

#include <gls_map_symbology_data_source.h>

Inheritance diagram for GlsMapSymbologyDataSource:
GlsMapSymbologyBasicDataSource< IconT, PathT > GlsMapSymbologyBasicDataSource< GlsMapSymbologyStdIcon, GlsMapSymbologyStdPath > GlsMapSymbologyStdDataSource

Public Member Functions

 GlsMapSymbologyDataSource ()
 Constructor.
 
virtual ~GlsMapSymbologyDataSource ()
 Destructor.
 
virtual void GetSymbolsInRegion (disti::GlsMapSymbology *symbology, const disti::GeoRect &region, IconIDList &icons, PathIDList &paths)=0
 Returns the list of symbols (icons and paths) that are visible in the given region.
 
virtual disti::DisplayObjectGetIconGeometry (IconID iconID, disti::GlsMapSymbology *symbology)=0
 
virtual void GetIconLocation (IconID iconID, disti::GeoCoord &locationOut)=0
 
virtual disti::DisplayObjectGetPathGeometry (PathID pathID, disti::GlsMapSymbology *symbology)=0
 
virtual long GetPathPointCount (PathID pathID)=0
 Returns the number of points that make up the path.
 
virtual void GetPathPointLocation (PathID pathID, long pointNum, disti::GeoCoord &locationOut)=0
 Returns the location of the given point in the path.
 
virtual void SetupIconForRendering (disti::GlsMapSymbology *symbology, IconID iconID, disti::DisplayObject *iconGeometry)=0
 Called immediately before each icon 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 immediately before each path is drawn to allow the data source to make changes to the geometry if desired.
 
virtual void PostDraw (disti::GlsMapView *view, disti::GlsMapSymbology *symbology)=0
 

Detailed Description

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

Member Function Documentation

virtual disti::DisplayObject* GetIconGeometry ( IconID  iconID,
disti::GlsMapSymbology symbology 
)
pure virtual

Returns the DisplayObject to use for rendering the given icon or NULL if no icon should be drawn

Parameters
iconIDMust be a valid icon ID (obtained from GetSymbolsInRegion())
symbologysymbology group that contains the DisplayObject that will be used to draw the given icon.

Implemented in GlsMapSymbologyBasicDataSource< IconT, PathT >, and GlsMapSymbologyBasicDataSource< GlsMapSymbologyStdIcon, GlsMapSymbologyStdPath >.

virtual void GetIconLocation ( IconID  iconID,
disti::GeoCoord locationOut 
)
pure virtual

Get the location of the given point

Parameters
iconIDMust be a valid icon ID (obtained from GetSymbolsInRegion())
locationOutWill contain the location of the icon after the method returns

Implemented in GlsMapSymbologyBasicDataSource< IconT, PathT >, and GlsMapSymbologyBasicDataSource< GlsMapSymbologyStdIcon, GlsMapSymbologyStdPath >.

virtual disti::DisplayObject* GetPathGeometry ( PathID  pathID,
disti::GlsMapSymbology symbology 
)
pure virtual

Returns the DisplayObject to use for rendering the path or NULL to use the default path rendering

Implemented in GlsMapSymbologyBasicDataSource< IconT, PathT >, and GlsMapSymbologyBasicDataSource< GlsMapSymbologyStdIcon, GlsMapSymbologyStdPath >.

virtual void PostDraw ( disti::GlsMapView view,
disti::GlsMapSymbology symbology 
)
pure virtual

Called after all the symbols have been drawn to allow the data source to perform additional rendering if needed.

Implemented in GlsMapSymbologyBasicDataSource< IconT, PathT >, and GlsMapSymbologyBasicDataSource< GlsMapSymbologyStdIcon, GlsMapSymbologyStdPath >.


The documentation for this class was generated from the following file: