MapLink Pro 11.1.1.0.
Envitia MapLink Pro: The Ultimate Mapping Application Toolkit
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
TSLRenderingAttributes Class Reference
MapLink Pro Developer Toolkit » Geometry API

Detailed Description

This class contains a complete set of rendering attributes.

Public Types

enum  { UNDEFINED_VALUE = TSL_UNDEFINED_VALUE , MULTIPLE_VALUE = TSL_MULTIPLE_VALUE }
 

Public Member Functions

 TSLRenderingAttributes ()
 
 TSLRenderingAttributes (const TSLRenderingAttributes &rhs)
 
bool merge (const TSLRenderingAttributes *source)
 
void mergeWithParent (const TSLRenderingAttributes &parent)
 
TSLRenderingAttributes & operator= (const TSLRenderingAttributes &rhs)
 
TSLRenderingAttributes & operator+= (const TSLRenderingAttributes &other)
 
bool operator== (const TSLRenderingAttributes &other) const
 Equality operator.
 
void reset ()
 

Public Attributes

int m_borderColour
 
int m_borderWidth
 
int m_edgeColour
 
int m_edgeStyle
 
double m_edgeThickness
 
TSLDimensionUnits m_edgeThicknessUnits
 
int m_edge3DDepthTest
 
double m_entity3DMinDrawDistance
 
double m_entity3DMaxDrawDistance
 
int m_exteriorEdgeColour
 
int m_exteriorEdgeStyle
 
double m_exteriorEdgeThickness
 
TSLDimensionUnits m_exteriorEdgeThicknessUnits
 
int m_fillColour
 
int m_fillStyle
 
int m_fill3DDepthTest
 
TSLRenderLevel m_renderLevel
 
int m_symbolColour
 
int m_symbolFontCharacter
 
int m_symbolMaxPixelSize
 
int m_symbolMinPixelSize
 
TSLSymbolRotation m_symbolRotatable
 
TSLRasterSymbolScalable m_symbolScalable
 
double m_symbolSizeFactor
 
TSLDimensionUnits m_symbolSizeFactorUnits
 
int m_symbolStyle
 
int m_symbol3DDepthTest
 
int m_textBackgroundColour
 
int m_textBackgroundEdgeColour
 
TSLTextBackgroundMode m_textBackgroundMode
 
int m_textBackgroundStyle
 
int m_textColour
 
int m_textFont
 
TSLHorizontalAlignment m_textHorizontalAlignment
 
int m_textMaxPixelHeight
 
int m_textMinPixelHeight
 
TSLDimensionUnits m_textOffsetUnits
 
double m_textOffsetX
 
double m_textOffsetY
 
TSLTextRotation m_textRotatable
 
double m_textSizeFactor
 
TSLDimensionUnits m_textSizeFactorUnits
 
TSLVerticalAlignment m_textVerticalAlignment
 
int m_text3DDepthTest
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
UNDEFINED_VALUE 
MULTIPLE_VALUE 

Constructor & Destructor Documentation

◆ TSLRenderingAttributes() [1/2]

TSLRenderingAttributes::TSLRenderingAttributes ( )

Default constructor.

All values are set to their 'undefined' state, as if reset had been called.

◆ TSLRenderingAttributes() [2/2]

TSLRenderingAttributes::TSLRenderingAttributes ( const TSLRenderingAttributes & rhs)

Copy constructor for TSLRenderingAttributes

Member Function Documentation

◆ merge()

bool TSLRenderingAttributes::merge ( const TSLRenderingAttributes * source)

This method merges the specified TSLRenderingAttributes with this one. Each value in the specified structure is compared with the equivalent in this one.

If either value is 'multiple', then the value is ignored.

If this value is 'undefined' or differs from the one contained within the source structure then the value is set to that which is contained within the source structure, provided the value is defined.

Returns true on success, false otherwise.

◆ mergeWithParent()

void TSLRenderingAttributes::mergeWithParent ( const TSLRenderingAttributes & parent)

Merge with a 'parent' set of attributes

This method performs a merge with a set of 'parent' attributes. Any attribute in this object which is currently set to the 'undefined' value may be overwritten with the parent's value.

