Inheritance diagram for TSLGeodeticEllipse:

[legend]

Detailed Description

This class provides geodetic ellipse specific access methods.

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 TSLGeodeticEllipse:

TSLRenderingAttributeExteriorEdgeColour
TSLRenderingAttributeExteriorEdgeStyle
TSLRenderingAttributeExteriorEdgeThickness
TSLRenderingAttributeExteriorEdgeThicknessUnits
TSLRenderingAttributeFillColour
TSLRenderingAttributeFillStyle

The above is not a complete list, see TSLRenderingAttributeInt, TSLRenderingAttributeDouble and TSLRenderingAttributeBool for more details.

Known Limitations:

If a map has curved edges (e.g. it uses the Eckert IV projection), interpolated entities split over the edges may not draw correctly.
We have only tested geodetic arcs and ellipses with lengths of less than 60 degrees. If an entity is longer than 180 degrees it may be drawn incorrectly or even disappear.
If the coordinate system changes (e.g. a new map is loaded), geodetic entities will move themselves on the next draw to preserve lat/lon positions. However, if any TMC data of a geodetic entity are altered before a redraw but after a coord system change, the lat/lon data will be lost. The TMC data can be altered by move(), scale(), rotate() and translate(), and by any control point manipulation or insertion/removal of inners.
Several parts of the system will treat interpolated entities as though they were not interpolated (e.g. checking whether a point is inside the entity or not).
Interpolated entities do not fully "exist" until they are drawn, which means that their extents are not known until they are drawn. This can cause issues e.g. if a drawing surface has an undrawn geodetic entity, then its reset() method will zoom out a long way. This can also cause visual artefacts when manipulating interpolated entities; the entire drawing surface should always be redrawn when using them.
Geodetic entities can modify themselves when they are drawn (e.g. moving themselves, updating their envelopes, etc).
Layers containing Geodetic entities should not be shared between Drawing Surfaces.
The default step angle for interpolation is pi/40 radians (4.5 degrees), but this can be changed with interpolationAngleDelta().

Public Member Functions
const TSLCoord &	centre () const

void	centre (const TSLCoord &newPosition)

double	interpolationAngleDelta () const

void	interpolationAngleDelta (double newValue)

TSLGeodeticInterpolationOptionsEnum	interpolationOptions () const

void	interpolationOptions (TSLGeodeticInterpolationOptionsEnum newValue)

double	xRadius () const

void	xRadius (double newValue)

double	yRadius () const

void	yRadius (double newValue)

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 TSLGeodeticEllipse *	create (TSLFeatureID featureID, TSLTMC cx, TSLTMC cy, double radx, double rady=0.0, double rotation=0.0)

static const TSLGeodeticEllipse *	isGeodeticEllipse (const TSLEntity *entity)

static TSLGeodeticEllipse *	isGeodeticEllipse (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)

Additional Inherited Members
Protected Member Functions inherited from TSLEntity
	~TSLEntity ()

Protected Member Functions inherited from TSLEntityBase
	~TSLEntityBase ()

Member Function Documentation

◆ centre() [1/2]

const TSLCoord & TSLGeodeticEllipse::centre ( ) const

Query the centre of the ellipse.

Returns the coordinate of the centre of the ellipse.

◆ centre() [2/2]

void TSLGeodeticEllipse::centre ( const TSLCoord & newPosition )

Sets the centre of the ellipse.

Parameters

newPosition New centre of the ellipse.

◆ create()

static TSLGeodeticEllipse * TSLGeodeticEllipse::create	(	TSLFeatureID	featureID,
		TSLTMC	cx,
		TSLTMC	cy,
		double	radx,
		double	rady = 0.0,
		double	rotation = 0.0 )

static

Static method for the creation of new geodetic ellipse objects 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.

All angles are in radians, +ve anti-clockwise from the +ve X axis.

Parameters

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.
cx	X coordinate of centre of ellipse.
cy	Y coordinate of centre of ellipse.
radx	Radius of ellipse along X axis, before rotation. In metres.
rady	Radius of ellipse along Y axis, before rotation. In metres. If 0, rady is assumed to be the same as radx.
rotation	Angle of rotation of ellipse, about centre.

Returns: NULL on error.

◆ interpolationAngleDelta() [1/2]

double TSLGeodeticEllipse::interpolationAngleDelta ( ) const

Returns the step angle used for interpolation, in radians.

◆ interpolationAngleDelta() [2/2]

void TSLGeodeticEllipse::interpolationAngleDelta ( double newValue )

Sets the step angle for interpolation, in radians. Will be used only if interpolation is on.

Parameters

newValue New value for the step angle, in radians.

◆ interpolationOptions() [1/2]

TSLGeodeticInterpolationOptionsEnum TSLGeodeticEllipse::interpolationOptions ( ) const

Returns the flags which control interpolation between control points of this geodetic entity.

◆ interpolationOptions() [2/2]

void TSLGeodeticEllipse::interpolationOptions ( TSLGeodeticInterpolationOptionsEnum newValue )

Sets the flags which control interpolation between control points of this geodetic entity. At this time, only the TSLGeodeticInterpolationOptionsGreatCircle flag is supported.

Parameters

newValue New value for the flags.

◆ isGeodeticEllipse() [1/2]

static const TSLGeodeticEllipse * TSLGeodeticEllipse::isGeodeticEllipse ( const TSLEntity * entity )

static

Query whether the entity is a geodetic ellipse.

If this entity is a geodetic ellipse, returns an accessor, otherwise returns NULL.

When querying Optimised maps this query may return NULL.

Parameters

entity the entity to query

◆ isGeodeticEllipse() [2/2]

static TSLGeodeticEllipse * TSLGeodeticEllipse::isGeodeticEllipse ( TSLEntity * entity )

static

Query whether the entity is a geodetic ellipse.

If this entity is a geodetic ellipse, returns an accessor, otherwise returns NULL.

When querying Optimised maps this query may return NULL.

Parameters

entity the entity to query

◆ xRadius() [1/2]

double TSLGeodeticEllipse::xRadius ( ) const

Query the X radius of the ellipse, in metres.

This is the radius along the X axis, before rotation.

◆ xRadius() [2/2]

void TSLGeodeticEllipse::xRadius ( double newValue )

Set the X radius of the ellipse, in metres.

Parameters

newValue New value of the radius along the X axis, before rotation.

◆ yRadius() [1/2]

double TSLGeodeticEllipse::yRadius ( ) const

Query the Y radius of the ellipse, in metres.

This is the radius along the Y axis, before rotation.

◆ yRadius() [2/2]

void TSLGeodeticEllipse::yRadius ( double newValue )

Set the Y radius of the ellipse, in metres.

Parameters

newValue New value of the radius along the Y axis, before rotation.

Detailed Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ centre() [1/2]

◆ centre() [2/2]

◆ create()

◆ interpolationAngleDelta() [1/2]

◆ interpolationAngleDelta() [2/2]

◆ interpolationOptions() [1/2]

◆ interpolationOptions() [2/2]

◆ isGeodeticEllipse() [1/2]

◆ isGeodeticEllipse() [2/2]

◆ xRadius() [1/2]

◆ xRadius() [2/2]

◆ yRadius() [1/2]

◆ yRadius() [2/2]