TSLPickResultSet Class Reference

Detailed Description

This class represents the results from a pick method call on a Drawing Surface.

It may not be created by the user, and should be destroyed using the 'destroy()' method.

The results contained within this set may be invalided by the next draw call to the Drawing Surface

Public Member Functions
void	destroy () const
int	numResults () const
const TSLPickResult *	getResult (int index) const
const TSLPickResult *	operator[] (int index) const
bool	addResult (TSLClientCustomPickResult *result)

Member Function Documentation

addResult()

bool TSLPickResultSet::addResult

(

TSLClientCustomPickResult *

result

)

Adds a new custom result to the result set.

The results should be added in the order they were picked. i.e, the on-top result should be added first.

The PickResult class takes ownership of the result point.

Parameters

result

Result to add.

Returns

True if the picking should continue. False if the caller should stop picking.

destroy()

void TSLPickResultSet::destroy

(

)

const

Destroys the result set.

getResult()

const TSLPickResult * TSLPickResultSet::getResult

(

int

index

)

const

Returns a result with the requested index.

The results are stored and returned in the order they should be processed, i.e. index 0 is the closest to the picked area/is on top.

Parameters

index

Index of result to get.

Returns

Pointer to result or NULL if out of range.

numResults()

int TSLPickResultSet::numResults

(

)

const

Gets the number of results in the result set.

Returns

Number of results.

operator[]()

const TSLPickResult * TSLPickResultSet::operator[]

(

int

index

)

const

Returns a result with the requested index.

The results are stored and returned in the order they should be processed, i.e. index 0 is the closest to the picked area/is on top.

Parameters

index

Index of result to get.

Returns

Pointer to result or NULL if out of range.