TerrainRouteOperator.OutputSearchBounds Property
Gets or sets a boolean that says whether the rectangular search bounds polygon shall be output.
Syntax
public System.Boolean OutputSearchBounds { get; set; }Property Value
Default: false
Whether the rectangular search bounds polygon shall be output.
Remarks
The search for a route is done within a rectangle that is determined from the SearchMargin and the geometry of the feature from WaypointsInput. When OutputSearchBounds is True, the rectangle will be output as a polygon feature, which will have copies of all attributes from the waypoints feature, and a special attribute:
Attribute name | Type | Description |
|---|---|---|
constraining | Bool | If true, the search reached the edge of the bounds for at least one leg. |
In other words, the constraining attribute will be True if the constrainedBySearchMargin attribute is True for any of the output leg features.
It can be useful to create and display the search bounds polygon, to get visual feedback about the effects of the SearchMargin. You will probably want use a special line visualizer for the polygon boundary, with a condition geoType = #polygon to ensure that it is not applied to the route lines. Similarly, the line visualizers for the route lines may need a condition geoType = #line.
Platforms
Windows, Linux, Android