Inheritance diagram for TSLGridDataLayer:

[legend]

Detailed Description

Specialist data layer for the display of regular grids.

This adds special features to allow configuration of the rendering. At present, these are:

"xmajor" : Major X gridlines (vertical)
"ymajor" : Major Y gridlines (horizontal)
"xminor" : Minor X gridlines (vertical)
"yminor" : Minor Y gridlines (horizontal)
"xaxis" : X axis (horizontal, y=0)
"yaxis" : Y axis (vertical, x=0)

Use the setFeatureRendering method to configure the rendering options for these.

The intersections of the gridlines may be snapped to, using the 'snapPoint' method.

Instances of this class should be destroyed using the destroy method.

Public Member Functions
	TSLGridDataLayer ()

bool	setSpacing (const char *feature, double spacing)

bool	setUnits (TSLTMC tmcPerUnit, TSLTMC tmcXOrigin=0, TSLTMC tmcYOrigin=0)

bool	snapable ()

void	snapable (bool val)

bool	snapPoint (TSLCoord *snap_pt, bool force_snap=false)

void *	operator new (size_t size) TSL_NO_THROW

void *	operator new (size_t size, char *filename, int line)

Public Member Functions inherited from TSLDataLayer
void	addDrawingCallback (TSLDataLayerDrawingCallback *drawingCallback)

bool	addFeatureRendering (const char *featureName, TSLFeatureID featureID)

bool	addLoader (TSLFileLoader loader, TSLLoaderAppCallback callback, void arg, TSLAllLoadedCallback allLoadedCallback=0, void *arg2=0)

bool	addPathList (const TSLPathList *path_list)

void	cancelFlashback ()

bool	clearFeatureRendering (const char *featureName, TSLFeatureID featureID)

TSLDataHandler *	createDataHandler (const char *config_file=0)

TSLHistoryVersion	currentVersion () const

TSLDataHandler *	dataHandler ()

const TSLDataHandler *	dataHandler () const

void	destroy ()

bool	entityIsVisible (const TSLEntity entity, const TSLDrawingSurface drawingSurface) const

const TSLFeatureClassList *	featureList () const

const TSLFeatureClassList *	featureList (const char *detailLayerName) const

bool	fileModificationTime (const char *filename, TSLTimeType &lastModificationTime)

TSLEntity *	findEntity (TSLTMC x, TSLTMC y, TSLTMC aperture, int depth, const char *featureName=0, int drawingSurfaceID=-1)

bool	findFile (const char *filename, TSLSimpleString &foundPath) const

void	flashbackToTimestamp (TSLHistoryTimestamp timestamp, TSLLayerArchiveCallback archiveCallback, void *arg=0)

void	flashbackToTimestamp (TSLHistoryTimestamp timestamp, TSLLayerArchiveTileCallback archiveTileCallback, void *arg=0)

void	flashbackToVersion (TSLHistoryVersion version, TSLLayerArchiveCallback archiveCallback, void *arg=0)

void	flashbackToVersion (TSLHistoryVersion version, TSLLayerArchiveTileCallback archiveTileCallback, void *arg=0)

bool	getActiveLayerName (const TSLEnvelope &extent, double screenResolution, TSLSimpleString &activeLayerName) const

TSLEntityIterator *	getEntityIterator (const char detailLayer, TSLSelector selector=NULL, TSLEnvelope *extent=NULL, bool splitOptimisedPrimitives=true)

bool	getFeatureRendering (const char featureName, TSLFeatureID featureID, TSLRenderingAttributeInt attribute, int result) const

bool	getFeatureRendering (const char featureName, TSLFeatureID featureID, TSLRenderingAttributeDouble attribute, double result) const

bool	getFeatureRendering (const char featureName, TSLFeatureID featureID, TSLRenderingAttributeBool attribute, bool result) const

bool	getFeatureRendering (const char featureName, TSLFeatureID featureID, TSLRenderingAttributes result) const

TSLFileLoader *	getLoader ()

bool	getMUExtent (double x1, double y1, double x2, double y2, int drawingSurfaceID=-1) const

bool	getTMCExtent (TSLTMC x1, TSLTMC y1, TSLTMC x2, TSLTMC y2, int drawingSurfaceID=-1) const

bool	getUUExtent (double x1, double y1, double x2, double y2, const TSLDrawingSurface *drawingSurface) const

bool	importHistory (TSLHistoryVersion mapVersion, TSLHistoryTimestamp timestamp, TSLHistoryImportSet *historySet)

bool	latLongToTMC (double latitude, double longitude, TSLTMC x, TSLTMC y, bool local=false) const

