TSLCustomDataLayerProperties Class Reference

Detailed Description

Specialist class that contains the data layer properties for a TSLDataLayer for use with the TSLCustomDataLayerHandler.

New instances of this class are created via the clone() method.

Public Member Functions
TSLCustomDataLayerProperties *	clone () const
void	destroy ()
int	getProperty (TSLPropertyEnum prop) const
void	setProperty (TSLPropertyEnum prop, int newValue)
void	screenResolution (double &x, double &y) const
void	screenResolution (double resolution)

Member Function Documentation

clone()

TSLCustomDataLayerProperties * TSLCustomDataLayerProperties::clone

(

)

const

Returns a new TSLCustomDataLayerProperties instance that inherits all of the data layer properties of the object it is cloned from.

destroy()

void TSLCustomDataLayerProperties::destroy

(

)

Deletes the object.

getProperty()

int TSLCustomDataLayerProperties::getProperty

(

TSLPropertyEnum

prop

)

const

Retrieves the specified data layer property. This method functions identically to TSLDrawingSurfaceBase::getDataLayerProps().

Parameters

prop	The data layer property to retrieve.

Returns

the value of the requested property.

screenResolution() [1/2]

void TSLCustomDataLayerProperties::screenResolution	(	double &	x,
		double &	y ) const

Returns the TMC per DU mapping at the time the TSLCustomDataLayer is being drawn.

When the custom data layer is in a 2D drawing surface this method will return the same values as TSLRenderingInterface::screenResolution(). When the custom data layer is in a 3D drawing surface it will return a value that more accurately reflects the resolution at which the layer is being drawn.

Parameters

x	Storage for X axis internal TMC units per Device Unit
y	Storage for Y axis internal TMC units per Device Unit

screenResolution() [2/2]

void TSLCustomDataLayerProperties::screenResolution

(

double

resolution

)

Allows the user to override the TMC per DU mapping used when drawing a data layer via the TSLCustomDataLayerHandler. This can be used to force data layers to draw a lower or higher levels of detail than they normally would for the area being drawn.

This value should be left as default in most situations.

Parameters

resolution

The TMC per DU mapping value for the X axis to override the actual value from the drawing surface with.

setProperty()

void TSLCustomDataLayerProperties::setProperty	(	TSLPropertyEnum	prop,
		int	newValue )

Sets the specified data layer property to the given value. This method functions identically to TSLDrawingSurfaceBase::setDataLayerProps().

Parameters

prop	The data layer property to set.
newValue	The value to set the property to.