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

Detailed Description

3D quad specific access methods.

A 3D quad is a closed, filled, 4 point feature. It must be non-complex. All points of the 3D quad must lie in a plane.

This class represents the access methods that are specific to a 3D quad. 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

double area () const
 
bool corners (TSL3DCoord *c1, TSL3DCoord *c2, TSL3DCoord *c3, TSL3DCoord *c4) const
 
const TSL3DCoordSetcorners () const
 
bool corners (const TSL3DCoord &c1, const TSL3DCoord &c2, const TSL3DCoord &c3, const TSL3DCoord &c4)
 
bool corners (const TSL3DCoordSet &corners)
 
double perimeter () 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
 
TSL3DEntityclone () 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)
 
TSL3DEntitySetparent ()
 
const TSL3DEntitySetparent () 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 ()
 
TSLDataSetdataSet ()
 
const TSLDataSetdataSet () 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
 
TSL3DEntityis3DEntity ()
 
const TSL3DEntityis3DEntity () const
 
TSLEntityisEntity ()
 
const TSLEntityisEntity () 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 TSL3DQuadcreate (TSLFeatureID featureID, const TSL3DCoord &c1, const TSL3DCoord &c2, const TSL3DCoord &c3, const TSL3DCoord &c4)
 
static TSL3DQuadcreate (TSLFeatureID featureID, const TSL3DCoordSet &coords)
 
static TSL3DQuadcreate (TSLFeatureID featureID, TSL3DCoordSet *coords, bool keepCoordSet=false)
 
static const TSL3DQuadis3DQuad (const TSL3DEntity *entity)
 
static TSL3DQuadis3DQuad (TSL3DEntity *entity)
 

Additional Inherited Members

- Protected Member Functions inherited from TSLEntityBase
 ~TSLEntityBase ()
 

Member Function Documentation

◆ area()

double TSL3DQuad::area ( ) const

Query the area of the 3D quad.

Calculates and returns the area of the 3D quad in TMC units.

Note that this method can only be called on planar quads and that values returned from non planar quads will not be correct.

◆ corners() [1/4]

const TSL3DCoordSet & TSL3DQuad::corners ( ) const

Query method for the corners of the 3D quad.

Returns coordset defining corners of 3D quad

◆ corners() [2/4]

bool TSL3DQuad::corners ( const TSL3DCoord & c1,
const TSL3DCoord & c2,
const TSL3DCoord & c3,
const TSL3DCoord & c4 )

Set method for corners of 3D quad.

A 3D quad is a closed, filled, 4 point feature. It must be non-complex. All points of the 3D quad must lie in a plane.

Parameters
c1,c2,c3,c4New corners of 3D quad
Returns
true if corners replaced successfully, false otherwise

◆ corners() [3/4]

bool TSL3DQuad::corners ( const TSL3DCoordSet & corners)

Set method for corners of 3D quad.

A 3D quad is a closed, filled, 4 point feature. It must be non-complex. All points of the 3D quad must lie in a plane.

Parameters
coordsNew corners of 3D quad
Returns
true if corners replaced successfully, false otherwise

◆ corners() [4/4]

bool TSL3DQuad::corners ( TSL3DCoord * c1,
TSL3DCoord * c2,
TSL3DCoord * c3,
TSL3DCoord * c4 ) const

Query method for the corners of the 3D quad.

Parameters
c1,c2,c3,c4Storage for corners
Returns
true if corners populated successfully, false otherwise

◆ create() [1/3]

static TSL3DQuad * TSL3DQuad::create ( TSLFeatureID featureID,
const TSL3DCoord & c1,
const TSL3DCoord & c2,
const TSL3DCoord & c3,
const TSL3DCoord & c4 )
static

Creates a 3D quad with the specified parameters.

A 3D quad is a closed, filled, 4 point feature. It must be non-complex. All points must lie in a plane.

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
featureIDID 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.
c1,c2,c3,c4Coordinates describing the 3D quad
Returns
NULL on error.

◆ create() [2/3]

static TSL3DQuad * TSL3DQuad::create ( TSLFeatureID featureID,
const TSL3DCoordSet & coords )
static

Creates a 3D quad with the specified parameters.

A 3D quad is a closed, filled, 4 point feature. It must be non-complex. All points must lie in the same plane.

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
featureIDID 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.
coordsCoordinate set describing the 3D quad. This must contain 4 points
Returns
NULL on error.

◆ create() [3/3]

static TSL3DQuad * TSL3DQuad::create ( TSLFeatureID featureID,
TSL3DCoordSet * coords,
bool keepCoordSet = false )
static

Creates a 3D quad 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
featureIDID 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.
coordsCoordinate set describing the 3D quad.
keepCoordSetFlag to indicate whether the 3D quad should keep the specified coordinate set, or clone it. Note that if this flag is set, the 3D quad assumes control of the coordinate set and invalidates it. The user should not attempt to make further use of the coordinate set.
Returns
NULL on error.

◆ is3DQuad() [1/2]

static const TSL3DQuad * TSL3DQuad::is3DQuad ( const TSL3DEntity * entity)
static

Query whether the entity is a 3d quad.

If this entity is a 3D quad, returns an accessor, otherwise returns NULL.

Parameters
entitythe entity to query.

◆ is3DQuad() [2/2]

static TSL3DQuad * TSL3DQuad::is3DQuad ( TSL3DEntity * entity)
static

Query whether the entity is a 3d quad.

If this entity is a 3D quad, returns an accessor, otherwise returns NULL.

Parameters
entitythe entity to query.

◆ perimeter()

double TSL3DQuad::perimeter ( ) const

Query the perimeter of the 3D quad

Calculates and returns the perimeter of the 3D quad in TMC units.

Returns perimeter of the 3D quad.