TSLRectangle Class Reference

Inheritance diagram for TSLRectangle:

Detailed Description

Rectangle specific access methods.

This class represents the access methods that are specific to a rectangle. 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 TSLRectangle:

• TSLRenderingAttributeExteriorEdgeColour
• TSLRenderingAttributeExteriorEdgeStyle
• TSLRenderingAttributeExteriorEdgeThickness
• TSLRenderingAttributeExteriorEdgeThicknessUnits
• TSLRenderingAttributeFillColour
• TSLRenderingAttributeFillStyle

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

Public Member Functions
const TSLCoordSet &	corners () const
void	corners (const TSLCoord &bottomLeft, const TSLCoord &topRight) const
void	unrotatedCorners (TSLCoord &bottomLeft, TSLCoord &topRight) const
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 TSLRectangle *	create (TSLFeatureID featureID, const TSLCoord &bottomLeft, const TSLCoord &topRight, double rotation=0)
static const TSLRectangle *	isRectangle (const TSLEntity *entity)
static TSLRectangle *	isRectangle (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
	TSLRectangle ()
	~TSLRectangle ()
	TSLRectangle (const TSLRectangle &)
TSLRectangle &	operator= (const TSLRectangle &rectangle)
Protected Member Functions inherited from TSLEntity
	~TSLEntity ()
Protected Member Functions inherited from TSLEntityBase
	~TSLEntityBase ()

Constructor & Destructor Documentation

TSLRectangle() [1/2]

TSLRectangle::TSLRectangle ( )

protected

Private constructor to prevent user creation.

~TSLRectangle()

TSLRectangle::~TSLRectangle ( )

protected

TSLRectangle() [2/2]

TSLRectangle::TSLRectangle ( const TSLRectangle & )

protected

Member Function Documentation

corners() [1/2]

const TSLCoordSet & TSLRectangle::corners

(

)

const

Query the corners of the rectangle.

This will be the rotated coordinate set in anti-clockwise direction, starting from the bottom left.

corners() [2/2]

void TSLRectangle::corners	(	const TSLCoord &	bottomLeft,
		const TSLCoord &	topRight ) const

Sets the corners of the rectangle.

Parameters

bottomLeft	New coordinate of the bottom left corner of rectangle, before rotation.
topRight	New coordinate of the top right corner of rectangle, before rotation.

create()

TSLRectangle * TSLRectangle::create ( TSLFeatureID featureID, const TSLCoord & bottomLeft, const TSLCoord & topRight, double rotation = 0 )

static

Creates a rectangle with the specified parameters. Rectangles are two-dimensional filled entities.

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.

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.
bottomLeft	Bottom left coordinate of rectangle, before rotation.
topRight	Top right coordinate of rectangle, before rotation.
rotation	Angle of rotation of rectangle. Expressed in radians, +ve anti-clockwise from the +ve X axis.

Returns

NULL on error.

isRectangle() [1/2]

const TSLRectangle * TSLRectangle::isRectangle ( const TSLEntity * entity )

static

Query whether the entity is a rectangle.

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

When querying Optimised maps this query may return NULL.

Parameters

entity

the entity to query

isRectangle() [2/2]

TSLRectangle * TSLRectangle::isRectangle ( TSLEntity * entity )

static

Query whether the entity is a rectangle.

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

When querying Optimised maps this query may return NULL.

Parameters

entity

the entity to query

operator=()

TSLRectangle & TSLRectangle::operator= ( const TSLRectangle & rectangle )

protected

Assignment operator.

Sets the rectangle to be equal to that specified.

Parameters

rectangle

Source for new rectangle.

Returns

reference to updated value.

unrotatedCorners()

void TSLRectangle::unrotatedCorners	(	TSLCoord &	bottomLeft,
		TSLCoord &	topRight ) const

Queries the corners of the rectangle in its unrotated state.

For an unrotated rectangle, these corners will be the actual corners. For a rotated rectangle, these corners will be the corner points with the inverse rotation applied.

Parameters

bottomLeft	the coordinate of the bottom left corner of rectangle, without rotation applied.
topRight	the coordinate of the top right corner of rectangle, without rotation applied.