TSL3DText Class Reference

Inheritance diagram for TSL3DText:

Detailed Description

3D Text specific access methods.

This class represents the access methods that are specific to a 3D Text. They also allow setting of the various attributes. A 3D text is similar to a 2D text, but exists in 3D space. It is one of the types which is billboarding, meaning it is always orientated towards the camera.

Notes:

1. Depth Testing defaults to TSL3DDepthTestDelayed.

   Deprecated

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

Public Member Functions
const TSL3DCoord &	centre () const
void	centre (const TSL3DCoord &coord)
int	height () const
void	height (int newValue)
TSLHorizontalAlignment	horizontalAlignment () const
void	horizontalAlignment (TSLHorizontalAlignment align)
double	rotation () const
void	rotation (double newValue)
const char *	value () const
void	value (const char *newValue)
TSLVerticalAlignment	verticalAlignment () const
void	verticalAlignment (TSLVerticalAlignment align)
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 TSL3DText *	create (TSLFeatureID featureID, const TSL3DCoord &coord, const char *value, double height, TSLHorizontalAlignment hAlignment=TSLHorizontalAlignmentUndefined, TSLVerticalAlignment vAlignment=TSLVerticalAlignmentUndefined, double rotation=0.0)
static TSL3DText *	is3DText (TSL3DEntity *entity)
static const TSL3DText *	is3DText (const TSL3DEntity *entity)

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

Member Function Documentation

centre() [1/2]

const TSL3DCoord & TSL3DText::centre

(

)

const

Returns the 3D text's coord.

centre() [2/2]

void TSL3DText::centre

(

const TSL3DCoord &

coord

)

Sets the 3D text's coord.

The text will be drawn with its reference point at the specified position.

Parameters

coord

coord value to set

create()

static TSL3DText * TSL3DText::create ( TSLFeatureID featureID, const TSL3DCoord & coord, const char * value, double height, TSLHorizontalAlignment hAlignment = TSLHorizontalAlignmentUndefined, TSLVerticalAlignment vAlignment = TSLVerticalAlignmentUndefined, double rotation = 0.0 )

static

Creates an instance of a 3D text 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.
coord	Coordinate at which to place the 3d text
value	The character string to be displayed by this text object
height	Size of text in metres (currently ignored)
hAlignment	Horizontal alignment of text.
vAlignment	Vertical alignment of text.
rotation	As a text will always face the camera, the angle of rotation is about the axis made between the symbol and the camera. It should be specified in radians, +ve anti-clockwise.

Returns

NULL on error.

height() [1/2]

int TSL3DText::height

(

)

const

Query the size of the text.

height() [2/2]

void TSL3DText::height

(

int

newValue

)

Set the size of the text.

Parameters

newValue

New size of text, in metres.

Note

The height is currently ignored as TSLDimensionUnitsScaleFactor is not supported.

horizontalAlignment() [1/2]

TSLHorizontalAlignment TSL3DText::horizontalAlignment

(

)

const

Query the horizontal alignment of the text.

horizontalAlignment() [2/2]

void TSL3DText::horizontalAlignment

(

TSLHorizontalAlignment

align

)

Set the horizontal alignment of the text.

Parameters

align

New alignment for the text.

is3DText() [1/2]

static const TSL3DText * TSL3DText::is3DText ( const TSL3DEntity * entity )

static

Query whether the entity is a 3d text.

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

Parameters

entity

the entity to query.

is3DText() [2/2]

static TSL3DText * TSL3DText::is3DText ( TSL3DEntity * entity )

static

Query whether the entity is a 3d text.

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

Parameters

entity

the entity to query.

rotation() [1/2]

double TSL3DText::rotation

(

)

const

Returns the 3D text's rotation.

As text will always face the camera, the angle of rotation is about the axis made between the text and the camera, in radians with the anti-clockwise being +ve.

rotation() [2/2]

void TSL3DText::rotation

(

double

newValue

)

Set the rotation angle of the text. As text will always face the camera, the angle of rotation is about the axis made between the text and the camera.

Parameters

newValue

New angle of rotation of the text, in radians, +ve anti-clockwise.

value() [1/2]

const char * TSL3DText::value

(

)

const

Query the text string displayed by this text object.

The text string is assumed to be values in the range [32..127], values outside these ranges is currently converted to a space. UTF8 encoded string is not currently accepted (please contact support if you are interested in support for UTF8 in the 3D SDK).

value() [2/2]

void TSL3DText::value

(

const char *

newValue

)

Set the value of the text string.

The text string is assumed to be values in the range [32..127], values outside these ranges is currently converted to a space. UTF8 encoded string is not currently accepted (please contact support if you are interested in support for UTF8 in the 3D SDK).

Parameters

newvalue

New string to be displayed.

verticalAlignment() [1/2]

TSLVerticalAlignment TSL3DText::verticalAlignment

(

)

const

Query the vertical alignment of the text.

verticalAlignment() [2/2]

void TSL3DText::verticalAlignment

(

TSLVerticalAlignment

align

)

Set the vertical alignment of the text.

Parameters

align

New alignment for the text.