Parameters
parentThe parent object to merge with

◆ operator+=()

TSLRenderingAttributes & TSLRenderingAttributes::operator+= ( const TSLRenderingAttributes & other)

Addition operator.

This method merges the specified TSLRenderingAttributes with this one. Each value in the specified structure is compared with the equivalent in this one.

If this value is 'multiple', then the other value is ignored.

If this value is 'undefined', and the other value has a defined value, then the other value is copied to this structure.

If neither value is 'undefined', and the values are different, then this value is set to 'multiple'

◆ operator=()

TSLRenderingAttributes & TSLRenderingAttributes::operator= ( const TSLRenderingAttributes & rhs)

Assignment operator

◆ operator==()

bool TSLRenderingAttributes::operator== ( const TSLRenderingAttributes & other) const

Equality operator.

◆ reset()

void TSLRenderingAttributes::reset ( )
inline

Resets the structure to default, 'undefined' values

Member Data Documentation

◆ m_borderColour

int TSLRenderingAttributes::m_borderColour

Border colour for bordered polygons

Equivalent of TSLRenderingAttributeBorderColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_borderWidth

int TSLRenderingAttributes::m_borderWidth

Border width of Bordered Polygons - in TMC units

Equivalent of TSLRenderingAttributeBorderWidth .

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_edge3DDepthTest

int TSLRenderingAttributes::m_edge3DDepthTest

Equivalent of TSLRenderingAttributeEdgeDepthTest

The undefined value is TSL3DDepthTest::TSL3DDepthTestUndefined(3)

◆ m_edgeColour

int TSLRenderingAttributes::m_edgeColour

Edge colour for lines, arcs etc.

Equivalent of TSLRenderingAttributeEdgeColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_edgeStyle

int TSLRenderingAttributes::m_edgeStyle

Edge style for lines, arcs etc.

Equivalent of TSLRenderingAttributeEdgeStyle.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_edgeThickness

double TSLRenderingAttributes::m_edgeThickness

Edge thickness for lines, arcs etc.

Equivalent of TSLRenderingAttributeEdgeThickness.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_edgeThicknessUnits

TSLDimensionUnits TSLRenderingAttributes::m_edgeThicknessUnits

Edge thickness units for lines, arcs etc.

Equivalent of TSLRenderingAttributeEdgeThicknessUnits

The undefined value is TSLDimensionUnitsUndefined

The multiple value is TSLDimensionUnitsMultiple

◆ m_entity3DMaxDrawDistance

double TSLRenderingAttributes::m_entity3DMaxDrawDistance

The lower bound distance defining the end point of the valid range in which to draw a 3D Entity

