Common

Detailed Description

This class category contains classes that are common across the API and internal sub-systems.

Classes
class	TSLCoord
class	TSLEnvelope
class	TSLSimpleString
class	TSLVariant

Enumerations
enum	TSLGeometryType {   TSLGeometryTypeEntity = 0 , TSLGeometryTypeText = 1 , TSLGeometryTypeEntitySet = 4 , TSLGeometryTypeSymbol = 6 ,   TSLGeometryTypeArc = 10 , TSLGeometryTypePolyline = 11 , TSLGeometryTypePolygon = 15 , TSLGeometryTypeEllipse = 16 ,   TSLGeometryTypeRectangle = 17 , TSLGeometryTypeEntityBase = 18 , TSLGeometryTypeMultiPoint = 19 , TSLGeometryTypeMultiPointPart = 20 ,   TSLGeometryTypeMultiPolygon = 21 , TSLGeometryTypeMultiPolygonPart = 22 , TSLGeometryTypeMultiPolyline = 23 , TSLGeometryTypeMultiPolylinePart = 24 ,   TSLGeometryTypeGeodeticPolyline = 28 , TSLGeometryTypeGeodeticText = 30 , TSLGeometryTypeGeodeticSymbol = 31 , TSLGeometryTypeGeodeticArc = 32 ,   TSLGeometryTypeGeodeticPolygon = 33 , TSLGeometryTypeGeodeticEllipse = 34 , TSLGeometryTypeUserType = 36 , TSLGeometryTypeBorderedPolygon = 100 ,   TSLGeometryTypeArrow = 102 , TSLGeometryType3DEntity = 200 , TSLGeometryType3DEntitySet = 201 , TSLGeometryType3DModel = 202 ,   TSLGeometryType3DTriangle = 203 , TSLGeometryType3DTriangleFan = 204 , TSLGeometryType3DTriangleStrip = 205 , TSLGeometryType3DQuad = 206 ,   TSLGeometryType3DQuadStrip = 207 , TSLGeometryType3DPolyline = 208 , TSLGeometryType3DPolygon = 209 , TSLGeometryType3DText = 210 ,   TSLGeometryType3DSymbol = 211 , TSLGeometryType3DEllipse = 212 , TSLGeometryType3DAPP6ASymbol = 213 , TSLGeometryType3DSensor = 214 ,   TSLGeometryTypeExtruded2DPolyline = 250 , TSLGeometryTypeExtruded2DPolygon = 251 , TSLGeometryTypeExtruded2DRectangle = 252 , TSLGeometryType3DUserType = 253 }
enum	TSLMapLinkVersion {   TSL_MAPLINK_PRE_5_0 = -1 , TSL_MAPLINK_INVALID_VERSION = -2 , TSL_MAPLINK_7_6 = 10 , TSL_MAPLINK_9_0 = 12 ,   TSL_MAPLINK_DEFAULT_VERSION = 0 , TSL_MAPLINK_5_0 = 1 , TSL_MAPLINK_5_1 = 2 , TSL_MAPLINK_5_2 = 3 ,   TSL_MAPLINK_5_3 = 4 , TSL_MAPLINK_5_4 = 5 , TSL_MAPLINK_6_0 = 6 , TSL_MAPLINK_7_0 = 7 ,   TSL_MAPLINK_7_1 = 8 , TSL_MAPLINK_7_5 = 9 , TSL_MAPLINK_8_0 = 10 , TSL_MAPLINK_8_1 = 11 ,   TSL_MAPLINK_10_0 = 12 , TSL_MAPLINK_10_1 = 13 , TSL_MAPLINK_10_2 = 14 , TSL_MAPLINK_11_1 = 15 ,   TSL_CURRENT_MAPLINK_VERSION = TSL_MAPLINK_11_1 , TSL_RELEASED_MAPLINK_VERSION = TSL_MAPLINK_11_1 }
enum	TSLVariantType {   TSLVariantTypeEmpty = 0 , TSLVariantTypeNull = 1 , TSLVariantTypeBool = 2 , TSLVariantTypeChar = 3 ,   TSLVariantTypeShort = 4 , TSLVariantTypeLong = 5 , TSLVariantTypeFloat = 6 , TSLVariantTypeStr = 7 ,   TSLVariantTypeDouble = 8 , TSLVariantTypeEntityID = 9 , TSLVariantTypeULong = 10 , TSLVariantTypeDateTime = 11 ,   TSLVariantTypeBinary = 12 , TSLVariantTypeCode = 13 , TSLVariantTypeMeasurement = 14 , TSLVariantTypeReference = 15 ,   TSLVariantTypeURI = 16 , TSLVariantTypePtr = 17 , TSLVariantTypeVariant = 18 }
enum	TSLColourPackType { TSLColourPackTypeRGB }
#define	TSLComposeRGB(r, g, b)
#define	TSLDecomposeRGB(colour, r, g, b)
#define	TSLIsColourRGB(colour)

