app/org.scottishtecharmy.soundscape.geoengine/UserGeometry

UserGeometry

class UserGeometry(val location: LngLatAlt = LngLatAlt(), var phoneHeading: Double? = null, val fovDistance: Double = 50.0, val inVehicle: Boolean = false, val inMotion: Boolean = false, val speed: Double = 0.0, headingMode: UserGeometry.HeadingMode = HeadingMode.CourseAuto, travelHeading: Double? = null, headHeading: Double? = null, inStreetPreview: Boolean = false)

UserGeometry contains all of the data relating to the location and motion of the user. It's aim is to reduces the number of arguments to many of the API calls and to concentrate some of the logic around heading choice.

Parameters

phoneHeading

is the direction in which the phone is pointing

travelHeading

is the direction in which the phone is moving

headHeading

is the direction in which the head tracking is pointing (not currently implemented)

The heading prioritization comes from iOS - see https://github.com/Scottish-Tech-Army/Soundscape-Android/issues/364

collection - used for calculating callouts, two possibilities: course (travel), user (head), device (phone), or user (head), device (phone), course (travel)

presentation - user for audio positioning: user (head), course (travel), device (phone)

Constructors

UserGeometry

constructor(location: LngLatAlt = LngLatAlt(), phoneHeading: Double? = null, fovDistance: Double = 50.0, inVehicle: Boolean = false, inMotion: Boolean = false, speed: Double = 0.0, headingMode: UserGeometry.HeadingMode = HeadingMode.CourseAuto, travelHeading: Double? = null, headHeading: Double? = null, inStreetPreview: Boolean = false)