JSSightAnalysis

API for layer analysis within the map.

Created with the Module.getSightAnalysis API.

var sightAnalysis = Module.getSightAnalysis();

GetObjectPositionsOnPath(coordinates, hbuffer, vbuffer, layer) → JSSightAnalysis.ObjectOnPathResult

Returns the distance and position of objects from a specified path.

Analyzes based on the path's milestone distance for objects within the range, based on the search range along the path.

The hbuffer input value is the horizontal buffer size. The larger the value, the wider the range of objects analyzed horizontally.

The vbuffer input value is the vertical buffer size. The larger the value, the wider the range of objects analyzed vertically.

Information

Name	Type	Description
coordinates	JSVec3Array	(JSVector3D, JSVector3D, ...) Array of paths to analyze.
hbuffer	number	Horizontal buffer size.
vbuffer	number	Vertical buffer size.
layer	JSLayer	The layer to which the objects to be analyzed belong.

• Return

  • Returns the positions of points where the path intersects objects in the vertical direction. (JSSightAnalysis.ObjectOnPathResult)

• Sample

  • Refer to function analysisPositions.

  • Sandbox_Path Analysis

Template

Type Definitions

JSSightAnalysis.ObjectOnPathResult

Format of the analysis result from GetObjectPositionsOnPath

Returns as a string with a JSON structure

Name	Type	Attributes	Default	Description
return	array(JSSightAnalysis.ObjectOnPathResult.Position)			Array of individual analysis results

JSSightAnalysis.ObjectOnPathResult.Position

Unit object information of JSSightAnalysis.ObjectOnPathResult

Name	Type	Attributes	Default	Description
Longitude	number			Longitude of the detected object
Latitude	number			Latitude of the detected object
Altitude	number			Altitude of the detected object
ObjectKey	string			Key value of the detected object
Distance	number			Milestone distance of the detected object on the path
Side	string			Whether the detected object is on the left or right side of the path (Left: "Left", Right: "Right")