Macro Definition Documentation

TSLComposeRGB

#define TSLComposeRGB	(		r,
			g,
			b )

Value:

( (0x40 << 24) | ((r) << 16) | ((g) << 8) | (b) )

TSLComposeRGB( unsigned char r, unsigned char g, unsigned char b );

Composes the provided RGB values and returns them as an integer that can be passed to the setFeatureRendering methods on the drawing surface or data layers in place of a colour index.

TSLDecomposeRGB

#define TSLDecomposeRGB	(		colour,
			r,
			g,
			b )

Value:

r = (unsigned char)( ((colour) >> 16) & 0xFF ); \
g = (unsigned char)( ((colour) >> 8) & 0xFF );  \
b = (unsigned char)( (colour) & 0xFF )

TSLDecomposeRGB( int colour, unsigned char& r, unsigned char& g, unsigned char& b );

Given an RGB value as created by TSLComposeRGB() or TSLRGB::composeRGB(), this macro will split the value into its respective R, G and B components and store them in the given variables.

TSLIsColourRGB

#define TSLIsColourRGB

(

colour

)

Value:

( ((colour) & 0x40000000) && ((colour) >= 0) )

TSLIsColourRGB( int colour );

Returns true if the provided integer contains an RGB value created by TSLComposeRGB() or TSLRGB::composeRGB(). Otherwise returns false.

Enumeration Type Documentation

TSLColourPackType

enum TSLColourPackType

TSLGeometryType

enum TSLGeometryType

Enumeration describing the supported geometry types.

