TSLTerrainContourVertexList Class Reference

Detailed Description

This class provides a container for holding multiple TSLTerrainContourVertex objects.

Deprecated

Deprecated as of MapLink 11.1.

Public Member Functions
	TSLTerrainContourVertexList ()
bool	addVertex (const TSLTerrainContourVertex &vertex)
bool	addVertex (double x, double y, int numAttributes, const double *attributes)
TSLTerrainContourVertex &	at (int index)
void	clear ()
void	destroy ()
int	numberOfVertices () const
bool	removeVertex (int index)
TSLTerrainContourVertex &	operator[] (int index)
const TSLTerrainContourVertex &	operator[] (int index) const
void *	operator new (size_t size)
void	operator delete (void *mem, size_t s)
void *	operator new (size_t size, char *filename, int line)

Constructor & Destructor Documentation

TSLTerrainContourVertexList()

TSLTerrainContourVertexList::TSLTerrainContourVertexList

(

)

Default constructor.

Member Function Documentation

addVertex() [1/2]

bool TSLTerrainContourVertexList::addVertex

(

const TSLTerrainContourVertex &

vertex

)

Adds a vertex to the end of the list. Note that all vertices in the list must have the same number of attributes. This value will be determined by the first vertex added to an empty list, any further vertices added must have the same number of attributes as the first.

Parameters

vertex

The vertex to add. An internal copy of this vertex is made, the client retains ownership of the original.

Returns

true on success, or false if the provided vertex had a different number of attributes to the others in the list.

addVertex() [2/2]

bool TSLTerrainContourVertexList::addVertex	(	double	x,
		double	y,
		int	numAttributes,
		const double *	attributes )

Add a vertex to the end of the list. Note that all vertices in the list must have the same number of attributes. This value will be determined by the first vertex added to an empty list, any further vertices added must have the same number of attributes as the first.

Parameters

x	The X coordinate of the new vertex
y	The Y coordinate of the new vertex
numAttributes	The number of attributes this vertex has
attributes	Pointer to an array of size numAttributes that contains the attributes for the new vertex.

Returns

true on success, or false if the provided vertex had a different number of attributes to the others in the list.

at()

TSLTerrainContourVertex & TSLTerrainContourVertexList::at

(

int

index

)

Returns the vertex stored at the specified index. If an invalid index is specified then this method will return a reference to a default constructed TSLContourVertex object.

The vertex list retains ownership of the vertex and so it should not be deleted by the user.

Parameters

index

Index of the vertex to return.

clear()

void TSLTerrainContourVertexList::clear

(

)

Deletes all vertices held in the list and resets the list to an empty state.

destroy()

void TSLTerrainContourVertexList::destroy

(

)

Deletes this object. This method should be called instead of deleting the list object.

numberOfVertices()

int TSLTerrainContourVertexList::numberOfVertices

(

)

const

Returns the number of vertices contained in this list.

operator delete()

void TSLTerrainContourVertexList::operator delete	(	void *	mem,
		size_t	s )

operator new() [1/2]

void * TSLTerrainContourVertexList::operator new

(

size_t

size

)

operator new() [2/2]

void * TSLTerrainContourVertexList::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

operator[]() [1/2]

TSLTerrainContourVertex & TSLTerrainContourVertexList::operator[]

(

int

index

)

Index operator.

Parameters

index

The index of the vertex to return.

Returns

the vertex at the specified index. Note that no range checking is performed so care should be taken not to specify an invalid index.

operator[]() [2/2]

const TSLTerrainContourVertex & TSLTerrainContourVertexList::operator[]

(

int

index

)

const

Index operator.

Parameters

index

The index of the vertex to return.

Returns

the vertex at the specified index. Note that no range checking is performed so care should be taken not to specify an invalid index.

removeVertex()

bool TSLTerrainContourVertexList::removeVertex

(

int

index

)

Removes the vertex at the specified index from the list maintained by this list. After the removal of a vertex the index numbering for the contained TSLContourVertex objects may change and so a client should not rely on these numbers remaining the same.

Parameters

index

The index of the vertex to remove.

Returns

true on success, or false if the specified index was invalid.