Altus Mapping Engine JavaScript API Reference - v2.0.ut.2153.g60764257e - Tuesday May 16, 2022 SDK Documentation | Builds | BA3 Home
AltusUnified::LineSegmentHit Class Reference

Represents a "hit" or "tap" or "click" on a vector line. More...

Inheritance diagram for AltusUnified::LineSegmentHit:
Collaboration diagram for AltusUnified::LineSegmentHit:

Public Member Functions

 LineSegmentHit (string mapName, string shapeId, vec2d geoCoord, int startPointIndex, int endPointIndex)
 Creates an instance of LineSegmentHit. More...
 
 Public Member Functions inherited from AltusUnified::VectorGeometryHit
 VectorGeometryHit (string mapName, string shapeId, vec2d geoCoord, VectorGeometryHitType hitType)
 Creates an instance of VectorGeometryHit. More...
 
vec2d geoCoord ()
 The geographic coordinate of the hit. More...
 
void geoCoord_set (vec2d val)
 

Public Attributes

int startPointIndex
 The index of the point that is the beginning of the segment. More...
 
int endPointIndex
 The index of the point that is the end of the segment. More...
 
 Public Attributes inherited from AltusUnified::VectorGeometryHit
string mapName
 The name of the map layer. More...
 
string shapeId
 The unique ID of the shape that was hit. More...
 
VectorGeometryHitType hitType
 The type of hit: a vertex can be directly hit, or the line segment between vertices. More...
 

Detailed Description

Represents a "hit" or "tap" or "click" on a vector line.

Constructor & Destructor Documentation

AltusUnified::LineSegmentHit::LineSegmentHit ( string  mapName,
string  shapeId,
vec2d  geoCoord,
int  startPointIndex,
int  endPointIndex 
)

Creates an instance of LineSegmentHit.

Parameters
mapNameThe name of the map
shapeIdA unique ID for the line that was hit
geoCoordA coordinate (lon, lat) where the segment was "hit"
startPointIndexThe index of the point that is the beginning of the segment.
endPointIndexThe index of the point that is the end of the segment.

Member Data Documentation

int AltusUnified::LineSegmentHit::endPointIndex

The index of the point that is the end of the segment.

int AltusUnified::LineSegmentHit::startPointIndex

The index of the point that is the beginning of the segment.