SafetyLocationElement

public struct SafetyLocationElement : HorizonElement

Describes a safety location on the horizon element.

This structure holds a horizon element with information regarding safety location. It contains information regarding safety location’s ID, start, end, bounding box, type, speed limit, recommended warning distance and flag indicating whether safety location is zone.

To obtain SafetyLocationElement horizon elements, the integrator must create an instance of HorizonEngine, register HorizonOptions including elementTypes containing HorizonElementType .safetyLocationType with a call to HorizonEngine .registerHorizonOptions, and request a HorizonResult using the previously registered HorizonOptions with a call to HorizonEngine .generateHorizon.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle


                    
                    
                    init(id:pathID:startOffset:endOffset:safetyLocationId:startLocation:endLocation:boundingBox:type:speedLimit:recommendedWarningDistance:isZone:)

Initializes instance of SafetyLocationElement.

Declaration

Swift

public init(
    id: Int,
    pathID: Int,
    startOffset: Measurement<UnitLength>,
    endOffset: Measurement<UnitLength>,
    safetyLocationId: String,
    startLocation: CLLocationCoordinate2D,
    endLocation: CLLocationCoordinate2D,
    boundingBox: BoundingBox,
    type: SafetyLocationElement.SafetyLocationType,
    speedLimit: Measurement<UnitSpeed>?,
    recommendedWarningDistance: Measurement<UnitLength>?,
    isZone: Bool
)

Public

SafetyLocationType
Safety location types.

Important
This is a Public Preview API. It may be changed or removed at any time.
See more
Declaration
Swift

public enum SafetyLocationType
elementType
Type of the element. Used to filter elements by type.
Declaration
Swift

public let elementType: HorizonElementType
id
Identifier of this element.
Declaration
Swift

public let id: Int
pathID
Identifier of the path where this element belongs.
Declaration
Swift

public let pathID: Int
startOffset
Start offset on the path.
Declaration
Swift

public let startOffset: Measurement<UnitLength>


                    
                    
                    endOffset

End offset on the path.

Declaration

Swift

public let endOffset: Measurement<UnitLength>

safetyLocationId
Unique id of safety location data object.
Declaration
Swift

public let safetyLocationId: String
startLocation
Start coordinate of the safety location.
Declaration
Swift

public let startLocation: CLLocationCoordinate2D
endLocation
End coordinate of the safety location.
Declaration
Swift

public let endLocation: CLLocationCoordinate2D
boundingBox
Bounding box encapsulating safety location.
Declaration
Swift

public let boundingBox: BoundingBox
type
Safety location type.
Declaration
Swift

public let type: SafetyLocationType
speedLimit
The maximum allowed speed for the reported safety location.
Declaration
Swift

public let speedLimit: Measurement<UnitSpeed>?
recommendedWarningDistance
Recommended warning distance.
Declaration
Swift

public let recommendedWarningDistance: Measurement<UnitLength>?
isZone
An indication if the camera is a zone. i.e., if the start and end points are truly different locations.
Declaration
Swift

public let isZone: Bool