MapLink.Editor.NET

Detailed Description

This class category contains the Editor .NET API classes.

Classes
class	Envitia::MapLink::Editor::TSLNAPP6APalette
class	Envitia::MapLink::Editor::TSLNAPP6AProperties
interface	Envitia::MapLink::Editor::TSLNAPP6ARequest
class	Envitia::MapLink::Editor::TSLNAPP6ARequestHelper
class	Envitia::MapLink::Editor::TSLNAPP6ASelector
class	Envitia::MapLink::Editor::TSLNAllAttributeOperations
class	Envitia::MapLink::Editor::TSLNBorderColourOperation
class	Envitia::MapLink::Editor::TSLNCloseOperation
class	Envitia::MapLink::Editor::TSLNEdgeColourOperation
class	Envitia::MapLink::Editor::TSLNEdgeStyleOperation
class	Envitia::MapLink::Editor::TSLNEdgeWidthOperation
class	Envitia::MapLink::Editor::TSLNFeatureIDOperation
class	Envitia::MapLink::Editor::TSLNFillColourOperation
class	Envitia::MapLink::Editor::TSLNFillStyleOperation
class	Envitia::MapLink::Editor::TSLNRenderingAttributesOperation
class	Envitia::MapLink::Editor::TSLNSetTextOperation
class	Envitia::MapLink::Editor::TSLNSymbolColourOperation
class	Envitia::MapLink::Editor::TSLNSymbolSizeOperation
class	Envitia::MapLink::Editor::TSLNSymbolStyleOperation
class	Envitia::MapLink::Editor::TSLNTextColourOperation
class	Envitia::MapLink::Editor::TSLNTextFontOperation
class	Envitia::MapLink::Editor::TSLNTextSizeOperation
class	Envitia::MapLink::Editor::TSLNAllBasicOperations
class	Envitia::MapLink::Editor::TSLNArrowOperation
class	Envitia::MapLink::Editor::TSLNCircleOperation
class	Envitia::MapLink::Editor::TSLNClearOperation
class	Envitia::MapLink::Editor::TSLNCopyOperation
class	Envitia::MapLink::Editor::TSLNDeleteOperation
class	Envitia::MapLink::Editor::TSLNEllipseOperation
class	Envitia::MapLink::Editor::TSLNGroupOperation
class	Envitia::MapLink::Editor::TSLNPolygonOperation
class	Envitia::MapLink::Editor::TSLNPolylineOperation
class	Envitia::MapLink::Editor::TSLNRectangleOperation
class	Envitia::MapLink::Editor::TSLNSymbolOperation
class	Envitia::MapLink::Editor::TSLNTextOperation
class	Envitia::MapLink::Editor::TSLNUngroupOperation
class	Envitia::MapLink::Editor::TSLNAllSelectOperations
class	Envitia::MapLink::Editor::TSLNSelectAllOperation
class	Envitia::MapLink::Editor::TSLNSelectByExtentOperation
class	Envitia::MapLink::Editor::TSLNSelectByPolygonOperation
class	Envitia::MapLink::Editor::TSLNAddPointOperation
class	Envitia::MapLink::Editor::TSLNAllTransformationOperations
class	Envitia::MapLink::Editor::TSLNBackOperation
class	Envitia::MapLink::Editor::TSLNDeletePointOperation
class	Envitia::MapLink::Editor::TSLNFrontOperation
class	Envitia::MapLink::Editor::TSLNMoveOperation
class	Envitia::MapLink::Editor::TSLNMovePointOperation
class	Envitia::MapLink::Editor::TSLNRotateOperation
class	Envitia::MapLink::Editor::TSLNScaleOperation
class	Envitia::MapLink::Editor::TSLNTopologicalAddPointOperation
class	Envitia::MapLink::Editor::TSLNTopologicalDeletePointOperation
class	Envitia::MapLink::Editor::TSLNTopologicalMovePointOperation
class	Envitia::MapLink::Editor::TSLNAllOperations
class	Envitia::MapLink::Editor::TSLNCustomFeedback
class	Envitia::MapLink::Editor::TSLNCustomHighlight
class	Envitia::MapLink::Editor::TSLNCustomHighlightRequest
class	Envitia::MapLink::Editor::TSLNEditor
class	Envitia::MapLink::Editor::TSLNEditorRequest
struct	Envitia::MapLink::Editor::TSLNLocatorEvent
struct	Envitia::MapLink::Editor::TSLNEchoCoord
class	Envitia::MapLink::Editor::TSLNUserOperation
class	Envitia::MapLink::Editor::TSLNUserOperationRequest
class	Envitia::MapLink::Editor::TSLNAllWindowsOperations
class	Envitia::MapLink::Editor::TSLNWinContextHandler
class	Envitia::MapLink::Editor::TSLNWinHighlightManager
class	Envitia::MapLink::Editor::TSLNWinMoveOperation
class	Envitia::MapLink::Editor::TSLNWinRotateOperation
class	Envitia::MapLink::Editor::TSLNWinScaleOperation
class	Envitia::MapLink::Editor::TSLNWinSelectOperation
enum class	Envitia::MapLink::Editor::TSLNCursorMovementType {   Envitia::MapLink::Editor::TSLNCursorMovementType:: , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementNone = 0 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementTMCAbsolute = 1 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementTMCRelative = 2 ,   Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementMUAbsolute = 3 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementMURelative = 4 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementUUAbsolute = 5 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementUURelative = 6 ,   Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementLatLongDecimal = 7 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementLatLongAngular = 8 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementAngleDistance = 9 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementAngleTMCDistance = 10 ,   Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementBearingTMCDistance = 11 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementAngleMUDistance = 12 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementBearingMUDistance = 13 , Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementAngleUUDistance = 14 ,   Envitia::MapLink::Editor::TSLNCursorMovementType::TSLNCursorMovementBearingUUDistance = 15 }
enum class	Envitia::MapLink::Editor::TSLNEditorConstraintType {   Envitia::MapLink::Editor::TSLNEditorConstraintType::TSLNEditorConstraintNone = 0 , Envitia::MapLink::Editor::TSLNEditorConstraintType::TSLNEditorConstraintEqual = 1 , Envitia::MapLink::Editor::TSLNEditorConstraintType::TSLNEditorConstraintVertical = 2 , Envitia::MapLink::Editor::TSLNEditorConstraintType::TSLNEditorConstraintHorizontal = 3 ,   Envitia::MapLink::Editor::TSLNEditorConstraintType::TSLNEditorConstraintAngle = 4 , Envitia::MapLink::Editor::TSLNEditorConstraintType::TSLNEditorConstraintDistance = 5 }
enum class	Envitia::MapLink::Editor::TSLNDynamicEchoType {   Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoNone = 0 , Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoSegments = 1 , Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoRectangle = 2 , Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoCorners = 3 ,   Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoScale = 4 , Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoParallel = 5 , Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoRay = 6 , Envitia::MapLink::Editor::TSLNDynamicEchoType::TSLNDynamicEchoPerpendicular = 7 }
enum class	Envitia::MapLink::Editor::TSLNEchoCoordType { Envitia::MapLink::Editor::TSLNEchoCoordType::TSLNEchoCoordFixed = 0 , Envitia::MapLink::Editor::TSLNEchoCoordType::TSLNEchoCoordMoving = 1 , Envitia::MapLink::Editor::TSLNEchoCoordType::TSLNEchoCoordConstrained = 2 }
enum class	Envitia::MapLink::Editor::TSLNFixedEchoType { Envitia::MapLink::Editor::TSLNFixedEchoType::TSLNFixedEchoNone = 0 , Envitia::MapLink::Editor::TSLNFixedEchoType::TSLNFixedEchoPoint = 1 , Envitia::MapLink::Editor::TSLNFixedEchoType::TSLNFixedEchoLine = 2 }
enum class	Envitia::MapLink::Editor::TSLNOperationType { Envitia::MapLink::Editor::TSLNOperationType::TSLNOperationManipulation , Envitia::MapLink::Editor::TSLNOperationType::TSLNOperationPrimitive , Envitia::MapLink::Editor::TSLNOperationType::TSLNOperationAttribute }