bool	latLongToTMC (int num, double latitudes, double longitudes, TSLTMC xs, TSLTMC ys, bool local=false) const

TSLDataLayerTypeEnum	layerType () const

bool	loadData (const char *filename)

bool	loadRendering (const char *filename)

void	notifyChanged (bool changed=true)

TSLMapQuery *	query (TSLTMC x1, TSLTMC y1, TSLTMC x2, TSLTMC y2, int depth=-1, const char *featureName=NULL, int drawingSurfaceID=-1) const

TSLMapQuery *	query (TSLTMC x1, TSLTMC y1, TSLTMC x2, TSLTMC y2, TSLSelector *selector, int drawingSurfaceID=-1) const

const TSLCoordinateSystem *	getCoordinateSystem () const

bool	queryVersionHistory (const TSLEnvelope &extent, TSLVersionHistorySet &history)

void	refreshFlashback ()

bool	removeData ()

void	releaseResources (int surfaceID)

bool	saveRendering (const char *filename, TSLMapLinkVersion ver=TSL_CURRENT_MAPLINK_VERSION)

bool	setCoordinateSystem (const TSLCoordinateSystem *coordinateSystem)

bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeInt attribute, int value)

bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeDouble attribute, double value)

bool	setFeatureRendering (const char *featureName, TSLFeatureID featureID, TSLRenderingAttributeBool attribute, bool value)

bool	setFeatureRendering (const char featureName, TSLFeatureID featureID, TSLRenderingAttributes value)

bool	TMCToLatLong (TSLTMC x, TSLTMC y, double latitude, double longitude, bool local=false, bool boundCheck=true) const

bool	TMCToLatLong (int num, TSLTMC xs, TSLTMC ys, double latitudes, double longitudes, bool local=false) const

const TSLVersionHistorySet *	versionHistory () const

Protected Member Functions
	~TSLGridDataLayer ()

Constructor & Destructor Documentation

◆ TSLGridDataLayer()

TSLGridDataLayer::TSLGridDataLayer ( )

Default constructor for Grid Data Layer.

◆ ~TSLGridDataLayer()

TSLGridDataLayer::~TSLGridDataLayer ( )

inlineprotected

Protected destructor to stop being instantiated on the stack Forces user to use new operator and destroy method.

Member Function Documentation

◆ operator new() [1/2]

void * TSLGridDataLayer::operator new ( size_t size )

Allocation override for API redirection

◆ operator new() [2/2]

void * TSLGridDataLayer::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

◆ setSpacing()

bool TSLGridDataLayer::setSpacing	(	const char *	feature,
		double	spacing )

Set the spacing for major and minor gridlines.

Parameters

feature	Type of feature to set spacing for, eg. xmajor.
spacing	Spacing, in grid units.

Returns: true on success, false otherwise.

◆ setUnits()

bool TSLGridDataLayer::setUnits	(	TSLTMC	tmcPerUnit,
		TSLTMC	tmcXOrigin = 0,
		TSLTMC	tmcYOrigin = 0 )

Sets the grid units and offset.

Parameters

tmcPerUnit	This is the number of TMC units for each grid spacing unit. Typically, this may be the TMCPerMU on a Map Data Layer, or TMCPerUU on a Drawing Surface.
tmcXOrigin	This is the origin of the grid X axis, in TMC coordinates. The default value is 0.
tmcYOrigin	This is the origin of the grid Y axis, in TMC coordinates. The default value is 0.

Returns: false on error, true otherwise.

◆ snapable() [1/2]

bool TSLGridDataLayer::snapable ( )

This method queries the flag to indicate whether the grid may be snapped to, or not.

Returns current value of snapable flag.

◆ snapable() [2/2]

void TSLGridDataLayer::snapable ( bool val )

This method sets the flag to indicate whether the grid may be snapped to, or not.

Parameters

val	New value of snapable flag

◆ snapPoint()

bool TSLGridDataLayer::snapPoint	(	TSLCoord *	snap_pt,
		bool	force_snap = false )

Given a coordinate snap to the nearest grid point

Parameters

snap_pt	Coordinate to snap.
force_snap	True when snap should occur, even when grid 'snapable' flag is false.

Returns: true if the point was snapped, false otherwise.

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ TSLGridDataLayer()

◆ ~TSLGridDataLayer()

Member Function Documentation

◆ operator new() [1/2]

◆ operator new() [2/2]

◆ setSpacing()

◆ setUnits()

◆ snapable() [1/2]

◆ snapable() [2/2]

◆ snapPoint()