com.navigine.idl.java.Position Class Reference

Class describing user's position. More...

Public Member Functions
	Position (GlobalPoint point, double accuracy, Double heading, Double headingAccuracy, LocationPoint locationPoint, Double locationHeading)
	Default constructor for class Position.
GlobalPoint	getPoint ()
	position in WGS84 coordinates.
double	getAccuracy ()
Double	getHeading ()
	Heading, angle of rotation about the -Z axis (in radians). This value represents the angle between the device's Y axis and the magnetic north pole. When facing north, this angle is 0, when facing south, this angle is pi. Likewise, when facing east, this angle is pi/2, and when facing west, this angle is -pi/2. The range of values is [-pi, pi].
Double	getHeadingAccuracy ()
	Heading accuracy in radians.
LocationPoint	getLocationPoint ()
	position in metrics coordinates at calculated location and sublocation com.navigine.idl.java.LocationPoint
Double	getLocationHeading ()
	Similiar to heading but with respect to sublocation north (top of the image)
String	toString ()

Detailed Description

Class describing user's position.

Referenced from: NavigationManager, PositionListener.

Definition at line 16 of file Position.java.

Constructor & Destructor Documentation

Position()

com.navigine.idl.java.Position.Position ( GlobalPoint point, double accuracy, Double heading, Double headingAccuracy, LocationPoint locationPoint, Double locationHeading )

inline

Default constructor for class Position.

Definition at line 34 of file Position.java.

Member Function Documentation

getAccuracy()

double com.navigine.idl.java.Position.getAccuracy ( )

inline

Returns

Position accuracy in meters

Java code snippet:

        // Get position accuracy
        double accuracy = position.getAccuracy();
        System.out.println("Position accuracy: " + accuracy + " meters");

Kotlin code snippet:

        // Get position accuracy
        val accuracy = position.accuracy
        println("Position accuracy: $accuracy meters")

Definition at line 77 of file Position.java.

getHeading()

Double com.navigine.idl.java.Position.getHeading ( )

inline

Heading, angle of rotation about the -Z axis (in radians). This value represents the angle between the device's Y axis and the magnetic north pole. When facing north, this angle is 0, when facing south, this angle is pi. Likewise, when facing east, this angle is pi/2, and when facing west, this angle is -pi/2. The range of values is [-pi, pi].

Returns

Java code snippet:

        // Get heading (angle of rotation about the -Z axis in radians)
        Double heading = position.getHeading();
        if (heading != null) {
            System.out.println("Heading: " + heading + " radians");
        }

Kotlin code snippet:

        // Get heading (angle of rotation about the -Z axis in radians)
        val heading = position.heading
        heading?.let { println("Heading: $it radians") }

Definition at line 99 of file Position.java.

getHeadingAccuracy()

Double com.navigine.idl.java.Position.getHeadingAccuracy ( )

inline

Heading accuracy in radians.

Returns

Java code snippet:

        // Get heading accuracy
        Double headingAccuracy = position.getHeadingAccuracy();
        if (headingAccuracy != null) {
            System.out.println("Heading accuracy: " + headingAccuracy + " radians");
        }

Kotlin code snippet:

        // Get heading accuracy
        val headingAccuracy = position.headingAccuracy
        headingAccuracy?.let { println("Heading accuracy: $it radians") }

Definition at line 115 of file Position.java.

getLocationHeading()

Double com.navigine.idl.java.Position.getLocationHeading ( )

inline

Similiar to heading but with respect to sublocation north (top of the image)

Returns

Java code snippet:

        // Get location heading (with respect to sublocation north)
        Double locationHeading = position.getLocationHeading();
        if (locationHeading != null) {
            System.out.println("Location heading: " + locationHeading + " radians");
        }

Kotlin code snippet:

        // Get location heading (with respect to sublocation north)
        val locationHeading = position.locationHeading
        locationHeading?.let { println("Location heading: $it radians") }

Definition at line 147 of file Position.java.

getLocationPoint()

LocationPoint com.navigine.idl.java.Position.getLocationPoint ( )

inline

position in metrics coordinates at calculated location and sublocation com.navigine.idl.java.LocationPoint

Returns

Java code snippet:

        // Get location point (metrics coordinates)
        LocationPoint locationPoint = position.getLocationPoint();
        if (locationPoint != null) {
            demonstrateLocationPointUsage(locationPoint);
        }

Kotlin code snippet:

        // Get location point (metrics coordinates)
        val locationPoint = position.locationPoint
        locationPoint?.let { demonstrateLocationPointUsage(it) }

Definition at line 131 of file Position.java.

getPoint()

GlobalPoint com.navigine.idl.java.Position.getPoint ( )

inline

position in WGS84 coordinates.

Returns

Java code snippet:

        // Get global point (WGS84 coordinates)
        GlobalPoint globalPoint = position.getPoint();
        if (globalPoint != null) {
            demonstrateGlobalPointUsage(globalPoint);
        }

Kotlin code snippet:

        // Get global point (WGS84 coordinates)
        val globalPoint = position.point
        globalPoint?.let { demonstrateGlobalPointUsage(it) }

Definition at line 61 of file Position.java.

toString()

String com.navigine.idl.java.Position.toString ( )

inline

Definition at line 152 of file Position.java.

---

The documentation for this class was generated from the following file:

• Position.java