MapLink Pro 11.1.1.0.
Envitia MapLink Pro: The Ultimate Mapping Application Toolkit
Loading...
Searching...
No Matches
TSLTrackHistorySymbol Class Reference
Inheritance diagram for TSLTrackHistorySymbol:

Detailed Description

A TSLTrackHistorySymbol defines the rendering for history points, if the TSLTrackDisplayManager's history point type has been set to HistoryPointTypeSymbol.

This class is reference counted internally to allow objects to be shared within the track manager SDK

  • Ownership of this object will never be transferred from the application to MapLink
  • The application must call release() in order to relinquish its ownership, even if the object has been passed to another

Public Member Functions

virtual TSLTrackSymbolclone () const
 Create a clone of this symbol.
 
virtual TSLTrackSymbol::Type type () const
 Query the type of this symbol.
 
void colour (const TSLRGBA &rgba)
 
TSLRGBA colour () const
 
void size (double size)
 
double size () const
 
void sizeUnits (TSLDimensionUnits units)
 
TSLDimensionUnits sizeUnits () const
 
void symbolID (int id)
 
int symbolID () const
 
- Public Member Functions inherited from TSLTrackSymbol
void release ()
 
double maximumResolution () const
 
void maximumResolution (double res)
 
void headingIndicatorLength (double length, TSLDimensionUnits unit)
 
void headingIndicatorVisible (bool visibility)
 
double headingIndicatorLength () const
 
TSLDimensionUnits headingIndicatorLengthUnit () const
 
bool headingIndicatorVisible () const
 

Static Public Member Functions

static TSLTrackHistorySymbolcreate ()
 Create a TSLTrackHistorySymbol.
 

Additional Inherited Members

- Public Types inherited from TSLTrackSymbol
enum  HeadingIndicatorStyle { HeadingIndicatorNone , HeadingIndicatorSimple , HeadingIndicatorFilled }
 Specifies the type of heading indicator to display. More...
 
enum  Type { PointSymbol , HistorySymbol }
 Specifies the type of a TSLTrackSymbol. More...
 
enum  SelectionBehaviour { SelectionBehaviourAdditional , SelectionBehaviourReplace }
 
- Protected Member Functions inherited from TSLTrackSymbol
 TSLTrackSymbol ()
 
 TSLTrackSymbol (const TSLTrackSymbol *other)
 
 TSLTrackSymbol (const TSLTrackSymbol &other)
 
TSLTrackSymboloperator= (const TSLTrackSymbol &other)
 
virtual ~TSLTrackSymbol ()
 
void operator delete (void *ptr)
 

Member Function Documentation

◆ clone()

virtual TSLTrackSymbol * TSLTrackHistorySymbol::clone ( ) const
virtual

Create a clone of this symbol.

Implements TSLTrackSymbol.

◆ colour() [1/2]

TSLRGBA TSLTrackHistorySymbol::colour ( ) const

Query the colour of this symbol.

Returns
The colour of this symbol.

◆ colour() [2/2]

void TSLTrackHistorySymbol::colour ( const TSLRGBA & rgba)

Set the colour of this symbol.

Parameters
rgbaThe colour to use.

◆ create()

static TSLTrackHistorySymbol * TSLTrackHistorySymbol::create ( )
static

◆ size() [1/2]

double TSLTrackHistorySymbol::size ( ) const

Query the size of this symbol.

The units are defined by sizeUnits();

Returns
The size of this symbol.

◆ size() [2/2]

void TSLTrackHistorySymbol::size ( double size)

Set the size of this symbol.

The units are defined by sizeUnits();

Parameters
sizeThe size of this symbol.

◆ sizeUnits() [1/2]

TSLDimensionUnits TSLTrackHistorySymbol::sizeUnits ( ) const

Query the size units of this symbol.

The size of the symbol when it is drawn will be based on both the size, and sizeUnits attributes.

Returns
The size units of this symbol.

◆ sizeUnits() [2/2]

void TSLTrackHistorySymbol::sizeUnits ( TSLDimensionUnits units)

Set the size units of this symbol.

The size of the symbol when it is drawn will be based on both the size, and sizeUnits attributes.

Parameters
unitsThe size units for the symbol.

◆ symbolID() [1/2]

int TSLTrackHistorySymbol::symbolID ( ) const

Query the symbol ID.

Returns
The symbol ID of this symbol.

◆ symbolID() [2/2]

void TSLTrackHistorySymbol::symbolID ( int id)

Set the symbol ID.

This is an index from tslsymbols.dat, which specifies the symbol to draw. A value of 0 should be specified to disable drawing of the symbol.

Parameters
idThe symbol ID to use.

◆ type()

virtual TSLTrackSymbol::Type TSLTrackHistorySymbol::type ( ) const
virtual

Query the type of this symbol.

Implements TSLTrackSymbol.