MapLink Pro 11.1.1.0.
Envitia MapLink Pro: The Ultimate Mapping Application Toolkit
Loading...
Searching...
No Matches
TSLSpecialisedData Class Reference

Detailed Description

Structure used to hold additional information for the more specialised operations.

A pointer to this should be passed to the activate methods when an operation requires it.

Public Member Functions

 TSLSpecialisedData ()
 
 TSLSpecialisedData (const TSLSpecialisedData &other)
 
TSLSpecialisedDataoperator= (const TSLSpecialisedData &other)
 

Public Attributes

Double m_scaleFactor
 
Double m_arcAngle
 
Double m_arrowAngle
 
Double m_braceBlobEccentricity
 
int m_arrowTail
 
int m_arrowHead
 
int m_boundWidth
 
int m_braceBlobRadius
 
int m_textGap
 
int m_barSize
 
int m_textHeight
 
int m_tickSpacing
 
int m_minGap
 
int m_maxGap
 
int m_gapMarkerFeatureID
 
int m_featureID
 
int m_textFont
 
int m_textColour
 
int m_tickStyle
 
int m_tickColour
 
int m_lineStyle
 
int m_lineColour
 
int m_lineThickness
 
int m_numTicks
 
TSLConstructionType m_type
 
int m_fillColour
 
int m_fillStyle
 
char m_format [32]
 
int m_labelOnArrowHead
 
Double m_extraScaleFactor
 
int m_borderWidth
 
int m_borderColour
 
int m_crossBarSize
 
int m_rayIntersectionStyle
 
int m_rayIntersectionColour
 

Constructor & Destructor Documentation

◆ TSLSpecialisedData() [1/2]

TSLSpecialisedData::TSLSpecialisedData ( )
inline

Default constructor for the TSLSpecialisedData class.

◆ TSLSpecialisedData() [2/2]

TSLSpecialisedData::TSLSpecialisedData ( const TSLSpecialisedData & other)
inline

This is the copy constructor for the TSLSpecialisedData class.

Member Function Documentation

◆ operator=()

TSLSpecialisedData & TSLSpecialisedData::operator= ( const TSLSpecialisedData & other)
inline

Member Data Documentation

◆ m_arcAngle

Double TSLSpecialisedData::m_arcAngle

Angle for arc intersection operation. The arc is drawn this many degrees either side of the chosen direction.

◆ m_arrowAngle

Double TSLSpecialisedData::m_arrowAngle

Sweep back angle for arrow heads, 0 to 90 degrees.

  • 0 degrees = |
  • 90 degrees = T

◆ m_arrowHead

int TSLSpecialisedData::m_arrowHead

Length, in TMC units, of arrow head lines.

◆ m_arrowTail

int TSLSpecialisedData::m_arrowTail

Length, in TMC units, of arrow tail.

◆ m_barSize

int TSLSpecialisedData::m_barSize

Length or bars used for T and H-Bars and dimension arrow construction entities, in TMC.

◆ m_borderColour

int TSLSpecialisedData::m_borderColour

This attribute defines the colour used for any border created. If 0, or -1, it defaults to the same as the edge colour.

◆ m_borderWidth

int TSLSpecialisedData::m_borderWidth

This is the width (in TMC units) of any border data that will be added to a polygon that is created by the operation.

◆ m_boundWidth

int TSLSpecialisedData::m_boundWidth

Maximum distance either size of the chosen location where the data will be analysed during bound-style operations.

◆ m_braceBlobEccentricity

Double TSLSpecialisedData::m_braceBlobEccentricity

Eccentricity for blob at end of brace markers. 1.0 = circle.

◆ m_braceBlobRadius

int TSLSpecialisedData::m_braceBlobRadius

Radius of major axis of ellipses created by the Brace operation.

◆ m_crossBarSize

int TSLSpecialisedData::m_crossBarSize

This attribute defines the size of the cross bar for H and T Bars. The cross bar is the line running parallel to the selected edge. If 0, then it defaults to the same as the barSize attribute

◆ m_extraScaleFactor

Double TSLSpecialisedData::m_extraScaleFactor

This is the extra scale factor for distance calculations. It is used to convert from internal TMC units, to the required display units.

For conversion from TMC to display units, the TMC value is multiplied by this scale factor.

◆ m_featureID

int TSLSpecialisedData::m_featureID

Numeric feature identifier attached to construction entity and used for identification purposes.

◆ m_fillColour