---

Class Documentation

Envitia::MapLink::Editor::TSLNLocatorEvent

struct Envitia::MapLink::Editor::TSLNLocatorEvent

This is the TSLNLocatorEvent class.

It is a structure used to describe locator (mouse) events occurring on the drawing surface.

Class Members
TSLNButtonType	m_buttonType
TSLNLocatorType	m_locatorType
TSLNModifierType	m_modifiers
int	m_x	X coordinate of locator event, in TMC space.
int	m_y	Y coordinate of locator event, in TMC space.

Envitia::MapLink::Editor::TSLNEchoCoord

struct Envitia::MapLink::Editor::TSLNEchoCoord

This component represents a dynamic echo coordinate.

It holds a position (in TMC space), and a type. The type indicates to the editor how the position should be interpreted. An array of these components should be passed by the operation to the TSLNUserOperationRequest::setDynamic Echo method.

A coordinate of type TSLNEchoCoordFixed is always fixed at the specified TMC position.

A coordinate of type TSLNEchoCoordMoving will move with the locator. The position is an offset from the locator position.

A coordinate of type TSLNEchoCoordConstrained will move with the locator, but may have the X or Y coordinate fixed, dependent upon the current constraint mode. An anchor point may be supplied to provide an offset from the locator. The anchor point position is subtracted from the TSLNEchoCoord position to determine the offset. If no anchor point is supplied, then the coordinate is fixed to the locator with no offset.

