TSLPickResultEntity Class Reference

Inheritance diagram for TSLPickResultEntity:

Detailed Description

This class represents a single result from a pick method call on a Drawing Surface.

It may not be created or destroyed by the user.

The results may be invalided by the next draw call to the Drawing Surface.

Public Member Functions
TSLEntity *	getEntity () const
Public Member Functions inherited from TSLPickResult
TSLPickResultEnum	queryType () const
const char *	getDataLayer () const

Static Public Member Functions
static const TSLPickResultEntity *	isType (const TSLPickResult *result)

Member Function Documentation

getEntity()

TSLEntity * TSLPickResultEntity::getEntity

(

)

const

Gets the entity that was picked.

Returns

entity that has been picked.

isType()

static const TSLPickResultEntity * TSLPickResultEntity::isType ( const TSLPickResult * result )

static

Checks to see if the pick result if of this type and if so, returns a pointer to the object of the correct type.

Parameters

result

Result to query type of.

Returns

a pointer to the result of the correct type or NULL if the result is not of this type.