Skip to main content
Version: 3.9

enum AltitudeMode

(Niantic.Lightship.AR.WorldPositioning.ARWorldPositioningObjectHelper.AltitudeMode)

Overview

The altitude above sea level is often inaccurate and the floor height unknown. The AltitudeMode provides the option to use a different system for representing altitude/height.


enum AltitudeMode {
SEA_LEVEL = 0,
TRACKING = 1,
CAMERA = 2,
CAMERA_AVERAGED = 3,
};

Detailed Documentation

The altitude above sea level is often inaccurate and the floor height unknown. The AltitudeMode provides the option to use a different system for representing altitude/height.

SEA_LEVELThe standard WGS84 altitude above sea-level. This option is only recommended for use when working with map data where the altitude is known.

TRACKINGUses the y coordinate of the AR tracking coordinate system. This is recommended if content is generated using runtime estimates of the ground position, which will usually be in AR tracking coordinates.

CAMERAPositions content relative the height of the camera. This can be used for navigation arrows or similar visual indicators.

CAMERA_AVERAGEDSimilar to CAMERA but uses the average camera height to provide a stable relative position while behaving intuitevely if the user moves the device up and down momentarily. This method is recommended for most applications.