int TSLSpecialisedData::m_fillColour

Fill colour used for construction entities and defined as an index referencing a colour in the application colour definition file.

◆ m_fillStyle

int TSLSpecialisedData::m_fillStyle

Fill style used for construction entities and defined as an index referencing a fill style in the application fill style definition file.

◆ m_format

char TSLSpecialisedData::m_format[32]

Format of real values displayed as text in construction entities. C printf format is used, for example "%g" will display only the significant digits and "%.nf" will always display the value to n decimal places.

For two-part displays, such as feet and inches, specify two conversion parameters, "%g ft, %g in" and two scale factors - one in the scaleFactor attribute and one in the extraScaleFactor attribute.

◆ m_gapMarkerFeatureID

int TSLSpecialisedData::m_gapMarkerFeatureID

Numeric feature identifier attached to point entities created as a result of a Gap Detection operation.

◆ m_labelOnArrowHead

int TSLSpecialisedData::m_labelOnArrowHead

A flag specifying whether a label's text will appear at the base or the head of a arrow.

◆ m_lineColour

int TSLSpecialisedData::m_lineColour

Line colour used for construction entities and defined as an index referencing a colour in the application colour definition file.

◆ m_lineStyle

int TSLSpecialisedData::m_lineStyle

Line style used for construction entities and defined as an index referencing a line style in the application line style definition file.

◆ m_lineThickness

int TSLSpecialisedData::m_lineThickness

Width of lines used for construction entities in device units.

◆ m_maxGap

int TSLSpecialisedData::m_maxGap

Higher tolerance value above which points are considered the separate for Lasso, Bound and Gap Detection operations.

When performing a gap detection, endpoints that lie between minGap and maxGap TMC units of another line segment, are considered to be a gap.

◆ m_minGap

int TSLSpecialisedData::m_minGap

Lower tolerance value below which points are considered the same for Lasso, Bound and Gap Detection operations.

◆ m_numTicks

int TSLSpecialisedData::m_numTicks

Number of construction symbols to place between the start and end construction points. If 0, use marker spacing instead; if 1, marker is placed only at the end point; if greater than 1, specified number of markers are placed, including one at both start and end points.

◆ m_rayIntersectionColour

int TSLSpecialisedData::m_rayIntersectionColour

Colour of ray intersection symbols and defined as an index referencing a colour in the application colour definition file.

◆ m_rayIntersectionStyle

int TSLSpecialisedData::m_rayIntersectionStyle

Style of the ray intersection symbols and defined as an index referencing a style in the application symbol definition file.

This is assumed to be a fixed-size vector symbol.

Pass 0 if no intersection is required.

◆ m_scaleFactor

Double TSLSpecialisedData::m_scaleFactor

This is the scale factor for distance calculations. It is used to convert from internal TMC units, to the required display units.

For conversion from TMC to display units, the TMC value is multiplied by this scale factor.

See also the extraScaleFactor attribute.

◆ m_textColour

int TSLSpecialisedData::m_textColour

Text colour used for construction text and defined as an index referencing a colour in the application colour definition file.

◆ m_textFont

int TSLSpecialisedData::m_textFont

Text font used for construction text and identified as an index referencing a font in the application font definition file.

◆ m_textGap

int TSLSpecialisedData::m_textGap

Size in TMC units of the gap between the ends of the measurement arrows, in which the text is rendered, for dimension arrow construction entities.

◆ m_textHeight

int TSLSpecialisedData::m_textHeight

Height of construction text, in TMC units.

◆ m_tickColour

int TSLSpecialisedData::m_tickColour

Colour of construction tick symbols and defined as an index referencing a colour in the application colour definition file.

◆ m_tickSpacing

int TSLSpecialisedData::m_tickSpacing

Distance between construction tick symbols in TMC units.

◆ m_tickStyle

int TSLSpecialisedData::m_tickStyle

Style of the construction tick symbols and defined as an index referencing a style in the application symbol definition file.

This is assumed to be a fixed-size vector symbol.

◆ m_type

TSLConstructionType TSLSpecialisedData::m_type

This attribute defines the rendering style for parallel, perpendicular and ray operations.

The values represent:

  • Simple Line
  • Tick symbols
  • Line and tick Symbols
  • Dimension Arrow (internal text, arrows pointing outwards).
  • Dimension Arrow (external text, arrows pointing outwards).
  • Dimension Arrow (internal text, arrows pointing inwards).