Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Vehicle

The Vehicle class defines a vehicle to be put on a map. It stores the model information, trips and other position information.

const pos = new google.maps.LatLng(20.65273901635008, -103.44528316226638)
const id = "uniqueId"
const orientation = 120

const model = new Mapster.Model(
'red',
'https://stsiliantstaticdev.blob.core.windows.net/map-3d-models/taxi.glb',
10, 7, 100, 2)

const vehicle = new Mapster.Vehicle(id, pos, orientation, model, {  anotherProperty: 1 })

// Add vehicle to map. See more about adding vehicles to the map on the map documentation.
vehicle.setMap(map);
map.addVehicle(vehicle);
map.setVehicles([vehicle])

// Add positions to trip queue
const goToPosition = new google.maps.LatLng(20.693668019183118, -103.35969321162369)
vehicle.addPosition(goToPosition)

// Get position in current timestamp.
const currentPosition = vehicle.getCurrentPosition()
console.log(currentPosition)

// Get if vehicle is moving or not.
console.log(vehicle.isMoving)

// Get last position of last trip.
const lastPosition = vehicle.getLastPosition()
console.log(lastPosition)

Hierarchy

  • Vehicle

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Vehicle(id: string, initialPosition: LatLng, initialHeading: number, model: Model, onClick: Function, properties?: any): Vehicle

  • Creates a new instance of Vehicle.

    Parameters

    • id: string

      Vehicle unique Id.

    • initialPosition: LatLng

      Starting position.

    • initialHeading: number

      Starting heading angle.

    • model: Model

      3D Model.

    • onClick: Function
    • Optional properties: any

      Any extra properties to be added.

    Returns Vehicle

Properties

Optional anchorPoint

anchorPoint: LatLng

model

model: Model

properties

properties: any

Accessors

currentTripIndex

  • get currentTripIndex(): number

  • Current trip index.

    Returns number

historicalTrips

  • get historicalTrips(): Trip[]

  • All vehicle individual trips or sections already traveled or left to travel.

    Returns Trip[]

id

  • get id(): string

  • Returns string

initialHeading

  • get initialHeading(): number

  • Vehicle's initial heading angle.

    Returns number

isMoving

  • get isMoving(): boolean

  • If vehicle is moving.

    Returns boolean

lowerIcon

  • get lowerIcon(): Icon

  • Returns Icon

onClick

  • set onClick(o: Function): void

  • Parameters

    • o: Function

    Returns void

tripStartTimeStamp

  • get tripStartTimeStamp(): number

  • Trip start datetime.

    Returns number

trips

  • get trips(): Trip[]

  • All vehicle individual trips or sections left to travel.

    Returns Trip[]

Methods

addPosition

  • addPosition(position: LatLng, speed: number, animate?: boolean): void

  • Adds a next step in the trip.

    Parameters

    • position: LatLng

      Next position.

    • speed: number

      Speed in km/h.

    • Default value animate: boolean = true

    Returns void

getCurrentPosition

  • getCurrentPosition(): LatLng

  • Fetches the current vehicle position in time.

    Returns LatLng

    Current vehicle position.

getFrame

  • getFrame(timeStamp: number): object

  • Gets the vehicle frame on a particular timeStamp.

    Parameters

    • timeStamp: number

    Returns object

    • heading: number
    • id: string
    • lowerIcon: Icon
    • onClick: Function
    • point: number[]

getFullDistanceAhead

  • getFullDistanceAhead(): number

  • Fetch the vehicle's distance left to travel in meters.

    Returns number

getGeoJsonFeature

  • getGeoJsonFeature(): object

  • Fetch the vehicle GeoJson feature. The vehicle full path.

    Returns object

    GeoJson feature.

    • properties: object
    • type: string
    • geometry: object
      • coordinates: number[][]
      • type: string

getLastPosition

  • getLastPosition(): LatLng

  • Get the vehicle's destination position.

    Returns LatLng

    Destination position.

getPositionInTime

  • getPositionInTime(timeStamp: number): object

  • Returns the position the vehicle should be in a given time.

    Parameters

    • timeStamp: number

      Timestamp to get the vehicle position from.

    Returns object

    position and heading of the vehicle.

    • heading: number
    • position: LatLng

setLowerIcon

  • setLowerIcon(icon?: Icon): void

  • Parameters

    • Optional icon: Icon

    Returns void

setMap

  • setMap(map: VehicleMap | null): void

  • Adds vehicle to a map instance.

    Parameters

    • map: VehicleMap | null

      Map instance.

    Returns void

Generated using TypeDoc