Altus Mapping Engine JavaScript API Reference - v2.0.ut.2153.g60764257e - Tuesday May 16, 2022 | SDK Documentation | Builds | BA3 Home |
Classes | |
class | AnimatedCircle |
A movable, pulsing circle. More... | |
class | AnimationManager |
Manages animations. More... | |
class | Atmospherics |
Controls the atmospheric and lighting systems More... | |
class | BinaryBlob |
Represents binary data of some given size. More... | |
class | BoundingBox |
class | BoundingRange |
class | Camera |
A virtual camera that controls how the map is viewed. More... | |
class | ClassicCameraModifier |
Modifies camera behavior so it behaves like the original Altus 1.0 iOS camera. More... | |
class | ClassicGestureReceiver |
An extendible class that allows a developer to handle Altus gestures (such as panning and zooming) in a unique way. There is also an existing sub-class, ClassicGestureReceiver, that handles gestures in the classic Altus 2.0 way. Gesture events are generated by Altus from the raw stream of finger/pointer events. If you would like access to the raw stream of finger/pointer events without Altus gesture generation, please see RawInputHandler. More... | |
class | ClassicInputHandler |
class | ClusteredMarkerMap |
A map of markers, where some of the markers are hidden when the camera is zoomed far away. As you zoom in, more markers appear. Tiles are generated up to the specified maxLevel and the tiles are stored in memory. More... | |
class | Color |
Represents a color. More... | |
class | ColorBar |
class | Diagnostics |
class | DynamicExtrudedPolygon |
Represents a dynamic 2D polygon, extruded into 3D using a min and max altitude. More... | |
class | DynamicLine |
Represents a 2D dynamic line. More... | |
class | DynamicLine3D |
Represents a 3D dynamic line. More... | |
class | DynamicMarker |
Conveys information about a marker that will have its attributes updated frequently. More... | |
class | DynamicMarkerMap |
A dynamic marker map. Use this map to show markers that can move. Every marker is drawn every frame (they are not broken up into tiles). More... | |
class | DynamicPolygon |
Represents a dynamic 2D polygon. More... | |
class | DynamicPolygon3D |
Represents a dynamic 3D polygon. More... | |
class | DynamicShape |
Represents a dynamic shape. More... | |
class | DynamicVectorMap |
Represents a map of dynamic vector data. More... | |
class | DynamicVectorMarkerMap |
Represents a map of vector markers (currently only AnimatedVectorCircles) More... | |
class | ExtrudedPolygon |
class | Framerate |
Controls the rendering framerate. Use this to turn on "Green Mode", which renders less frequently and reduced performance requirements and power consumption. More... | |
class | FrameRenderer |
class | FreeAxisInputHandler |
class | GeoBoundingBox |
class | GeographicPosition |
Represents a three dimensional location using latitude, longitude, and altitude. More... | |
class | GeographicPosition2D |
Represents a two dimensional location using latitude and longitude. More... | |
class | GeometryGroup |
class | GestureInputHandler |
class | HitTesting |
Controls Scene-wide hit testing. More... | |
class | IGestureReceiver |
An extendible class that allows a developer to handle Altus gestures (such as panning and zooming) in a unique way. There is also an existing sub-class, ClassicGestureReceiver, that handles gestures in the classic Altus 2.0 way. Gesture events are generated by Altus from the raw stream of finger/pointer events. If you would like access to the raw stream of finger/pointer events without Altus gesture generation, please see RawInputHandler. More... | |
class | ILongPressDelegate |
class | Image |
class | IMarkerMapDelegate |
A delegate for a MarkerMap, used to receive events when a user clicks on a marker or to specify the images for markers that were created without images (such as VirtualMap tiled marker maps). More... | |
class | IModelMapDelegate |
class | InputEventManager |
class | InstancedModel |
class | InternetTileProvider |
class | IResourceManager |
class | ISceneDelegate |
class | ITileLoader |
class | ITileProvider |
class | ITimerListener |
class | IVectorMapDelegate |
A delegate object for a VectorMap. If you create a sub-object of this type, you can receive hit detection events for the VectorMap. More... | |
class | KeyboardEvent |
class | Keysym |
class | LineSegmentHit |
Represents a "hit" or "tap" or "click" on a vector line. More... | |
class | LineStyle |
Expresses style for a line. More... | |
class | ListGestureReceiver |
An extendible class that allows a developer to handle Altus gestures (such as panning and zooming) in a unique way. There is also an existing sub-class, ClassicGestureReceiver, that handles gestures in the classic Altus 2.0 way. Gesture events are generated by Altus from the raw stream of finger/pointer events. If you would like access to the raw stream of finger/pointer events without Altus gesture generation, please see RawInputHandler. More... | |
class | ListInputHandler |
class | LoadingInstructions |
class | LongPressGestureReceiver |
An extendible class that allows a developer to handle Altus gestures (such as panning and zooming) in a unique way. There is also an existing sub-class, ClassicGestureReceiver, that handles gestures in the classic Altus 2.0 way. Gesture events are generated by Altus from the raw stream of finger/pointer events. If you would like access to the raw stream of finger/pointer events without Altus gesture generation, please see RawInputHandler. More... | |
class | LongPressInputHandler |
class | Map |
A base class for all Maps. You cannot create this map directly. More... | |
class | MapDesc |
class | MapDoubleColor |
class | MapSamplerDesc |
class | MapSamplerExtrudedVectorData |
class | MapSamplerMarkerResourceData |
class | MapSamplerPointWithPercentage |
class | MapUintMarker |
class | MapUintMarkerResource |
class | MapView |
class | Marker |
class | MarkerData |
The data required to create a marker. More... | |
class | MarkerHit |
Information about a marker the user has tapped or clicked on. More... | |
class | MarkerImageInfo |
class | MarkerMap |
Base class for marker maps. You cannot create one of these. More... | |
class | MarkerResource |
class | Mesh |
class | Model |
class | ModelHit |
class | ModelMap |
A map of 3D models. Every model is drawn every frame. This map is not tiled. More... | |
class | ModelTransform |
class | ModelVertex |
class | MouseButtonEvent |
class | MouseMotionEvent |
class | MouseWheelEvent |
class | MultiGestureEvent |
class | Orientation |
/////////////////////////////////////////////// More... | |
class | PointSet |
class | PointSet3d |
class | Polar |
class | Polygon |
class | PolygonHit |
Represents hit detection on a polygon. More... | |
class | PolygonStyle |
Expresses style for a polygon. More... | |
class | quatd |
class | RawInputHandler |
class | Scene |
The main rendering component and container of other objects. More... | |
class | Screen |
Represents the screen or window Altus renders to. More... | |
class | ScreenSpacePercentagePoint |
class | Sphere |
class | Texture |
class | TileId |
class | TileResult |
class | Timer |
class | TimeStamp |
class | TouchFingerEvent |
class | Transform |
class | TriangleSet3d |
class | Uint64_LowHigh |
class | vec2d |
class | vec2f |
class | vec2i |
class | vec3d |
class | vec3f |
class | vec4f |
class | VectorBoundingBox |
class | VectorByte |
class | VectorColor |
class | VectorCoordsVect |
class | VectorDynamicMarker |
class | VectorExtrudedPolygon |
class | VectorFloat |
class | VectorGeoBoundingBox |
class | VectorGeographicPosition |
class | VectorGeographicPosition2D |
class | VectorGeometryHit |
Represents a "hit" or "click" or "tap" on a 2D line or polygon. More... | |
class | VectorGLushort |
class | VectorInt |
class | VectorMap |
Represents a map of vector data that is rarely updated. Tiles are generated using this map and lines and polygons are split across tiles if necessary. For a vector map of frequently updated or deleted shapes, see DynamicVectorMap. More... | |
class | VectorMapBase |
Represents a map of vector data. More... | |
class | VectorMapSamplerPointWithPercentage |
class | VectorMarker |
class | VectorMarkerData |
class | VectorMarkerHit |
class | VectorModel |
class | VectorModelHit |
class | VectorModelVertex |
class | VectorPointSet |
class | VectorPointSet3d |
class | VectorPolygon |
class | VectorPolygonHit |
class | VectorShort |
class | VectorString |
class | VectorTexture |
class | VectorTileId |
class | VectorTileResult |
class | VectorTransform |
class | VectorTriangleSet3d |
class | VectorUint32_t |
class | VectorUint64_t |
class | VectorVec2d |
class | VectorVec3d |
class | VertexHit |
Represents a "hit" or "click" or "tap" on a 2D line or polygon. More... | |
class | VirtualMap |
A map where the tiles are specified by a tile provider. This map allows you to generate the data however you like, by creating a custom TileProvider. There are available TileProviders as well, such as the InternetTileProvider, for downloading tiles from a URL. More... | |
class | WeatherGridMap |
A WeatherGridMap is a special kind of map where each tile is raster data, either 1 channel or 3 channels, and the data in these tiles are colored using a color bar. For example, a temperature map would have 1 channel of temperatures and the color bar would color the temperatures from blue (for cold) through red (for hot). More... | |
Functions | |
int | InitializeMapView () |
Scene | getScene () |
InputEventManager | getInputManager () |
Timer | getTimer () |
void | setDomainName (string) |
void | handlePageVisible (bool) |
size_t | hashString (string s) |
double | toDegreesUnchecked (double radians) |
Converts radians to degrees. More... | |
double | toRadiansUnchecked (double degrees) |
Converts degrees to radians. More... | |
double | toDegrees (double radians) |
Converts radians to degrees. More... | |
double | toRadians (double degrees) |
Converts degrees to radians. More... | |
double | toRadians (double degrees, double minutes) |
Converts degrees and minutes to radians. More... | |
double | convertCoordinate (double hour, double min, double sec, char direction) |
Converts a value like 30 06' 11'' W to a positive ot negative value. More... | |
bool | areEqual (double a, double b) |
Tests whether a and b are equal More... | |
double | arcLength (double minLat, double maxLat) |
Converts maxLat-minLat to radians and returns the value More... | |
double | arcLength (double lat, double minLon, double maxLon) |
Takes 90-lat, canverts to radians and takes the sin. Multiplies that by the radian value of maxLon-minLon. More... | |
double | maxArcLength (vec2d minCoord, vec2d maxCoord) |
Finds the maximum arc length between two coordinates More... | |
bool | isValidCoordinate (vec2d coord) |
Tests whether a and b are equal More... | |
double | distanceBetween (vec2d point0, vec2d point1) |
Returns distance in radians between two geographic locations, each location represented in radians More... | |
double | nauticalMilesBetween (vec2d point0, vec2d point1) |
Returns distance in nm between two geographic locations, each location represented in degrees More... | |
double | nauticalMilesInRoute (VectorVec2d points) |
Returns the total distance along a series of lon/lat points in degrees More... | |
double | radiansToNauticalMiles (double radians) |
Converts radians to nautical miles More... | |
double | nauticalMilesToRadians (double nauticalMiles) |
Converts nautical miles to radians More... | |
double | nauticalMilesToMeters (double nauticalMiles) |
Converts nautical miles to meters More... | |
double | metersToNauticalMiles (double meters) |
Converts meters to nautical miles More... | |
double | getEarthCircumferenceInMeters () |
Compute Earth's circumference in meters More... | |
double | getEarthCircumferenceInNauticalMiles () |
Compute Earth's circumference in nautical miles More... | |
double | courseFromPointToPoint (vec2d point1, vec2d point2) |
Returns the course to take to reach point2 from point1 More... | |
vec2d | pointBetween (vec2d point1, vec2d point2, double f) |
Returns the point that is f/1 the distance between point1 and point2. When f = 0, point 1 will be returned, when f = 1, point 2 will be returned. This is used for route-line point tesselation. The units of point1 and point 2 should be degrees x=lon/y=lat. Returned point will be degrees x=lon/y=lat. More... | |
vec2d | pointOnRadial (vec2d origin, double radial, double distance) |
Returns a point that is a given distance along an angle from an origin point. More... | |
vec2d | closestPointOnLineToPoint (vec2d point, vec2d line0, vec2d line1) |
Given a point, this function looks along a line and calculates the nearest point on the line to that point. More... | |
bool | isAngleBetweenAngles (double angle, double angleStart, double angleEnd) |
Takes in an angle in degrees and tests if it is between two angle values More... | |
VectorVec2d | tesselateRoute (vec2d point1, vec2d point2, unsigned int numPoints) |
Creates numPoints points along the great-circle line between point1 and point2 More... | |
VectorVec2d | tesselateRouteFast (vec2d point1, vec2d point2, unsigned int numPoints) |
Creates numPoints points along the route between point1 and point2 More... | |
VectorVec2d | tesselateRoute (VectorVec2d wayPoints, unsigned int numSamples) |
Tesselates a route given as an array points along that route. The returned samples are evenly spaced in nautical miles over the route. More... | |
quatd | make_quaternion (Orientation orientation) |
Makes a quaternion More... | |
Orientation | make_orientation (quatd q) |
Makes an orientation More... | |
vec3d | rotate (quatd q, vec3d x) |
Rotates a quaternion More... | |
vec3d | slerp (vec3d fromVec3d, vec3d end, double alpha) |
Performs a slerp More... | |
vec3d | make_orientationRPY (quatd q) |
Makes an orientationRPY More... | |
quatd | make_quaternion (vec3d Axis, double angle) |
Makes a quaternion More... | |
vec3d | getWorldPosition (GeographicPosition position) |
Gets a position More... | |
quatd | getLocalOrientation (Polar polarPosition, quatd orientation) |
Gets an orientation More... | |
Orientation | getGeographicOrientation (vec3d worldPosition, quatd worldOrientation) |
Gets an orientation More... | |
vec3d | intersectRayWithUnitSphereOrClosestPoint (vec3d worldPosition, vec3d worldRay) |
Performs the intersection and returns the point More... | |
vec3d | intersectRayWithSphereOrClosestPoint (double sphereRadius, vec3d worldPosition, vec3d worldRay2) |
Performs the intersection and returns the point More... | |
double | lerpAngle (double start, double end, double t) |
double | lerpAngleRadians (double start, double end, double t) |
double | wrapAngle (double value, double lower, double upper) |
double | wrapAngleRadians (double value) |
double | wrapLongitude (double value) |
double | getGeographicLength (vec2d a, vec2d b) |
double | maxArcLength (BoundingBox bounds) |
GeographicPosition | getGeographicPosition (vec3d worldPosition) |
GeographicPosition2D | getGeographicPosition2D (vec3d worldPosition) |
Variables | |
double | EARTH_RADIUS_METERS |
double | EARTH_RADIUS |
double | ATMOSPHERE_RADIUS_METERS |
double | ATMOSPHERE_RADIUS |
double | RADIAN_TO_DEGREE |
double | DEGREE_TO_RADIAN |
double | EPSILON |
double | MERCATOR_MAX |
double | MERCATOR_MIN |
double | HEIGHTSCALE_DIVISOR |
int | MAX_LEVEL |
Enumerator | |
---|---|
NOEVENT | |
FIRSTEVENT |
Unused (do not remove) |
QUIT |
User-requested quit |
WINDOWEVENT |
Window state change |
SYSWMEVENT |
System specific event |
KEYDOWN |
Key pressed |
KEYUP |
Key released |
TEXTEDITING |
Keyboard text editing (composition) |
TEXTINPUT |
Keyboard text input |
MOUSEMOTION |
Mouse moved |
MOUSEBUTTONDOWN |
Mouse button pressed |
MOUSEBUTTONUP |
Mouse button released |
MOUSEWHEEL |
Mouse wheel motion |
INPUTMOTION |
Input moved |
INPUTBUTTONDOWN |
Input button pressed |
INPUTBUTTONUP |
Input button released |
INPUTWHEEL |
Input wheel motion |
INPUTPROXIMITYIN |
Input pen entered proximity |
INPUTPROXIMITYOUT |
Input pen left proximity |
JOYAXISMOTION |
Joystick axis motion |
JOYBALLMOTION |
Joystick trackball motion |
JOYHATMOTION |
Joystick hat position change |
JOYBUTTONDOWN |
Joystick button pressed |
JOYBUTTONUP |
Joystick button released |
FINGERDOWN | |
FINGERUP | |
FINGERMOTION | |
TOUCHBUTTONDOWN | |
TOUCHBUTTONUP | |
DOLLARGESTURE | |
DOLLARRECORD | |
MULTIGESTURE | |
CLIPBOARDUPDATE |
The clipboard changed |
EVENT_COMPAT1 |
SDL 1.2 events for compatibility |
EVENT_COMPAT2 | |
EVENT_COMPAT3 | |
USEREVENT |
Events USEREVENT through LASTEVENT are for your use, and should be allocated with RegisterEvents() |
LASTEVENT |
This last event is only for bounding internal arrays |
Describes the pixel format of an image.
enum AltusUnified::Keymod |
Expresses the meaning of the relative position of the Sun (for lighting and for the Sun sprite).
Describes the type a map is.
Conveys a map type.
Enumerator | |
---|---|
Unknown |
Unknown map type |
Virtual |
Data is provided by tile providers |
Package |
Data comes from Atlus package files |
PackageTerrain |
Data comes from Altus package files and contains height data |
Model |
Map contains 3D models |
DynamicMarkerMap |
Map contains moveable markers |
VectorMap |
Map contains static vector data |
DynamicVectorMap |
Map contains dynamic vector data |
ClusteredMarkerMap |
Map contains clustered marker data |
WeatherGridMap |
Map contains gridded weather data |
DynamicVectorMarkerMap |
Map contains animated vectors, such as vector circles |
VirtualMarker |
Marker data is provided by tile providers |
double AltusUnified::arcLength | ( | double | minLat, |
double | maxLat | ||
) |
Converts maxLat-minLat to radians and returns the value
double AltusUnified::arcLength | ( | double | lat, |
double | minLon, | ||
double | maxLon | ||
) |
Takes 90-lat, canverts to radians and takes the sin. Multiplies that by the radian value of maxLon-minLon.
bool AltusUnified::areEqual | ( | double | a, |
double | b | ||
) |
Tests whether a and b are equal
Given a point, this function looks along a line and calculates the nearest point on the line to that point.
double AltusUnified::convertCoordinate | ( | double | hour, |
double | min, | ||
double | sec, | ||
char | direction | ||
) |
Converts a value like 30 06' 11'' W to a positive ot negative value.
Returns the course to take to reach point2 from point1
Returns distance in radians between two geographic locations, each location represented in radians
double AltusUnified::getEarthCircumferenceInMeters | ( | ) |
Compute Earth's circumference in meters
double AltusUnified::getEarthCircumferenceInNauticalMiles | ( | ) |
Compute Earth's circumference in nautical miles
Orientation AltusUnified::getGeographicOrientation | ( | vec3d | worldPosition, |
quatd | worldOrientation | ||
) |
Gets an orientation
GeographicPosition AltusUnified::getGeographicPosition | ( | vec3d | worldPosition | ) |
GeographicPosition2D AltusUnified::getGeographicPosition2D | ( | vec3d | worldPosition | ) |
InputEventManager AltusUnified::getInputManager | ( | ) |
Gets an orientation
Scene AltusUnified::getScene | ( | ) |
Timer AltusUnified::getTimer | ( | ) |
vec3d AltusUnified::getWorldPosition | ( | GeographicPosition | position | ) |
Gets a position
void AltusUnified::handlePageVisible | ( | bool | ) |
size_t AltusUnified::hashString | ( | string | s | ) |
int AltusUnified::InitializeMapView | ( | ) |
vec3d AltusUnified::intersectRayWithSphereOrClosestPoint | ( | double | sphereRadius, |
vec3d | worldPosition, | ||
vec3d | worldRay2 | ||
) |
Performs the intersection and returns the point
vec3d AltusUnified::intersectRayWithUnitSphereOrClosestPoint | ( | vec3d | worldPosition, |
vec3d | worldRay | ||
) |
Performs the intersection and returns the point
bool AltusUnified::isAngleBetweenAngles | ( | double | angle, |
double | angleStart, | ||
double | angleEnd | ||
) |
Takes in an angle in degrees and tests if it is between two angle values
bool AltusUnified::isValidCoordinate | ( | vec2d | coord | ) |
Tests whether a and b are equal
double AltusUnified::lerpAngle | ( | double | start, |
double | end, | ||
double | t | ||
) |
double AltusUnified::lerpAngleRadians | ( | double | start, |
double | end, | ||
double | t | ||
) |
Orientation AltusUnified::make_orientation | ( | quatd | q | ) |
Makes an orientation
quatd AltusUnified::make_quaternion | ( | Orientation | orientation | ) |
Makes a quaternion
Finds the maximum arc length between two coordinates
double AltusUnified::maxArcLength | ( | BoundingBox | bounds | ) |
double AltusUnified::metersToNauticalMiles | ( | double | meters | ) |
Converts meters to nautical miles
Returns distance in nm between two geographic locations, each location represented in degrees
double AltusUnified::nauticalMilesInRoute | ( | VectorVec2d | points | ) |
Returns the total distance along a series of lon/lat points in degrees
double AltusUnified::nauticalMilesToMeters | ( | double | nauticalMiles | ) |
Converts nautical miles to meters
double AltusUnified::nauticalMilesToRadians | ( | double | nauticalMiles | ) |
Converts nautical miles to radians
Returns the point that is f/1 the distance between point1 and point2. When f = 0, point 1 will be returned, when f = 1, point 2 will be returned. This is used for route-line point tesselation. The units of point1 and point 2 should be degrees x=lon/y=lat. Returned point will be degrees x=lon/y=lat.
Returns a point that is a given distance along an angle from an origin point.
double AltusUnified::radiansToNauticalMiles | ( | double | radians | ) |
Converts radians to nautical miles
void AltusUnified::setDomainName | ( | string | ) |
VectorVec2d AltusUnified::tesselateRoute | ( | vec2d | point1, |
vec2d | point2, | ||
unsigned int | numPoints | ||
) |
Creates numPoints points along the great-circle line between point1 and point2
VectorVec2d AltusUnified::tesselateRoute | ( | VectorVec2d | wayPoints, |
unsigned int | numSamples | ||
) |
Tesselates a route given as an array points along that route. The returned samples are evenly spaced in nautical miles over the route.
VectorVec2d AltusUnified::tesselateRouteFast | ( | vec2d | point1, |
vec2d | point2, | ||
unsigned int | numPoints | ||
) |
Creates numPoints points along the route between point1 and point2
double AltusUnified::toDegrees | ( | double | radians | ) |
Converts radians to degrees.
double AltusUnified::toDegreesUnchecked | ( | double | radians | ) |
Converts radians to degrees.
double AltusUnified::toRadians | ( | double | degrees | ) |
Converts degrees to radians.
double AltusUnified::toRadians | ( | double | degrees, |
double | minutes | ||
) |
Converts degrees and minutes to radians.
double AltusUnified::toRadiansUnchecked | ( | double | degrees | ) |
Converts degrees to radians.
double AltusUnified::wrapAngle | ( | double | value, |
double | lower, | ||
double | upper | ||
) |
double AltusUnified::wrapAngleRadians | ( | double | value | ) |
double AltusUnified::wrapLongitude | ( | double | value | ) |
double AltusUnified::ATMOSPHERE_RADIUS |
double AltusUnified::ATMOSPHERE_RADIUS_METERS |
double AltusUnified::DEGREE_TO_RADIAN |
double AltusUnified::EARTH_RADIUS |
double AltusUnified::EARTH_RADIUS_METERS |
double AltusUnified::EPSILON |
double AltusUnified::HEIGHTSCALE_DIVISOR |
int AltusUnified::MAX_LEVEL |
double AltusUnified::MERCATOR_MAX |
double AltusUnified::MERCATOR_MIN |
double AltusUnified::RADIAN_TO_DEGREE |