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

Represents a "hit" or "click" or "tap" on a 2D line or polygon. More...

Inheritance diagram for AltusUnified::VectorGeometryHit:

Public Member Functions

 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

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 "click" or "tap" on a 2D line or polygon.

Constructor & Destructor Documentation

AltusUnified::VectorGeometryHit::VectorGeometryHit ( string  mapName,
string  shapeId,
vec2d  geoCoord,
VectorGeometryHitType  hitType 
)

Creates an instance of VectorGeometryHit.

Parameters
mapNameThe name of the map layer the hit occured on.
shapeIdThe unique ID of the shape that was hit.
geoCoordThe geographic coordinate of the hit.
hitTypeThe type of hit: a vertex can be directly hit, or the line segment between vertices.

Member Function Documentation

vec2d AltusUnified::VectorGeometryHit::geoCoord ( )

The geographic coordinate of the hit.

void AltusUnified::VectorGeometryHit::geoCoord_set ( vec2d  val)

Member Data Documentation

VectorGeometryHitType AltusUnified::VectorGeometryHit::hitType

The type of hit: a vertex can be directly hit, or the line segment between vertices.

string AltusUnified::VectorGeometryHit::mapName

The name of the map layer.

string AltusUnified::VectorGeometryHit::shapeId

The unique ID of the shape that was hit.