Inheritance diagram for TSLExtruded2DRectangle:

[legend]

Detailed Description

Extruded 2D rectangle specific access methods.

An extruded 2D rectangle is a 2D rectangle placed at a specified altitude and extruded by a specified distance vertically. The altitude may be absolute or relative. The resultant visualisation is a 3D solid.

This class represents the access methods that are specific to an extruded 2D rectangle. They also allow setting of the various attributes.

Deprecated: Deprecated as of MapLink 11.1. Advised to use MapLink Earth SDK instead.

Public Member Functions
void	altitude (double altitude, TSL3DAltitudeType type=TSL3DAltitudeTypeMeanSeaLevel)

double	altitude (TSL3DAltitudeType *alt=NULL) const

double	extrudedHeight () const

void	extrudedHeight (double newHeight)

TSLRectangle *	rectangle ()

const TSLRectangle *	rectangle () const

bool	rectangle (TSLRectangle *newRectangle, bool assumeOwnership=true)

void	showBottom (bool show)

bool	showBottom () const

void	showSides (bool show)

bool	showSides () const

void	showTop (bool show)

bool	showTop () const

Public Member Functions inherited from TSL3DEntity
TSL3DBoundingBox	boundingBox (int surfaceID=-1) const

void	boundingBox (TSL3DCoord &bottomLeft, TSL3DCoord &topRight, int surfaceID=-1) const

TSL3DCoord	centroid () const

TSL3DEntity *	clone () const

double	distance (const TSL3DCoord &point, bool useRenderedExtent=true, int drawingSurfaceID=-1) const

bool	equals (const TSL3DEntity *other) const

void	move (const TSL3DCoord &location, const TSL3DCoord &reference)

TSL3DEntitySet *	parent ()

const TSL3DEntitySet *	parent () const

void	scale (double scaleParam, const TSL3DCoord *origin=0)

void	scale (double scaleX, double scaleY, double scaleZ, const TSL3DCoord *origin=0)

double	squareDistance (const TSL3DCoord &point, bool useRenderedExtent=true, int drawingSurfaceID=-1) const

void	translate (double latitudeOffset, double longitudeOffset, double altitudeOffset)

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 TSLExtruded2DRectangle *	create (TSLFeatureID featureID, TSLRectangle *rectangle, bool ownsRectangle=true)

static const TSLExtruded2DRectangle *	isExtruded2DRectangle (const TSL3DEntity *entity)

static TSLExtruded2DRectangle *	isExtruded2DRectangle (TSL3DEntity *entity)

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

Member Function Documentation

◆ altitude() [1/2]

void TSLExtruded2DRectangle::altitude	(	double	altitude,
		TSL3DAltitudeType	type = TSL3DAltitudeTypeMeanSeaLevel )

Set the altitude of the extruded entity in metres.

Argument description list:

Parameters

altitude	The altitude at which the vertices of the entity should be set.
type	The type of altitude - defaults to TSL3DAltitudeTypeMeanSeaLevel

◆ altitude() [2/2]

double TSLExtruded2DRectangle::altitude ( TSL3DAltitudeType * alt = NULL ) const

Return the altitude of the entity.

Parameters

type	the returned altitude type value

◆ create()

static TSLExtruded2DRectangle * TSLExtruded2DRectangle::create	(	TSLFeatureID	featureID,
		TSLRectangle *	rectangle,
		bool	ownsRectangle = true )

static

Creates an extruded 2D rectangle 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.

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.
rectangle	Base 2D rectangle to use.
ownsRectangle	If true, the extruded 2D rectangle will assume ownership of the base 2D rectangle. Otherwise a copy of the rectangle is made. The default is true.

Returns: NULL on error.

◆ extrudedHeight() [1/2]

double TSLExtruded2DRectangle::extrudedHeight ( ) const

Returns the extruded height of the entity.

◆ extrudedHeight() [2/2]

void TSLExtruded2DRectangle::extrudedHeight ( double newHeight )

Set the extruded height of the base 2D polyline.

Parameters

newHeight the new extruded height in metres

◆ isExtruded2DRectangle() [1/2]

static const TSLExtruded2DRectangle * TSLExtruded2DRectangle::isExtruded2DRectangle ( const TSL3DEntity * entity )

static

Query whether the entity is an extruded 2d rectangle.

If this entity is an extruded 2d rectangle, returns an accessor, otherwise returns NULL.

Parameters

entity the entity to query.

◆ isExtruded2DRectangle() [2/2]

static TSLExtruded2DRectangle * TSLExtruded2DRectangle::isExtruded2DRectangle ( TSL3DEntity * entity )

static

Query whether the entity is an extruded 2d rectangle.

If this entity is an extruded 2d rectangle, returns an accessor, otherwise returns NULL.

Parameters

entity the entity to query.

◆ rectangle() [1/3]

TSLRectangle * TSLExtruded2DRectangle::rectangle ( )

Query method for the base 2D rectangle being extruded

The returned rectangle geometry may be modified. If so, then the 'update' method should be called so that the extruded 2D rectangle can update its internal information.

Returns pointer to base 2D rectangle

◆ rectangle() [2/3]

const TSLRectangle * TSLExtruded2DRectangle::rectangle ( ) const

Query method for read-only access to the base 2D rectangle being extruded

Returns read-only pointer to base 2D rectangle

◆ rectangle() [3/3]

bool TSLExtruded2DRectangle::rectangle	(	TSLRectangle *	newRectangle,
		bool	assumeOwnership = true )

Sets rectangle to be extruded.

Parameters

newRectangle	rectangle to be used.
assumeOwnership	If true, the extruded 2D rectangle will assume ownership of the 2D rectangle. The default is true.

Returns: true on success, false otherwise.

◆ showBottom() [1/2]

bool TSLExtruded2DRectangle::showBottom ( ) const

Returns whether the bottom of the extruded rectangle will be drawn. By default the bottom is drawn.

◆ showBottom() [2/2]

void TSLExtruded2DRectangle::showBottom ( bool show )

Sets whether the bottom of the extruded rectangle will be drawn. By default the bottom is drawn.

Parameters

show	Whether to show the bottom of the extruded rectangle.

◆ showSides() [1/2]

bool TSLExtruded2DRectangle::showSides ( ) const

Returns whether the sides of the extruded rectangle will be drawn. By default the sides are drawn.

◆ showSides() [2/2]

void TSLExtruded2DRectangle::showSides ( bool show )

Sets whether the sides of the extruded rectangle will be drawn. By default the sides are drawn.

Parameters

show	Whether to show the sides of the extruded rectangle.

◆ showTop() [1/2]

bool TSLExtruded2DRectangle::showTop ( ) const

Returns whether the top of the extruded rectangle will be drawn. By default the top is drawn.

◆ showTop() [2/2]

void TSLExtruded2DRectangle::showTop ( bool show )

Sets whether the top of the extruded rectangle will be drawn. By default the top is drawn.

Parameters

show	Whether to show the top of the extruded rectangle.

Detailed Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ altitude() [1/2]

◆ altitude() [2/2]

◆ create()

◆ extrudedHeight() [1/2]

◆ extrudedHeight() [2/2]

◆ isExtruded2DRectangle() [1/2]

◆ isExtruded2DRectangle() [2/2]

◆ rectangle() [1/3]

◆ rectangle() [2/3]

◆ rectangle() [3/3]

◆ showBottom() [1/2]

◆ showBottom() [2/2]

◆ showSides() [1/2]

◆ showSides() [2/2]

◆ showTop() [1/2]

◆ showTop() [2/2]