Enumerator
TSLGeometryTypeEntity	TSLEntity.
TSLGeometryTypeText	TSLText.
TSLGeometryTypeEntitySet	TSLEntitySet.
TSLGeometryTypeSymbol	TSLSymbol.
TSLGeometryTypeArc	TSLArc.
TSLGeometryTypePolyline	TSLPolyline.
TSLGeometryTypePolygon	TSLPolygon.
TSLGeometryTypeEllipse	TSLEllipse.
TSLGeometryTypeRectangle	TSLRectangle.
TSLGeometryTypeEntityBase	TSLEntityBase.
TSLGeometryTypeMultiPoint	TSLMultiPoint.
TSLGeometryTypeMultiPointPart	TSLMultiPointPart.
TSLGeometryTypeMultiPolygon	TSLMultiPolygon.
TSLGeometryTypeMultiPolygonPart	TSLMultiPolygonPart.
TSLGeometryTypeMultiPolyline	TSLMultiPolyline.
TSLGeometryTypeMultiPolylinePart	TSLMultiPolylinePart.
TSLGeometryTypeGeodeticPolyline	TSLGeodeticPolyline.
TSLGeometryTypeGeodeticText	TSLGeodeticText.
TSLGeometryTypeGeodeticSymbol	TSLGeodeticSymbol.
TSLGeometryTypeGeodeticArc	TSLGeodeticArc.
TSLGeometryTypeGeodeticPolygon	TSLGeodeticPolygon.
TSLGeometryTypeGeodeticEllipse	TSLGeodeticEllipse.
TSLGeometryTypeUserType	TSLUserGeometryEntity.
TSLGeometryTypeBorderedPolygon	TSLBorderedPolygon.
TSLGeometryTypeArrow	TSLArrow.
TSLGeometryType3DEntity	TSL3DEntity.
TSLGeometryType3DEntitySet	TSL3DEntitySet.
TSLGeometryType3DModel	TSL3DModel.
TSLGeometryType3DTriangle	TSL3DTriangle.
TSLGeometryType3DTriangleFan	TSL3DTriangleFan.
TSLGeometryType3DTriangleStrip	TSL3DTriangleStrip.
TSLGeometryType3DQuad	TSL3DQuad.
TSLGeometryType3DQuadStrip	TSL3DQuadStrip.
TSLGeometryType3DPolyline	TSL3DPolyline.
TSLGeometryType3DPolygon	TSL3DPolygon.
TSLGeometryType3DText	TSL3DText.
TSLGeometryType3DSymbol	TSL3DSymbol.
TSLGeometryType3DEllipse	TSL3DEllipse.
TSLGeometryType3DAPP6ASymbol	TSL3DAPP6ASymbol.
TSLGeometryType3DSensor	TSL3DSensor.
TSLGeometryTypeExtruded2DPolyline	TSLExtruded2DPolyline.
TSLGeometryTypeExtruded2DPolygon	TSLExtruded2DPolygon.
TSLGeometryTypeExtruded2DRectangle	TSLExtruded2DRectangle.
TSLGeometryType3DUserType	TSL3DUserGeometryEntity.

TSLMapLinkVersion

enum TSLMapLinkVersion

This enumeration is used to select file compatibility with earlier MapLink releases.

TSL_MAPLINK_DEFAULT_VERSION will give the same output as the Current release.

Enumerator
TSL_MAPLINK_PRE_5_0	Do Not Use.
TSL_MAPLINK_INVALID_VERSION	Do Not Use.
TSL_MAPLINK_7_6	Do Not Use.
TSL_MAPLINK_9_0	Do Not Use.
TSL_MAPLINK_DEFAULT_VERSION
TSL_MAPLINK_5_0
TSL_MAPLINK_5_1
TSL_MAPLINK_5_2
TSL_MAPLINK_5_3
TSL_MAPLINK_5_4
TSL_MAPLINK_6_0
TSL_MAPLINK_7_0
TSL_MAPLINK_7_1
TSL_MAPLINK_7_5
TSL_MAPLINK_8_0
TSL_MAPLINK_8_1
TSL_MAPLINK_10_0
TSL_MAPLINK_10_1
TSL_MAPLINK_10_2
TSL_MAPLINK_11_1
TSL_CURRENT_MAPLINK_VERSION
TSL_RELEASED_MAPLINK_VERSION	Used for beta releases of MapLink to warn when creating Maps and Studio projects.

TSLVariantType

enum TSLVariantType

Enumeration describing the TSLVariant type.

Enumerator
TSLVariantTypeEmpty
TSLVariantTypeNull	null string
TSLVariantTypeBool	bool
TSLVariantTypeChar	8bit char
TSLVariantTypeShort	16bit short
TSLVariantTypeLong	32bit long
TSLVariantTypeFloat	32bit float
TSLVariantTypeStr	string
TSLVariantTypeDouble	64bit double
TSLVariantTypeEntityID	TSLEntityID.
TSLVariantTypeULong	32-bit unsigned long
TSLVariantTypeDateTime	TSLTimeType.
TSLVariantTypeBinary	TSLVariant::Binary.
TSLVariantTypeCode	TSLVariant::Code.
TSLVariantTypeMeasurement	TSLVariant::Measurement.
TSLVariantTypeReference	string
TSLVariantTypeURI	string
TSLVariantTypePtr	void * pointer, 32bit when compiled 32bit, 64bit when compiled 64bit
TSLVariantTypeVariant	A collection of other TSLVariants.