VisualInstruction

 
extension VisualInstruction

  • Returns a CPImageSet representing the maneuver.

    Declaration

    Swift

    @available(iOS 12.0, *)
public func maneuverImageSet(side: DrivingSide) -> CPImageSet?
    View Source on GitHub

  • Returns whether the VisualInstruction’s maneuver image should be flipped according to the driving side.

    Declaration

    Swift

    public func shouldFlipImage(side: DrivingSide) -> Bool
    View Source on GitHub

  • Glanceable instruction given the available space, appearance styling, and attachments.

    Declaration

    Swift

    @available(iOS 12.0, *)
public func carPlayManeuverLabelAttributedText<T: InstructionLabel>(bounds: @escaping () -> (CGRect),
                                                                    shieldHeight: CGFloat,
                                                                    window: UIWindow?,
                                                                    instructionLabelType: T.Type? = nil) -> NSAttributedString?

    Parameters

    bounds

    A closure that calculates the available bounds for the maneuver text.
    shieldHeight

    The height of the shield.
    window

    A UIWindow that holds the UIAppearance styling properties, preferably the CarPlay window.
    instructionLabelType

    Type, which is inherited from InstructionLabel and will be used for showing a visual instruction.

    Return Value

    An NSAttributedString with maneuver instructions.

    View Source on GitHub

  • Returns a CPImageSet representing the maneuver lane configuration.

    Declaration

    Swift

    @available(iOS 12.0, *)
public func lanesImageSet(side: DrivingSide, direction: ManeuverDirection?, scale: CGFloat) -> CPImageSet?
    View Source on GitHub