TSLTerrainVSHelper Class Reference

Detailed Description

This Helper class provides extra functionality that is useful for View Shed operations

Static Public Member Functions
static bool	routeBreakdownBasic (const TSLCoordSet &inputCoords, const double &pointSpacing, TSLCoordSet &outputCoords)

Member Function Documentation

routeBreakdownBasic()

static bool TSLTerrainVSHelper::routeBreakdownBasic ( const TSLCoordSet & inputCoords, const double & pointSpacing, TSLCoordSet & outputCoords )

static

This will treat the input Coords as a line, generate a list of TSLCoords that travel along the input Line with a TSLCoord every pointSpacing in distance. Note - that this function accepts TSLCoordSets, as a result, all parameters represent TMCs. If the Input Coords represent a coordinates system like BNG, then it can be very easy to pass in a pointSpacing parameter that represents a distance in meters (the developer will have to calculate TMCs per MU). However if the Input Coords represent WGS84 then the pointSpacing will represent degrees (or fractions of degrees) in TMCs.

Parameters

-	inputCoords A line which will be referenced when generating the output Coords parameter.
-	pointSpacing A value that represents how many TMCs should exist between each output Coord
-	outputCoords A TSLCoordSet of generated Coords that travel along the inputCoords line.

Returns

one of the following boolean values:

• true if points were generated along the input Coords line
• false if there were not enough points in the input Coords line to perform the algorithm, if this is the case then all input Coords are transfered to the outputCoords.