Class Members
TSLNEchoCoordType	m_type	Data Members for Associations.
int	m_x	The X TMC space location for the dynamic echo. May be absolute for fixed and constrained coordinates, or relative for moving coordinates.
int	m_y	The X TMC space location for the dynamic echo. May be absolute for fixed and constrained coordinates, or relative for moving coordinates.

Enumeration Type Documentation

TSLNCursorMovementType

enum class Envitia::MapLink::Editor::TSLNCursorMovementType

strong

This enumeration defines the different types of cursor movement feedback that may be supplied to the application via the TSLNEditorRequest::onCursor Movement method.

Enumerator
TSLNCursorMovementNone	No feedback is required.
TSLNCursorMovementTMCAbsolute	The absolute coordinates of the cursor are required, in TMC units. Format specifiers of the form "%g" or "%f" are required.
TSLNCursorMovementTMCRelative	The distance,in TMC units of the cursor relative to the last selected point are required. Format specifiers of the form "%g" or "%f" are required.
TSLNCursorMovementMUAbsolute	The absolute coordinates of the cursor are required, in Map units. Format specifiers of the form "%g" or "%f" are required.
TSLNCursorMovementMURelative	The distance in Map units of the cursor relative to the last selected point are required. Format specifiers of the form "%g" or "%f" are required.
TSLNCursorMovementUUAbsolute	The absolute coordinates of the cursor are required, in User units. Format specifiers of the form "%g" or "%f" are required.
TSLNCursorMovementUURelative	The distance in User units of the cursor relative to the last selected point are required. Format specifiers of the form "%g" or "%f" are required.
TSLNCursorMovementLatLongDecimal	The latitude/longitude of the cursor is required, in decimal degrees. Format specifiers of the form "%g" or "%f" are required.
TSLNCursorMovementLatLongAngular	The latitude/longitude of the cursor is required, in degrees, minutes and decimal seconds. Format specifiers of the form "%s" are required.
TSLNCursorMovementAngleDistance
TSLNCursorMovementAngleTMCDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve X axis, positive anti-clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLNCursorMovementBearingTMCDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve Y axis, positive clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLNCursorMovementAngleMUDistance	The angle and distance in Map units of the cursor from the last selected point are required. The angle will be relative to the +ve X axis, positive anti-clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLNCursorMovementBearingMUDistance	The angle and distance in Map units of the cursor from the last selected point are required. The angle will be relative to the +ve Y axis, positive clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLNCursorMovementAngleUUDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve X axis, positive anti-clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.
TSLNCursorMovementBearingUUDistance	The angle and distance in TMC units of the cursor from the last selected point are required. The angle will be relative to the +ve Y axis, positive clockwise. The format print will display angle first, followed by the distance. Format specifiers of "%g" or "%f" are required.

TSLNDynamicEchoType

enum class Envitia::MapLink::Editor::TSLNDynamicEchoType

strong

This enumeration specifies the various dynamic echo styles. These generally move with some point(s) relative to the locator position.

Valid values are

TSLNDynamicEchoNone - No echo is drawn. No TSLNEchoCoords should be specified. No anchor point should be specified.

TSLNDynamicEchoSegments - N Line segments are drawn. N*2 TSLNEchoCoords are specified. These coords may be fixed, moving or constrained. For example, a simple rubber-banded line may be created by passing a fixed TSLNEchoCoord specifying the fixed end of the line and a moving TSLNEchoCoord with offset 0,0. If the moving end of the line may need to be constrained to some value (eg. a movepoint operation), then a fixed TSLNEchoCoord and a constrained TSLNEchoCoord should be specified. The position passed in the constrained TSLNEchoCoord should be the values that will be applied during a constraint. Optionally, an anchor point may be specified to give an offset from the locator for constrained values.

TSLNDynamicEchoRectangle - A rectangle is drawn. 2 TSLNEchoCoords are specified. These may be fixed, moving or constrained. An anchor point may be specified if constrained TSLEchoCoords are used.

TSLNDynamicEchoCorners - The corners of a rectangle are drawn. 2 TSLNEchoCoords are specified. These may be fixed, moving or constrained. An anchor point may be specified if constrained TSLNEchoCoords are used.

TSLNDynamicEchoScale - An equal scaling rectangle is drawn. 2 fixed TSLNEchoCoords are specified. These should be the rectangle that is to be scaled. An anchor point must be specified to indicate the scaling origin.

