Symbol specific access methods.
This class represents the access methods that are specific to a symbol. They also allow setting of rendering attributes.
Rendering attributes can be set directly to this geometry using the inherited TSLEntityBase::setRendering method. This is called 'Entity Rendering'.
Rendering can be applied to a large range of geometry using 'Feature Rendering' which is set by the datalayer using TSLDataLayer::addFeatureRendering which creates a featureID. The featureID can then have attributes applied to it using TSLDataLayer::setFeatureRendering.
A featureID can be applied to geometry on creation, or it can be added later using TSLEntityBase::featureID.
Valid Rendering Attributes for TSLSymbol:
The above is not a complete list, see TSLRenderingAttributeInt, TSLRenderingAttributeDouble and TSLRenderingAttributeBool for more details.
Public Member Functions | |
| TSLTMC | height () const |
| void | height (TSLTMC newValue) |
| const TSLCoord & | position () const |
| void | position (const TSLCoord &newPosition) |
| Public Member Functions inherited from TSLEntity | |
| TSLCoord | centroid () const |
| TSLEntity * | clone () const |
| bool | contains (const TSLEntity *other) const |
| bool | crosses (const TSLEntity *other) const |
| void | alwaysMergeDifferences (bool _alwaysMergeDifferences) |
| TSLEntity * | difference (const TSLEntity *other) const |
| double | distance (const TSLCoord &point, bool useRenderedExtent=true, int drawingSurfaceID=-1) const |
| TSLEnvelope | envelope (int surfaceID=-1) const |
| bool | equals (const TSLEntity *other) const |
| TSLEntity * | intersection (const TSLEntity *other) const |
| bool | intersects (const TSLEntity *other) const |
| bool | intersects (const TSLEnvelope *envelope) const |
| bool | move (const TSLCoord &location, const TSLCoord &reference) |
| bool | overlaps (const TSLEntity *other) const |
| TSLEntitySet * | parent () |
| const TSLEntitySet * | parent () const |
| void | renderLevel (int level) |
| int | renderLevel () const |
| bool | rotate (double angle, const TSLCoord *origin=NULL) |
| double | rotation () const |
| bool | rotation (double newValue) |
| bool | scale (double scaleParam, TSLCoord *origin=0) |
| bool | scaleXY (double scaleX, double scaleY, TSLCoord *origin=0) |
| double | squareDistance (const TSLCoord &point, bool useRenderedExtent=true, int drawingSurfaceID=-1) const |
| double | squareDistance (const TSLEntity *otherEntity) const |
| bool | touches (const TSLEntity *other) const |
| bool | translate (TSLTMC xoffset, TSLTMC yoffset) |
| TSLEntity * | unionWith (const TSLEntity *other) const |
| bool | within (const TSLEntity *other) const |
| TSLCoord | adjustedWeightedCentroid () |
| reserved for future use | |
| TSLCoord | centreOfGravity () |
| reserved for future use | |
| Public Member Functions inherited from TSLEntityBase | |
| bool | addDataSet () |
| bool | addDataSet (TSLDataHandler *toUseDataHandler) |
| bool | clearRenderingAttributes () |
| TSLDataSet * | dataSet () |
| const TSLDataSet * | dataSet () const |
| short | dataSourceID () const |
| void | dataSourceID (short dataSourceID) |
| bool | deleteDataSet () |
| void | destroy () |
| TSLEntityID | entityID () const |
| void | entityID (TSLEntityID value) |
| TSLFeatureID | featureID () const |
| void | featureID (TSLFeatureID newValue) |
| bool | getRendering (TSLRenderingAttributeInt attribute, int *result) const |
| bool | getRendering (TSLRenderingAttributeDouble attribute, double *result) const |
| bool | getRendering (TSLRenderingAttributeBool attribute, bool *result) const |
| bool | getRendering (TSLRenderingAttributes &result) const |
| TSL3DEntity * | is3DEntity () |
| const TSL3DEntity * | is3DEntity () const |
| TSLEntity * | isEntity () |
| const TSLEntity * | isEntity () const |
| bool | isOptimisedEntity () const |
| void | name (const char *newValue) |
| const char * | name () const |
| void | releaseResources (int surfaceID) |
| bool | setRendering (TSLRenderingAttributeInt attribute, int value) |
| bool | setRendering (TSLRenderingAttributeDouble attribute, double value) |
| bool | setRendering (TSLRenderingAttributeBool attribute, bool value) |
| bool | setRendering (const TSLRenderingAttributes &attributes) |
| void | sourceID (int value) |
| int | sourceID () const |
| TSLGeometryType | type () const |
| void | version (TSLVersion value) |
| TSLVersion | version () const |
Static Public Member Functions | |
| static TSLSymbol * | create (TSLFeatureID featureID, TSLTMC x, TSLTMC y, TSLTMC height=100, double rotation=0) |
| static const TSLSymbol * | isSymbol (const TSLEntity *entity) |
| static TSLSymbol * | isSymbol (TSLEntity *entity) |
| Static Public Member Functions inherited from TSLEntity | |
| static TSLEntity * | createFromWKB (const unsigned char *wkb, unsigned int wkbLength, double TMCPerMU, double mapOffsetX=0.0, double mapOffsetY=0.0, bool multiAsEntitySet=false, double maxCurveAngle=0.0) |
| static TSLEntity * | createFromWKT (const char *wkt, double TMCPerMU, double mapOffsetX=0.0, double mapOffsetY=0.0, bool multiAsEntitySet=false, double maxCurveAngle=0.0) |
Protected Member Functions | |
| TSLSymbol () | |
| ~TSLSymbol () | |
| TSLSymbol (const TSLSymbol &) | |
| TSLSymbol & | operator= (const TSLSymbol &) |
| Protected Member Functions inherited from TSLEntity | |
| ~TSLEntity () | |
| Protected Member Functions inherited from TSLEntityBase | |
| ~TSLEntityBase () | |
|
protected |
Private constructor to prevent user creation.
|
protected |
|
protected |
|
static |
Creates a symbol with the specified parameters.
This call should only be used for temporary entities. For example, this call may be used to create entities that are used in the spatial tests.
| featureID | ID of the feature code to assign to the entity. This is used when rendering map features if no specific attribute set has been created for the entity. |
| x | X coordinate of symbol position. |
| y | Y coordinate of symbol position. |
| height | Size of symbol in TMC units. |
| rotation | Angle of rotation of symbol. Expressed in radians, +ve anti-clockwise from the +ve X axis. |
| TSLTMC TSLSymbol::height | ( | ) | const |
Query the size of the symbol.
| void TSLSymbol::height | ( | TSLTMC | newValue | ) |
Set the size of the symbol.
| newValue | New size of the symbol. If the symbol is a scalable symbol, this height should be in TMC units. If the symbol is a non-scalable symbol, this height should be in pixels. |
Query whether the entity is a symbol.
If this entity is a symbol, returns an accessor, otherwise returns NULL.
When querying Optimised maps this query may return NULL.
| entity | the entity to query |
Query whether the entity is a symbol.
If this entity is a symbol, returns an accessor, otherwise returns NULL.
When querying Optimised maps this query may return NULL.
| entity | the entity to query |
| const TSLCoord & TSLSymbol::position | ( | ) | const |
Query the position of the symbol.
| void TSLSymbol::position | ( | const TSLCoord & | newPosition | ) |
Set the position of the symbol.
| newPosition | New position for the symbol. |
