FollowMePilotingItf

public protocol FollowMePilotingItf : ActivablePilotingItf, PilotingItf

FollowMe piloting interface.

During an activated FollowMe, the drone will always look at the target but can be piloted normally. However, yaw value is not settable. Camera tilt and pan command is ignored by the drone.

This piloting interface can be retrieved by:

drone.getPilotingItf(PilotingItfs.followMe)

  • The follow mode to use.

    Note

    This setting is not saved at the application level.

    Declaration

    Swift

    var followMode: FollowModeSetting { get }

  • The current follow state if this interface is .active, nil otherwise.

    When the FollowMe mode is active, the drone follows its target (moving the drone and the camera). If the Follow mode prerequisites are not met, the drone may remain stationary (while visually following its target).

    Declaration

    Swift

    var followBehavior: FollowBehavior? { get }

  • Tells why this piloting interface may currently be unavailable.

    Set of reasons that preclude this piloting interface from being available at present.

    Declaration

    Swift

    var availabilityIssues: Set<TrackingIssue> { get }

  • Alert about issues that currently hinders optimal behavior of this interface.

    The returned set may contain values only if the interface is active.

    Declaration

    Swift

    var qualityIssues: Set<TrackingIssue> { get }

  • Sets the current pitch value.

    Expressed as a signed percentage of the max pitch/roll setting (maxPitchRoll), in range [-100, 100].

    • -100 corresponds to a pitch angle of max pitch/roll towards ground (copter will fly forward)

    • 100 corresponds to a pitch angle of max pitch/roll towards sky (copter will fly backward)

    Note

    This value may be clamped if necessary, in order to respect the maximum supported physical tilt of the copter.

    Declaration

    Swift

    func set(pitch: Int)

    Parameters

    pitch

    the new pitch value to set

  • Sets the current roll value.

    Expressed as a signed percentage of the max pitch/roll setting (maxPitchRoll), in range [-100, 100].

    • -100 corresponds to a roll angle of max pitch/roll to the left (copter will fly left)

    • 100 corresponds to a roll angle of max pitch/roll to the right (copter will fly right)

    Note

    This value may be clamped if necessary, in order to respect the maximum supported physical tilt of the copter.

    Declaration

    Swift

    func set(roll: Int)

    Parameters

    roll

    the new roll value to set

  • Sets the current vertical speed value.

    Expressed as a signed percentage of the max vertical speed setting (maxVerticalSpeed), in range [-100, 100].

    • -100 corresponds to max vertical speed towards ground

    • 100 corresponds to max vertical speed towards sky

    Declaration

    Swift

    func set(verticalSpeed: Int)

    Parameters

    verticalSpeed

    the new vertical speed value to set

  • Activates this piloting interface.

    If successful, it deactivates the current piloting interface and activate this one.

    Declaration

    Swift

    func activate() -> Bool

    Return Value

    true on success, false if the piloting interface can’t be activated