TSLNDynamicEchoParallel - An echo line parallel to the specified line is drawn. The intersection of the perpendicular from the locator position to the line segment is calculated. If the intersection is within the line segment, then the echo is a parallel line passing through the locator position, whose endpoints are perpendicular to the line segment endpoints. If the intersection is outside the line segment, then the echo is a parallel line whose endpoints are the current locator position and a perpendicular to the farthest end of the line segment. 2 fixed TSLNEchoCoords are specified. No anchor point is required.

TSLNDynamicEchoRay - An echo line extending from either end of the specified segment. The intersection of the perpendicular from the locator position to the line containing the specified segment is calculated. If the intersection is within the specified line segment, then no echo is drawn. Otherwise the echo is drawn from the intersection to the nearest endpoint of the segment. 2 fixed TSLNEchoCoords are specified, describing the line segment. No anchor point is required.

TSLNDynamicEchoPerpendicular - An echo line is drawn from the the current locator position to the intersection of the perpendicular from the locator position to the line containing the line segment. 2 (Fixed) TSLNEchoCoords are specified. No anchor point is required.

Enumerator
TSLNDynamicEchoNone
TSLNDynamicEchoSegments
TSLNDynamicEchoRectangle
TSLNDynamicEchoCorners
TSLNDynamicEchoScale
TSLNDynamicEchoParallel
TSLNDynamicEchoRay
TSLNDynamicEchoPerpendicular

TSLNEchoCoordType

enum class Envitia::MapLink::Editor::TSLNEchoCoordType

strong

This enumerated type indicates how the editor should interpret a TSLNEcho Coord for dynamic echo.

A coordinate of type TSLNEchoCoordFixed is always fixed at the specified TMC position.

A coordinate of type TSLNEchoCoordMoving will move with the locator. The position is an offset from the locator position.

A coordinate of type TSLNEchoCoordConstrained will move with the locator, but may have the X or Y coordinate fixed, dependent upon the current constraint mode. An anchor point may be supplied to provide an offset from the locator. The anchor point position is subtracted from the TSLNEchoCoord position to determine the offset. If no anchor point is supplied, then the coordinate is fixed to the locator with no offset.

Enumerator
TSLNEchoCoordFixed
TSLNEchoCoordMoving
TSLNEchoCoordConstrained

TSLNEditorConstraintType

enum class Envitia::MapLink::Editor::TSLNEditorConstraintType

strong

This is the TSLNEditorConstraintType enum

This is an enumerator for locator movement constraints. The enumerated values are.

TSLNEditorConstraintNone : No constraint is applied (Unequal scaling) when resizing from the edge. Movement is restricted to the vertical or horizontal direction when resizing from the centre vertical or horizontal axes.

TSLNEditorConstraintEqual : Equal scaling is applied.

TSLNEditorConstraintVertical : Movement is restricted to the vertical axis.

TSLNEditorConstraintHorizontal : Movement is restricted to the horizontal axis.

TSLNEditorConstraintAngle : Movement is restricted to the specified angle from the previous point.

TSLNEditorConstraintDistance : Movement is restricted to the specified distance from the previous point.

Enumerator
TSLNEditorConstraintNone
TSLNEditorConstraintEqual
TSLNEditorConstraintVertical
TSLNEditorConstraintHorizontal
TSLNEditorConstraintAngle
TSLNEditorConstraintDistance

TSLNFixedEchoType

enum class Envitia::MapLink::Editor::TSLNFixedEchoType

strong

This enumeration specifies the various fixed echo styles.

These are generally temporary primitives rendered into the data layer.

TSLNFixedEchoNone - There is no primitive echo

TSLNFixedEchoPoint - Symbols are placed at each location in the point array. The attributes of these symbols are specified in the configuration file.

TSLNFixedEchoLine - A single polyline is drawn connecting the points specified in the point array. The attributes of this line is specified in the configuration file.

Enumerator
TSLNFixedEchoNone
TSLNFixedEchoPoint
TSLNFixedEchoLine

TSLNOperationType

enum class Envitia::MapLink::Editor::TSLNOperationType

strong

This enumerated type specifies the basic type of a user operation.

Valid values are

TSLNOperationManipulation - These operations are meant to manipulate objects on the select list. The current operation is deactivated.

TSLNOperationPrimitive - These operations are meant to create objects for the select list. The current operation is deactivated and the select list is cleared before the operation is activated.

TSLNOperationAttribute - These are transient operations which do not affect the select list itself. The current operation is left active.

Enumerator
TSLNOperationManipulation
TSLNOperationPrimitive
TSLNOperationAttribute