Range is defined as: [TSLRenderingAttributeMinDrawDistance...TSLRenderingAttributeMaxDrawDistance[

If either limit is negative the limit value is ignored.

This is the equivalent of TSLRenderingAttributeMaxDrawDistance.

◆ m_entity3DMinDrawDistance

double TSLRenderingAttributes::m_entity3DMinDrawDistance

The lower bound distance defining the start point of the valid range in which to draw a 3D Entity.

Range is defined as: [TSLRenderingAttributeMinDrawDistance...TSLRenderingAttributeMaxDrawDistance[

If either limit is negative the limit value is ignored.

This is the equivalent of TSLRenderingAttributeMinDrawDistance.

◆ m_exteriorEdgeColour

int TSLRenderingAttributes::m_exteriorEdgeColour

Edge colour for polygons, ellipses etc.

Equivalent of TSLRenderingAttributeExteriorEdgeColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_exteriorEdgeStyle

int TSLRenderingAttributes::m_exteriorEdgeStyle

Edge style for polygons, ellipses etc.

Equivalent of TSLRenderingAttributeExteriorEdgeStyle.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_exteriorEdgeThickness

double TSLRenderingAttributes::m_exteriorEdgeThickness

Edge thickness for polygons, ellipses etc.

Equivalent of TSLRenderingAttributeExteriorEdgeThickness.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_exteriorEdgeThicknessUnits

TSLDimensionUnits TSLRenderingAttributes::m_exteriorEdgeThicknessUnits

Edge thickness units for polygons, ellipses etc.

Equivalent of TSLRenderingAttributeExteriorEdgeThicknessUnits

The undefined value is TSLDimensionUnitsUndefined

The multiple value is TSLDimensionUnitsMultiple

◆ m_fill3DDepthTest

int TSLRenderingAttributes::m_fill3DDepthTest

Equivalent of TSLRenderingAttributeFillDepthTest

The undefined value is TSL3DDepthTest::TSL3DDepthTestUndefined(3)

◆ m_fillColour

int TSLRenderingAttributes::m_fillColour

Fill colour for polygons, ellipses, rectangles etc.

Equivalent of TSLRenderingAttributeFillColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_fillStyle

int TSLRenderingAttributes::m_fillStyle

Fill style for polygons, ellipses, rectangles etc.

Equivalent of TSLRenderingAttributeFillStyle.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_renderLevel

TSLRenderLevel TSLRenderingAttributes::m_renderLevel

The render level for entities.

The undefined value is 'TSLRenderLevelUndefined'

The multiple value is 'TSLRenderLevelMultiple'

◆ m_symbol3DDepthTest

int TSLRenderingAttributes::m_symbol3DDepthTest

Equivalent of TSLRenderingAttributeSymbolDepthTest

The undefined value is TSL3DDepthTest::TSL3DDepthTestUndefined(3)

◆ m_symbolColour

int TSLRenderingAttributes::m_symbolColour

Symbol colour.

Equivalent of TSLRenderingAttributeSymbolColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_symbolFontCharacter

int TSLRenderingAttributes::m_symbolFontCharacter

32bit Unicode code point value if the symbol style is a font symbol.

The Unicode code point is displayed from the font specified via the symbol Style.

The undefined value is TSL_UNDEFINED_FONT_CHARACTER_VALUE

The multiple value is TSL_MULTIPLE_FONT_CHARACTER_VALUE

The value should be considered as an unsigned value.

◆ m_symbolMaxPixelSize

int TSLRenderingAttributes::m_symbolMaxPixelSize

Maximum pixel size for symbols.

Equivalent of TSLRenderingAttributeSymbolMaxPixelSize

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_symbolMinPixelSize

int TSLRenderingAttributes::m_symbolMinPixelSize

Minimum pixel size for symbols.

Equivalent of TSLRenderingAttributeSymbolMinPixelSize

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_symbolRotatable

TSLSymbolRotation TSLRenderingAttributes::m_symbolRotatable

Rotatability for symbol

Equivalent of TSLRenderingAttributeSymbolRotatable

The undefined value is TSLSymbolRotationUndefined

The multiple value is TSLSymbolRotationMultiple

◆ m_symbolScalable

TSLRasterSymbolScalable TSLRenderingAttributes::m_symbolScalable

Scalability for symbol

Equivalent of TSLRenderingAttributeRasterSymbolScalable

The undefined value is TSLRasterSymbolScalableUndefined

The multiple value is TSLRasterSymbolScalableMultiple

◆ m_symbolSizeFactor

double TSLRenderingAttributes::m_symbolSizeFactor

Size factor for symbol.

Equivalent of TSLRenderingAttributeSymbolSizeFactor.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_symbolSizeFactorUnits

TSLDimensionUnits TSLRenderingAttributes::m_symbolSizeFactorUnits

Units for symbol size

Equivalent of TSLRenderingAttributeSymbolSizeFactorUnits

The undefined value is TSLDimensionUnitsUndefined

The multiple value is TSLDimensionUnitsMultiple

◆ m_symbolStyle

int TSLRenderingAttributes::m_symbolStyle

Style for symbols

Equivalent of TSLRenderingAttributeSymbolStyle.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_text3DDepthTest

int TSLRenderingAttributes::m_text3DDepthTest

Equivalent of TSLRenderingAttributeTextDepthTest

The undefined value is TSL3DDepthTest::TSL3DDepthTestUndefined(3)

◆ m_textBackgroundColour

int TSLRenderingAttributes::m_textBackgroundColour

Text background colour.

Equivalent of TSLRenderingAttributeTextBackgroundColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textBackgroundEdgeColour

int TSLRenderingAttributes::m_textBackgroundEdgeColour

Text background edge colour.

Equivalent of TSLRenderingAttributeTextBackgroundEdgeColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textBackgroundMode

TSLTextBackgroundMode TSLRenderingAttributes::m_textBackgroundMode

Mode for any text background.

Equivalent of TSLRenderingAttributeTextBackgroundMode

The undefined value is TSLTextBackgroundModeUndefined

The multiple value is TSLTextBackgroundModeMultiple

◆ m_textBackgroundStyle

int TSLRenderingAttributes::m_textBackgroundStyle

Fill style for text background rectangles

Equivalent of TSLRenderingAttributeTextBackgroundStyle.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textColour

int TSLRenderingAttributes::m_textColour

Text colour.

Equivalent of TSLRenderingAttributeTextColour.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textFont

int TSLRenderingAttributes::m_textFont

Font for text entities.

Equivalent of TSLRenderingAttributeTextFont.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textHorizontalAlignment

TSLHorizontalAlignment TSLRenderingAttributes::m_textHorizontalAlignment

Text horizontal alignment

Equivalent of TSLRenderingAttributeTextHorizontalAlignment

The undefined value is TSLHorizontalAlignmentUndefined

The multiple value is TSLHorizontalAlignmentMultiple

◆ m_textMaxPixelHeight

int TSLRenderingAttributes::m_textMaxPixelHeight

Maximum pixel size for text.

Equivalent of TSLRenderingAttributeTextMaxPixelHeight

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textMinPixelHeight

int TSLRenderingAttributes::m_textMinPixelHeight

Minimum pixel size for text.

Equivalent of TSLRenderingAttributeTextMinPixelHeight

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textOffsetUnits

TSLDimensionUnits TSLRenderingAttributes::m_textOffsetUnits

Units for text offset.

Equivalent of TSLRenderingAttributeTextOffsetUnits

The undefined value is TSLDimensionUnitsUndefined

The multiple value is TSLDimensionUnitsMultiple

◆ m_textOffsetX

double TSLRenderingAttributes::m_textOffsetX

Offset in X dimension for text.

Equivalent of TSLRenderingAttributeTextOffsetX

Since almost any value is valid for this, the 'undefined'/'multiple' behaviour of this field is controlled by the textOffsetUnits attribute.

◆ m_textOffsetY

double TSLRenderingAttributes::m_textOffsetY

Offset in Y dimension for text.

Equivalent of TSLRenderingAttributeTextOffsetY

Since almost any value is valid for this, the 'undefined'/'multiple' behaviour of this field is controlled by the textOffsetUnits attribute.

◆ m_textRotatable

TSLTextRotation TSLRenderingAttributes::m_textRotatable

Rotatability for text

Equivalent of TSLRenderingAttributeTextRotatable

The undefined value is TSLTextRotationUndefined

The multiple value is TSLTextRotationMultiple

◆ m_textSizeFactor

double TSLRenderingAttributes::m_textSizeFactor

Size factor for text.

Equivalent of TSLRenderingAttributeTextSizeFactor.

The undefined value is TSLRenderingAttributes::UNDEFINED_VALUE (-1)

The multiple value is TSLRenderingAttributes::MULTIPLE_VALUE (-2)

◆ m_textSizeFactorUnits

TSLDimensionUnits TSLRenderingAttributes::m_textSizeFactorUnits

Units for text size

Equivalent of TSLRenderingAttributeTextSizeFactorUnits

The undefined value is TSLDimensionUnitsUndefined

The multiple value is TSLDimensionUnitsMultiple

◆ m_textVerticalAlignment

TSLVerticalAlignment TSLRenderingAttributes::m_textVerticalAlignment

Text vertical alignment

Equivalent of TSLRenderingAttributeTextVerticalAlignment

The undefined value is TSLVerticalAlignmentUndefined

The multiple value is TSLVerticalAlignmentMultiple