![]() |
MapLink Pro 11.1.1.0.
Envitia MapLink Pro: The Ultimate Mapping Application Toolkit
|
This class category contains the main MapLink API classes.
Geometry :
Data Layers:
Drawing Surfaces:
Topics | |
Data Layer Details | |
Data layers provide containers for data that are displayed in a drawing surface. | |
Typedefs | |
typedef void(* | TSLAllLoadedCallback) (void *arg2) |
typedef bool(* | TSLCopyFilesCallback) (void *arg, int percentDoneTotal, int percentDoneCurrentFile) |
typedef bool(* | TSLFilterProgressCallback) (void *arg, TSLFilterProgress callbackType, double percentage) |
typedef TSLTimeType | TSLHistoryTimestamp |
typedef unsigned int | TSLHistoryVersion |
typedef void | TSLLatLongGridDataLayerFormatCallback(void *arg, double value, bool lineOfLatitude, char *buffer) |
typedef void(* | TSLLayerArchiveCallback) (void *arg, const char *layerName, TSLHistoryVersion version, char *directory) |
typedef void(* | TSLLayerArchiveTileCallback) (void *arg, const char *layerName, TSLHistoryVersion version, char *directory, int userVersion, const TSLEnvelope &extent, const TSLSimpleString &tileFileName) |
typedef TSLLoaderCallbackReturn(* | TSLLoaderAppCallback) (void *arg, const char *filename, TSLEnvelope extent, TSLLoaderStatus status, int percentDone) |
typedef TSLLoaderCallbackReturn(* | TSLLoaderCallback) (void *arg, TSLifstream *stream, const char *fullPath, TSLLoaderStatus status, int percentDone) |
typedef TSLLoaderCallbackReturn(* | TSLLoaderFileLoadedCallback) (void *arg, TSLifstream *stream, const char *fullPath, bool beforeDecompression) |
typedef TSLPathlistCallbackReturn(* | TSLPathlistCallback) (void *arg, const char *filename, char *directory, TSLMaplCompressionOption *compression) |
typedef void(* | TSLRuntimeProjectionChangedCallback) (void *arg, TSLRuntimeProjectionChangedEnum reason) |
typedef bool(* | TSLSeamlessLayerEntityChangeCallback) (void *arg, const TSLEntity *originalEntity, const TSLEntity *modifiedEntity, TSLBitMask entityChangeSet) |
typedef int(* | TSLTileValidationFn) (char const *tileName, TSLTimeType const *lastValidTime, TSLTimeType const *modificationTime, TSLDataLayer *layer, void *arg) |
typedef void(* TSLAllLoadedCallback) (void *arg2) |
Function typedef.
This function typedef defines the signature of a function that the user may optionally provide to the loader if using asynchronous loading.
Implementation
static void allLoadedFunction( void * arg2 ) ;
The callback will be called after each draw of a map data layer once all required map tiles have been loaded. If all tiles are already loaded in the cache then the callback will not be made.
The callback may also not occur if a file could not be found or if the tile cache is too small. This can occur if you are using a threaded file loader (TSLFileLoaderRemote, TSLFileLoaderMT).
If you are finding that this callback is not occurring you are advised to also use the TSLLoaderCallback and check the percentDone parameter. This callback always occurs for the 100% value.
arg2 | The arg2 value passed to the addLoader function; user-defined. |
Return | value |
typedef bool(* TSLCopyFilesCallback) (void *arg, int percentDoneTotal, int percentDoneCurrentFile) |
Function typedef.
This function typedef defines the signature of a function that the user may optionally provide to a method that copies files such as TSLMapDataLayer::copyRasterFeatures.
Implementation
static bool progressFunc( void*arg, int percentDoneTotal,int percentDoneCurrentFile) ;
The callback will be called during the copy of each file.
arg1 | The arg value passed to the called method; user-defined. |
arg2 | The percentage of the total copied. |
arg3 | The percentage of the current file that's been copied. |
Return | value |
bool If false is returned then copying is cancelled.
typedef bool(* TSLFilterProgressCallback) (void *arg, TSLFilterProgress callbackType, double percentage) |
This typedef defines a user supplied callback that is used throughout the filter data layer. The documentation for the TSLFilterProgressEnum outlines the types of callbacks the user will receive if they supply a callback.
arg | The user supplied argument associated with the callback |
callbackType | Identifies where the callback originates from. See the documentation for TSLFilterProgressEnum for more details on the types of callback and how they affect the data layer. |
percentage | The percentage or completeness the callback is identifying to the user. The data layer guarantees that at least a 100% complete callback will be made if the specific callback type is successful. |
The return value indicates whether the user would like the current task to be aborted. Returning false will allow the task to continue.
typedef TSLTimeType TSLHistoryTimestamp |
The type representing a version timestamp. It is a typedef for a 64-bit time type. Users should create instances of this type using standard system calls.
typedef unsigned int TSLHistoryVersion |
The type representing a version number. It is a typedef for type 'unsigned int'.
Data layer archives will always start at version 1. Therefore, clients can use a value of 0 in their applications to signal the current version (e.g. this would allow clients to call cancelFlashback()).
typedef void TSLLatLongGridDataLayerFormatCallback(void *arg, double value, bool lineOfLatitude, char *buffer) |
Function typedef used by the TSLLatLongGridDataLayer to format the text displayed at each grid interval. The user implementation should write the desired string to the buffer passed.
arg | The arg value passed to TSLLatLongGridDataLayer; user-defined. |
value | The value of the position being formatted |
lineOfLatitude | If true then the value passed denotes the label for a line of latitude. If false then it denotes a line of longitude. |
buffer | A 256 character length buffer that the user should write the formatted position to. |
typedef void(* TSLLayerArchiveCallback) (void *arg, const char *layerName, TSLHistoryVersion version, char *directory) |
This function typedef defines the signature of a function that the user must provide to the TSLDataLayer::flashbackToTimestamp() or TSLDataLayer::flashbackToVersion() methods so that the application can indicate where layer archives are to be found.
If MapLink cannot locate the layer within the supplied archive directory, then it will attempt to use the latest version of the layer.
arg | The arg value passed to TSLDataLayer::flashbackToTimestamp() or TSLDataLayer::flashbackToVersion() methods, user-defined. |
layerName | The name of the layer for which the archive is required. |
version | The version of the layer required. |
directory | This parameter points to a character array. The callback should fill in the location of the archive directory for the layer at the required version. The string must not be longer than TSL_MAX_WPATH, including the null terminator. |
typedef void(* TSLLayerArchiveTileCallback) (void *arg, const char *layerName, TSLHistoryVersion version, char *directory, int userVersion, const TSLEnvelope &extent, const TSLSimpleString &tileFileName) |
This function typedef defines the signature of a function that the user must provide to the TSLDataLayer::flashbackToTimestamp() or TSLDataLayer::flashbackToVersion() methods so that the application can indicate where layer archives are to be found. This callback differs from TSLLayerArchiveCallback in that it will be invoked for every tile in the map for which historical data is needed instead of only for the first tile.
If MapLink cannot locate the layer within the supplied archive directory, then it will attempt to use the latest version of the layer.
arg | The arg value passed to the TSLDataLayer::flashbackToTimestamp() or TSLDataLayer::flashbackToVersion() methods, user-defined. |
layerName | The name of the layer for which the archive is required. |
version | The version of the layer required. |
directory | This parameter points to a character array. The callback should fill in the location of the archive directory for the layer at the required version. The string must not be longer than TSL_MAX_WPATH, including the null terminator. |
userVersion | A user-defined integer value originally set on the tile when the history entry was created. If no user value has been set this will default to 0. |
extent | Extent for which historical data is desired. You should retrieve all entities within this extent and store them in a single TMF file. |
tileFileName | This is the filename that the tile should be saved as. |
typedef TSLLoaderCallbackReturn(* TSLLoaderAppCallback) (void *arg, const char *filename, TSLEnvelope extent, TSLLoaderStatus status, int percentDone) |
Function typedef.
This function typedef defines the signature for a callback routine that must be supplied when calling addLoader on a drawing surface or data layer. The callback is used when a file is loaded using the loader added.
Implementation:
static TSLLoaderCallbackReturn mapCallbackFunction( void* arg, const char* filename, TSLEnvelope extent, TSLLoaderStatus status, int percentDone );
arg | The arg value passed to the load function; user-defined. |
filename | Provides the full path of the file being loaded. |
extent | Provides the geographic extent of the data loaded. Only valid when loading is successful and 100% complete. |
status | Indicates success or error. |
percentDone | Indicates progress through the loading of the file. |
typedef TSLLoaderCallbackReturn(* TSLLoaderCallback) (void *arg, TSLifstream *stream, const char *fullPath, TSLLoaderStatus status, int percentDone) |
Function typedef.
This function typedef defines the signature of a function that the user must provide to the loader if using asynchronous loading.
Implementation:
static TSLLoaderCallbackReturn mapCallbackFunction( void* arg, TSLifstream * stream, const char* filename, TSLLoaderStatus status, int percentDone );
arg | The arg value passed to the load function; user-defined. |
stream | If loading has completed successfully then this will point to a stream created by the routine and containing the data loaded. |
fullPath | Provides the full path of the file being loaded. |
status | Indicates success or error. Every call to a load function will be matched by one callback that contains an error or contains success with 100% complete. |
percentDone | Indicates progress through the loading of the file. |
typedef TSLLoaderCallbackReturn(* TSLLoaderFileLoadedCallback) (void *arg, TSLifstream *stream, const char *fullPath, bool beforeDecompression) |
Function typedef.
This function typedef defines the signature of a function that the user can provide to the loader if they wish to intercept the loading of the file (see TSLFileLoader::setLoadedCallback).
This callback use is for those wishing to check the integrity of a map and its associated files (see the samples).
Implementation:
static TSLLoaderCallbackReturn fileloaderFileLoadedCallback(void arg, TSLifstream stream, const char* fullPath, bool beforeDecompression);
arg | The arg value passed to the load function; user-defined. |
stream | If loading has completed successfully then this will point to a stream created by the routine and containing the data loaded. |
fullPath | Provides the full path of the file being loaded. |
beforeDecompression | Indicates if the callback was called before the stream was decompressed (this does not indicate that the file was compressed). |
For the drawing surface the following files are mandatory:
If the symbols themselves fail to load then they will not be displayed.
For a map the following files are mandatory:
If mandatory files are to be failed then TSLBadFileStatus should be returned.
For .tmf, .tp1 and .tpf you can return TSLIgnoreFile of TSLBadFileStatus if the files are to be failed.
Raster Pyramid files are complex to check and track. It is therefore suggested that you do not generate raster pyramids to a single file when generating your map.
typedef TSLPathlistCallbackReturn(* TSLPathlistCallback) (void *arg, const char *filename, char *directory, TSLMaplCompressionOption *compression) |
Deprecated function typedef, please use TSLPathListCallbackClass instead.
This function typedef defines the signature of a function that the user may provide to a TSLPathlist, so that the application can indicate where files are to be found.
arg | The arg value passed to the pathlist constructor, user-defined |
filename | The file whose location is to be determined. |
directory | This parameter points to a character array in the pathlist class. The size of the array is defined by the parameter TSL_PATHLIST_CALLBACK_DIR_SIZE (in file 'tslpathlistconstants.h'). The callback should fill this with the name of the directory where the file should be found. The length of the string must not exceed the size defined by TSL_PATHLIST_CALLBACK_DIR_SIZE, including the null terminator. |
compression | Points to a variable that the callback should use to indicate if the directory returned is compressed. |
Return | value |
See the TSLPathlistCallbackReturn enumeration for an explanation.
typedef void(* TSLRuntimeProjectionChangedCallback) (void *arg, TSLRuntimeProjectionChangedEnum reason) |
Function typedef for runtime projection changes.
arg | The arg value passed to the runtime projection change methods; user-defined. |
reason | If the same callback is given for both projection change and origin change, this parameter can be used to determine why the callback is being made. |
typedef bool(* TSLSeamlessLayerEntityChangeCallback) (void *arg, const TSLEntity *originalEntity, const TSLEntity *modifiedEntity, TSLBitMask entityChangeSet) |
This callback shall be invoked once for each entity that is imported into a seamless layer via the seamless layer manager. It allows a user application to control if the entity should be imported or updated in the seamless layer based on what changes have occurred to the entity.
arg | The user-defined argument as passed to TSLSeamlessLayerManager::ingestData(). |
originalEntity | The entity as it exists currently in the seamless layer. For new entities this will be NULL. |
modifiedEntity | The entity after is has been modified by the COU update. For deleted entities this will be NULL. |
entityChangeSet | A bitmask field describing what has changed for this entity. See the documentation for TSLEntityChange for a description of possible values. More than one value may be set for any one entity. |
The application should return true from this callback to import the entity into the seamless layer, or false to ignore it. Note that if false is returned, the lastImportedVersion field for the TSLSLMEntityRef for this entity will still be updated to mark that an update has been seen.
typedef int(* TSLTileValidationFn) (char const *tileName, TSLTimeType const *lastValidTime, TSLTimeType const *modificationTime, TSLDataLayer *layer, void *arg) |
Function typedef.
This function typedef is used for persistent cache tile validation. When adding a persistent cache to a TSLMapDataLayer, the user may specify a function of this type. The function is called whenever a tile needs to be validated. The name of the tile, and the timestamp at which the tile was last validated is passed.
The function should return 1 if the tile is still valid, 0 if it is no longer valid.
tileName | The name of the tile. |
lastValidTime | The time at which the tile was last validated. |
modificationTime | The time at which the source tile was last modified. |
layer | The layer which is making the validation request. |
arg | An optional user-defined argument. |
enum TSLArcZoneEnum |
enum TSLButtonType |
Enumerated Type for the available CADRG/CIB Scales.
enum TSLCompressionResult |
Enumerated type for the result of compression and decompression.
enum TSLCursorStyle |
This enumeration defines the different types of cursor style that may be supplied to the application via the various MapLink classes, such as TSLEditorRequest or TSLInteractionModeRequest
enum TSLDataLayerTypeEnum |
Enumerated value for the type of a TSLDataLayer.
Enumerator | |
---|---|
TSLDataLayerTypeStandardDataLayer | The layer is a TSLStandardDataLayer. |
TSLDataLayerTypeMapDataLayer | The layer is a TSLMapDataLayer. |
TSLDataLayerTypeGridDataLayer | The layer is a TSLGridDataLayer. |
TSLDataLayerTypeRasterDataLayer | The layer is a TSLRasterDataLayer. |
TSLDataLayerTypeNationalGridDataLayer | The layer is a TSLNationalGridDataLayer. |
TSLDataLayerTypeCADRGDataLayer | The layer is a TSLCADRGDataLayer. |
TSLDataLayerType3DStandardDataLayer | The layer is a TSL3DStandardDataLayer. |
TSLDataLayerTypeCustomDataLayer | The layer is a TSLCustomDataLayer. |
TSLDataLayerType3DCustomDataLayer | The layer is a TSL3DCustomDataLayer. |
TSLDataLayerTypeMGRSGridDataLayer | The layer is a TSLMGRSGridDataLayer. |
TSLDataLayerTypeLatLonGridDataLayer | The layer is a TSLLatLongGridDataLayer. |
TSLDataLayerTypeAcceleratedCustomDataLayer | The layer is a TSLAcceleratedCustomDataLayer. |
TSLDataLayerType2DSatelliteDataLayer | The layer is a TSL2DSatelliteDataLayer. |
TSLDataLayerType3DSatelliteDataLayer | The layer is a TSL3DSatelliteDataLayer. |
TSLDataLayerTypeFilterDataLayer | The layer is a TSLFilterDataLayer. |
TSLDataLayerTypeWMSDataLayer | The layer is a TSLWMSDataLayer. |
TSLDataLayerTypeS63DataLayer | The layer is a TSLS63DataLayer. |
TSLDataLayerTypeGARSGridDataLayer | The layer is a TSLGARSGridDataLayer. |
TSLDataLayerTypeWMTSDataLayer | The layer is a TSLWMTSDataLayer. |
TSLDataLayerTypeStaticMapDataLayer | The layer is a TSLStaticMapDataLayer. |
TSLDataLayerTypeDirectImportDataLayer | The layer is a TSLDirectImportDataLayer. |
TSLDataLayerTypeViewShed | The layer is a TSLViewShedDataLayer. |
TSLDataLayerTypeDatabaseDataLayer | The layer is a TSLDatabaseDataLayer. |
TSLDataLayerTypeKMLDataLayer | The layer is a TSLKMLDataLayer. |
TSLDataLayerTypeHeatMapDataLayer | The layer is a TSLHeatMapDataLayer. |
Enumerated type for the declutter status.
Enumerated type describing the return type for declutter operations.
This enum identifies the drawing surface class to cast to when the user calls the type method on TSLDrawingSurfaceBase
Enumerator | |
---|---|
TSLDrawingSurfaceTypeUnknown | This indicates that the Drawing Surface type is unknown. |
TSLDrawingSurfaceTypeGDI | This indicates TSLNTSurface. |
TSLDrawingSurfaceTypeX11 | This indicates TSLMotifSurface. |
TSLDrawingSurfaceTypeOpenGL | This indicates TSLWGLSurface, TSLGLXSurface, TSLEGLSurface or TSLNativeEGLSurface (depends on platform). |
TSLDrawingSurfaceTypeDirect2D | (Future use) This indicates TSLDirect2DDrawingSurface. |
TSLDrawingSurfaceTypeAcceleratorOpenGL | This indicates TSLWGLAcceleratedSurface or TSLX11GLAcceleratedSurface (depends on platform). |
TSLDrawingSurfaceTypeAcceleratorDirectX | This indicates TSLDXAcceleratedSurface. |
TSLDrawingSurfaceType3DOpenGL | This indicates TSL3DWinGLSurface or TSL3DXGLSurface (depends on platform). |
TSLDrawingSurfaceType3DEarth | This indicates an instance of the 3D Earth surface (maplink::earth::Surface3D) |
Enumeration detailing the action that MapLink should take after it has asked the Dynamic Renderer to draw an entity.
enum TSLErrorCategory |
Defines the Error Categories that can be read from TSLErrorStack.
You can use these values to define a mask which controls the types of errors/messages you wish to query from the TSLErrorStack.
The values defined are:
TSLErrorCategoryInfo Information Message TSLErrorCategoryWarn Warning Message TSLErrorCategoryError Error Message TSLErrorCategoryFatal Fatal Error Message TSLErrorCategorySyntax Syntax Error Message TSLErrorCategoryDebug Debug Error Message TSLErrorCategoryAll All Error messages
Enumerator | |
---|---|
TSLErrorCategoryInfo | |
TSLErrorCategoryWarn | |
TSLErrorCategoryError | |
TSLErrorCategoryFatal | |
TSLErrorCategorySyntax | |
TSLErrorCategoryDebug | |
TSLErrorCategoryAll |
Lists all of the possible TSLFileLoader callback locations.
Lists all of the possible TSLFileLoader child class types.
Enumerator | |
---|---|
TSLFileLoaderTypeBlocking | This means the class is a TSLFileLoaderBlocking loader. |
TSLFileLoaderTypeMemory | This means the class is a TSLFileLoaderMemory loader. |
TSLFileLoaderTypeMT | This means the class is a TSLFileLoaderMT loader. |
TSLFileLoaderTypeRemote | This means the class is a TSLFileLoaderRemote loader. |
TSLFileLoaderTypeCustom |
This enum defines various processing options that affect the appearance of rasters processed through the TSLFilterDataLayer. The available values are:
Enumerator | |
---|---|
TSLFilterDisplayItemPropRasterProjectionMaintainPalette | Controls if an 8bit raster palette is maintained through the projection process. To turn this enum on pass true (1) and to turn this off pass false (0 - default) to TSLFilterDataLayerDisplatItem::setDisplayItemProp. |
TSLFilterDisplayItemPropRasterProjectionDisableDithering | Controls if dithering is turned on during the projection process. To turn this enum on pass true (1) and to turn this off pass false (0 - default) to TSLFilterDataLayerDisplatItem::setDisplayItemProp. |
TSLFilterDisplayItemPropRasterProjectionInterpolate | Controls the filtering algorithm used during the projection process. Setting this to true (1) causes processing to use bi-linear interpolation, resulting in higher quality output at the cost of increased processing time. The default value of false(0) causes processing to use nearest-neighbour filtering. |
TSLFilterDisplayItemPropStretchBrightness | Setting this to true (1) causes processing to map the range of brightness values used in the source image to the maximum available range for the display (usually 0-255). This can improve the appearance of rasters that only use a small fraction of the available data range for their native format, particularly when the values are clustered around one edge of the range. Not all types of filter that can be used with the TSLFilterDataLayer support this option. Generally this option only has an effect on greyscale and some RGB rasters. |
enum TSLFilterProcess |
Controls how Vector and Raster data is processed.
The values can be combined using bitwise-OR.
This enumeration defines the processing status of a display item.
enum TSLFilterProgress |
This enumeration indicates where a TSLFilterProgressCallback callback originates from.
The possible values are
TSLFilterProgressLoadData TSLFilterProgressProcess TSLFilterProgressGeolocationChange TSLFilterProgressProcessItem
A TSLFilterProgressLoadData call is made when loadData is called on the data layer
A TSLFilterProgressProcess call is made when data is processed on the datalayer either through a call to process(), processDisplayItem() or when the layer is drawn and display items that are to be drawn have not been previously processed.
A TSLProgressGeolocationChange call is made when either clearUserDefined() Geolocation or setUserDefinedGeolocation() call has been successfully made on a display item. It may also be made when setInputCoordinateSystem() has been called on a display item and the coordinate system differs from the existing one. This change requires the data to be effectively reloaded but will maintain any current settings the user has applied.
A TSLFilterProgressProcessItem callback is made to indicate the progress of a particular item being processed. Callbacks of this kind will be made between TSLFilterProgressProcess callbacks. Percentage values ranging from 0 to 100 will be sent to the user callback function for each item using this callback type.
If the user returns false to a callback, the state of the layer is affected in the following way given the callback type:
TSLFilterProgressLoadData or TSLFilterProgressGeolocationChange
TSLFilterProgressProcess or TSLFilterProgressProcessItem
Enumerator | |
---|---|
TSLFilterProgressLoadData | |
TSLFilterProgressProcess | |
TSLFilterProgressGeolocationChange | |
TSLFilterProgressProcessItem |
enum TSLFilterType |
Enumerated Type for the Filter Data Layers:
Locked filters require a runtime unlock code that needs to be supplied by Envitia. Please contact your sales representative.
Please contact sales if you require runtime direct import for datasets not mentioned above.
enum TSLFindTypeEnum |
Enumerated type for limiting searches.
Enumerator | |
---|---|
TSLFindTypeAll | Find all matching entities. |
TSLFindTypeEntitySet | Find only TSLEntitySet objects. |
TSLFindTypeText | Find only TSLText objects. |
TSLFindTypeSymbol | Find only TSLSymbol objects. |
TSLFindTypeCurve | Find only one-dimensional objects, TSLArc and TSLPolyline. |
TSLFindTypeSurface | Find only two-dimensional objects, TSLPolygon, TSLEllipse and TSLPolygon. |
TSLFindTypeArc | Find only TSLArc objects. |
TSLFindTypePolyline | Find only TSLPolyline objects. |
TSLFindTypeEllipse | Find only TSLEllipse objects. |
TSLFindTypePolygon | Find only TSLPolygon objects. |
TSLFindTypeRectangle | Find only TSLRectangle objects. |
Modes available determining when a Grid Data Layer changes detail level.
Enumerator | |
---|---|
TSLGridLevelChangeAutomatic | level changes are determined automatically by the GridDataLayer. |
TSLGridLevelChangeManual | level changes are determined by the user setting the rendering edge styles of the Grid Lines, e.g. in the TSLLatLongGridDataLayer setting the value of the Tenths Longitude and Latitude edge styles to a value greater than 0 will enable the calculation of the Tenths grids. NOTE: If the Manual mode is used then the User needs to be aware that setting of Sub Grids at too high a zoom level will seriously impinge on performance and memory usage. |
enum TSLInteropEntityType |
Enumerated type that defines the entity types used by the TSL interoperability classes.
enum TSLInteropError |
Enumerated type that defines the error codes returned by the TSL interoperability classes.
enum TSLKeyedOption |
Enumerated type describing the functions within MapLink that are protected by special license keys.
Enumerator | |
---|---|
TSLPlatformKey | For unlocking all licenced functionality contained within a licence key. This option is not available on all platforms. |
TSLKeyedLZWTIF | For LZW-compressed Tif files - no longer required. |
TSLKeyedGIF | For GIF files - no longer required. |
TSLKeyedShapefileImport | For run-time import of ESRI Shapefiles. |
TSLKeyedShapefileExport | For run-time export of ESRI Shapefiles. |
TSLKeyedMIFImport | For run-time import of MapInfo MIF files. |
TSLKeyedMIFExport | For run-time export of MapInfo MIF files. |
TSLKeyedMasterMapImport | For run-time import of OS MasterMap GML files. |
TSLKeyedMasterMapExport | For run-time export of OS MasterMap GML files. |
TSLKeyedLandLineImport | For run-time import of OS LandLine NTF files. |
TSLKeyedLandLineExport | For run-time export of OS LandLine NTF files. |
TSLKeyedS57Import | For run-time import of S57 files. |
TSLKeyedS57Export | For run-time export of S57 files. |
TSLKeyedJPEG2000 | For JPEG2000 compressed files. |
TSLKeyedCADRGDataLayer | For use of the TSLCADRGDataLayer class to load CADRG data at run-time. |
TSLKeyedDMEDTerrainDatabase | For use of the TSLTerrainDatabase class to load DMED referenced DTED data at run-time. |
TSLKeyedS63 | For use of the TSLS63MediaIngestManager and TSLS63DataLayer classes to ingest and display S63 and S57 data at run-time. |
TSLKeyedGML | For use of the TSLGMLInstanceDataLoader, TSLGMLApplicationSchemaLoader, TSLGMLInstanceDataWriter and TSLGMLApplicationSchemaWriter classes used to read and write GML application schemas and instance data. |
TSLKeyedWFSClient | For use of the TSLWFSServer class used for interacting with a remote Web Feature Service server. |
TSLKeyedS57MediaIngest | For use with the S63 SDK. This unlocks the capability of ingesting S57 (unencrypted data only) data via the TSLS63MediaIngestManager and TSLS63DataLayer classes to ingest and display of S57 data at run-time. |
TSLKeyedEvaluationMap | For use with maps that have been created with an Evaluation licensed version of Studio. Unlocking this removes the drawing of the Evaluation Watermark for maps created using an Evaluation licensed version of MapLink Studio. |
TSLKeyedDirectImportDataLayer | For unlocking the Direct Import SDK. This allows import of data at runtime through the TSLDirectImportDataLayer. |
The return value given by the user to an asynchronous TSLFileLoader load or when the user intercepts the load process by setting up a loaded callback (see TSLFileLoader::setLoadedCallback).
Enumerator | |
---|---|
TSLContinue | continue to download. |
TSLCancelThisLoad | cancel current download. This return value is not valid for TSLLoaderFileLoadedCallback. |
TSLCancelAllLoads | cancel all downloads currently in progress by this loader. This return value is not valid for TSLLoaderFileLoadedCallback. |
TSLBadFileStatus | The file is bad. Returning this will cause this file to be skipped. If using a Multi-threaded loader any tiles contained in the queue may also be cancelled. Subsequent pan, zoom and draw may re-request the tiles.This return value is only valid for a TSLLoaderFileLoadedCallback. |
TSLIgnoreFile | Ignore the file. This causes a dummy tile to be created. Subsequent pan, zoom and draw will only re-request the tile if the tile is no-longer in the cache. This return value is only valid for a TSLLoaderFileLoadedCallback. |
enum TSLLoaderStatus |
Enumerated type used to return the success or failure of TSLFileLoader operations.
enum TSLLocatorType |
This is the TSLLocatorType class.
It is an enumerator for locator type, press/motion/release.
Enumerator | |
---|---|
TSLLocatorPress | |
TSLLocatorMotion | |
TSLLocatorRelease |
Enumerated type to represent whether a directory is compressed or uncompressed.
enum TSLModifierType |
This is the TSLModifierType class.
It is an enumerator class for modifier keys being pressed during operation.
Enumerator | |
---|---|
TSLModifierNone | |
TSLModifierShift | |
TSLModifierControl | |
TSLModifierShiftAndControl |
enum TSLOptionEnum |
Enumerated type defining the options for a TSLDrawingSurface.
Enumerator | |
---|---|
TSLOptionDoubleBuffered | Sets the double buffered flag of the TSLDrawingSurface. If this flag is true then the TSLDrawingSurface is double buffered. For maximum efficiency when using this option, always use the TSLDrawingSurface drawDU or drawUU methods. This option has no effect on the OpenGL drawing surface. Default value is False. |
TSLOptionAntiAliasMonoRasters | When set, monochrome rasters are anti-aliased. This improves the display, but has a detrimental effect on raster performance. This option has no effect on the OpenGL drawing surface. Default value is False. |
TSLOptionDynamicArcSupportEnabled | When set, maps are treated as dynamic arc and have their projections altered appropriately on zooming and resizing. Default value is False. A map using the Dynamic Arc coordinate system, with the TSLOptionAdjustForDynamicArc option set on the Drawing Surface, causes the TSLResizeActionEnum option to behave differently than for other configurations:
|
TSLOptionProgressiveTileZoom | When set and TSLOptionTileBufferedLayers is enabled, this option prevents display flickering when zooming in and out by displaying any available tiles for the current viewing area until buffered tiles of the correct resolution are available. For the Accelerated Drawing Surface, map tiles are generated in the background thread if a multi-threaded renderer is being used (See Also: TSLAcceleratedSurface). The default value is false. |
TSLOptionTileBufferedLayers | Enabled background threaded tiling for buffered layers in this drawing surface. See TSLDrawingSurfaceTiledBufferControl for details on tiled buffering. This option is currently supported only by the TSLOpenGLSurface. The default value is false. |
TSLOptionAcceleratorZoomAsynchronous | Deprecated - use TSLOptionProgressiveTiledDisplay instead |
Enumerated type describing the return value given by the user to a callback from a TSLPathlist, made by 'getMatchingDirectoriesMT' when the location of a file is needed, typically by a file loader trying to locate a file.
enum TSLPickResultEnum |
Enumerated type defining the types for a pick operation result.
Enumerator | |
---|---|
TSLPickEntity | Defines that the picked item was a 2D entity. |
TSLPickCustom | Defines that the picked item was contained in a custom datalayer. |
TSLPick3DEntity | Defines that the picked item was a 3D entity. |
TSLPickDisplayObject | Defines that the picked item was a TSLDisplayObject, from the DDO API |
TSLPickSatellite | Defines that the picked item was a TSLSatellite from the Satellite Propagator API |
TSLPickTrack | Defines that the picked item was a TSLTrack, from the Track Manager API |
TSLPickTrackGraphic | Defines that the picked item was a TSLTrackGraphic, from the Track Manager API |
TSLPickEarthTrack | Defines that the picked item was an earth::Track, from the Earth SDK. |
TSLPickEarthGeometry | Defines that the picked item was an earth::geometry::Geometry, from the Earth SDK. |
TSLPickReserved1 | |
TSLPickReserved2 | |
TSLPickReserved3 | |
TSLPickReserved4 | |
TSLPickReserved5 | |
TSLPickUser | Defines the first enumerated value that can be used for user-defined pick results. |
enum TSLPriorityEnum |
Enumerated type defining the priority options to pass to TSLFileLoaderMT::setPriority.
enum TSLPropertyEnum |
Enumerated type defining the properties of a TSLDataLayer when it is attached to a TSLDrawingSurface.
The properties of a datalayer may be modified via TSLDrawingSurfaceBase::setDataLayerProps.
Enumerator | |
---|---|
TSLPropertyVisible | Sets the visibility flag of the TSLDataLayer. If this flag is true then the TSLDatalayer is drawn. Default value is true. |
TSLPropertyDetect | Sets detectability of the TSLDataLayer attached to the TSLDrawingSurface. If this flag is true, the user can snap to points on entities within this layer when using the TSLEditor component. This is also required for use by the 'find' methods on the TSLDrawingSurface. Note that this does not mean that entities can be selected. Default value is false. |
TSLPropertySelect | Sets selectability of the TSLDataLayer attached to the TSLDrawingSurface. If this flag is true the user can select entities within this layer when using the OperationManager component. Default value is false. |
TSLPropertyTransparent | This flag is NOT a visual property. It determines if any selection or detection functions are passed to data layers beneath this layer. Default value is true. |
TSLPropertyAutomatic | This is only applicable to a TSLMapDataLayer. If this flag is true, then the TSLMapDataLayer automatically handles management of the active detail layer. If this flag is false, then the user should manage the active detail layer change. Default value is true. |
TSLPropertyMinTextHeight | This is the minimum allowed height, in pixels, for text to be displayed. Text smaller than this will not be shown. Default value is 3 pixels. |
TSLPropertyBuffered | This flag determines whether the individual data layer is double buffered. This may be combined with double buffering on the drawing surface. A common use for this flag is for a relatively static map, with another data layer above with moving entities. Default value is false. |
TSLPropertyMaxTextHeight | This is the maximum allowed height, in pixels, for text to be displayed. Text greater than this will not be shown. Default value is 250 pixels. |
TSLPropertyMinZoomDisplay | The minimum zoom value to display the layer at in TMC / pixel. Default -1 -> no minimum. |
TSLPropertyMaxZoomDisplay | The maximum zoom value to display the layer at in TMC / pixel. Default -1 -> no maximum. |
TSLPropertyProgressiveDisplay | Enable or disable progressive display. Default 0 -> disabled. Note: this option should only be used when using a multi-threaded or remote loader. |
TSLPropertyRasterContrast | Set the contrast for a raster shown in a raster data layer or map data layer. Increases or decreases the range between black and white pixels. Values are -1000 (no contrast) to 1000 (maximum contrast). Default 0 -> no adjustment. |
TSLPropertyRasterBrightness | Set the brightness for a raster shown in a raster data layer or map data layer. Increases or decreases the luminance of all pixels. Values are -1000 (minimum brightness) to 1000 (maximum brightness). Default 0 -> no adjustment. |
TSLPropertyRasterGamma | Set the gamma correction for a raster shown in a raster data layer or map data layer. Applies a nonlinear correction according to the standard gamma equation. The value is a positive integer which is 100 times the required gamma value, e.g. to achieve a gamma correction of 0.15, set a value of 15. Default 100, equivalent to a gamma of 1.0 -> no correction. |
TSLPropertyLoadedSymbolsAndTextViewExpansion | This option affects the view extent used when drawing text and symbols in a MapDatalayer. This option will not normally be required to be used. Example uses are:- when generating tiled output, using the Accelerator SDK with vector map data. The value specified is a percentage of the view area to extend the view extent by. The default value is 0. The percentage can by greater then 100. Negative values are set to 0. Setting this option to a value greater then 0 will have an impact on performance as the amount of text and symbols drawn will increase. The size of the impact on performance will be dependent on the amount of text and symbols in the map and specifically the tiles being used. Only the currently loaded set of tiles will be used. |
TSLPropertyTransparency | This option allows the data layer to be rendered transparently. The value passed should be between 0 and 255, where 255 is fully opaque and 0 is not visible. The default is 255. Either buffering on the layer or on the surface as a whole must be enabled prior to setting the layer translucency. Failure to do so will cause the layer to appear with the default translucency value of 255. |
TSLPropertyNonNativeDrawing | This option allows the user to indicate to the Drawing Surface that the user is drawing geometry not using the TSLRenderingInterface or using the same drawing technology as the Drawing Surface. These options are only applicable to layers that the user draws. The default rendering is assumed to be via the TSLRenderingInterface or the same drawing technology as the Drawing Surface. See the documentation for each type of drawing surface for details on how non native rendering should be used with that surface. Setting this property will have no effect on the NT or X11 surface. |
TSLPropertyRealtimeReprojection | This option allows the user to indicate to the TSLOpenGLSurface that the layer should be re-projected at runtime using the GPU. This option will only work with the OpenGL Drawing Surface (Desktop). OpenGL 4.4 support is required. |
TSLPropertyGeometryStreaming | This option allows the user to indicate to the TSLOpenGLSurface that the layer should be rendered using geometry streaming. This is designed for layers that are static unless the view changes (examples: S52 rendering, grid data layers). When enabled, the drawing surface will capture any drawn vector geometry and save it. Until notifyChanged is called on the layer, this saved geometry will always be used. Calling notifyChanged will invalidate the saved geometry, which will then be re-captured. This option will only work with layers on an OpenGL Drawing Surface. It will not work with owner drawn geometry, raster or GDI/OGL/X11 rendering on a custom data layer. This option only works on unbuffered layers. Default value is false. |
TSLPropertyDepthClear | This option allows the user to indicate to the TSLOpenGLSurface that the depth buffer should be cleared (default) or not cleared at the beginning of each layer that is drawn. Not clearing the depth buffer at the start of drawing of a layer may cause interesting Drawing effects. |
TSLPropertyGeometryStreamingForceSymbolsAndTextToTop | This option allows the user to indicate to the TSLOpenGLSurface that text and symbol entities should be drawn above all others. This has been made an option because S52 rendering will be broken by it. This only ever has an effect if TSLPropertyGeometryStreaming is true. Default value is false. |
tsl_visible | Deprecated. |
tsl_detect | Deprecated. |
tsl_select | Deprecated. |
tsl_transparent | Deprecated. |
tsl_automatic | Deprecated. |
tsl_min_text_height | Deprecated. |
tsl_buffered | Deprecated. |
tsl_max_text_height | Deprecated. |
tsl_min_zoom_display | Deprecated. |
tsl_max_zoom_display | Deprecated. |
TSLPropertyProgressiveRasterDisplay | Deprecated. |
Enumeration determining how pixels in the input image may be considered to be transparent.
Pixels in the output image will be transparent if they map to transparent areas in the input image or if they map to areas outside of the input image.
enum TSLRasterType |
enum TSLResizeActionEnum |
This enumerated type defines what should happen to the uuExtent during a wndResize.
This is necessary since the drawing surface cannot veto a wndResize. To avoid all applications being coded to handle this situation, these flags allow TMS to manipulate the wcExtent along specified rules, to fit within the specified wndExtent.
ResizeActionMaintainCentre/TL/TR/BL/BR all attempt to keep the tmcPerPixel and hide or expose parts of the WC space accordingly. They also assume a square aspect ratio, where the tmcPerPixel is the same in both X and Y. If a different action is required then this should be implemented explicitly by the user by passing ResizeActionNone and calling the 'resize' method with the required parameters.
A map using the Dynamic Arc coordinate system, with the TSLOptionAdjustForDynamicArc option set on the Drawing Surface, causes the TSLResizeActionEnum option to behave differently than for other configurations:
Note, that these actions may be changed if the coordinate space would be exceeded. In this case, the tmcPerPixel may be changed to avoid numeric overflow.
Enumerator | |
---|---|
TSLResizeActionNone | |
TSLResizeActionMaintainCentre | |
TSLResizeActionMaintainTopLeft | |
TSLResizeActionMaintainTopRight | |
TSLResizeActionMaintainBottomLeft | |
TSLResizeActionMaintainBottomRight |
This enumerated type determines how the TSLDataLayer query algorithm proceeds as it searches for entities that match the TSLSelector object.
Note: If the entity returned is a TSLEntitySet then return TSLSelectorActionIgnoreContinue if you wish to navigate into the group to extract the entities contained in the entity set, otherwise the entire entity set will be skipped.
This enumerated type is used when determining the type of a TSLSLMEntityRefHandler.
Enumerator | |
---|---|
TSLSLMEntityRefHandlerCustomType | |
TSLSLMEntityRefHandlerFileType |
This enumeration represents the possible validation states that a TSLSLMEntityRef may have. The following values are defined:
See the documentation for TSLSLMEntityRefHandler::validateEntityRef() for more information.
This enumeration defines the threading options accepted by TSLUtilityFunctions::setThreadedOptions and returned by TSLUtilityFunctions::getThreadedOptions.
The enumeration defines a set of options which can be or'ed together in a bitwise fashion.
These options are only relevant if you are using MapLink from multiple threads. You should review the Threading section in the Developer's Guide.
Enumerator | |
---|---|
TSLThreadedOptionsRenderingSupport | This option should be enabled if you are displaying a standard data-layer in multiple threads. This option is disabled by default. |
TSLThreadedOptionsX11TTFSupport | On X11 XFT uses an internal cache which is not protected nor is it on a per Display basis. If you have setup the MapLink tslfonts.dat to use XFT True Type fonts (TTF) then you should use the methods TSLMotifSurface::lockXft() and TSLSurface::unlockXft() when ever you use a toolkit to display TTF text. This is only necessary if you are using XFT in multiple threads and XFT TTF rendering in MapLink. This option is enabled by default. |
TSLThreadedOptionsPathListSupport | This option should be enabled before TSLDrawingSurface::loadStandardConfig is called. The option ensures that locking is enabled for the default TSLPathList. No other pathlist will be created with locking turned on. It is unlikely that a user will need to turn this on as long as they follow the threading notes in the TSLPathList documentation and in the Developer's Guide. This option is disabled by default. |
TSLThreadedOptionsFilterProcessingSupport | This option is reserved for future use. |
enum TSLUUEnum |
This enumerated type is used when setting the user unit origin on a TSLDrawingSurface.
enum TSLWMSVersionEnum |