com.parrot.drone.groundsdk.protobuf.AutomationMetadataKt.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of video-metadata Show documentation
video-metadata module is part of Parrot Ground SDK for Android
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: vmeta.proto

// Generated files should ignore deprecation warnings
@file:Suppress("DEPRECATION")
package com.parrot.drone.groundsdk.protobuf;

@kotlin.jvm.JvmName("-initializeautomationMetadata")
public inline fun automationMetadata(block: com.parrot.drone.groundsdk.protobuf.AutomationMetadataKt.Dsl.() -> kotlin.Unit): com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadata =
  com.parrot.drone.groundsdk.protobuf.AutomationMetadataKt.Dsl._create(com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadata.newBuilder()).apply { block() }._build()
/**
 * Protobuf type `vmeta.AutomationMetadata`
 */
public object AutomationMetadataKt {
  @kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
  @com.google.protobuf.kotlin.ProtoDslMarker
  public class Dsl private constructor(
    private val _builder: com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadata.Builder
  ) {
    public companion object {
      @kotlin.jvm.JvmSynthetic
      @kotlin.PublishedApi
      internal fun _create(builder: com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadata.Builder): Dsl = Dsl(builder)
    }

    @kotlin.jvm.JvmSynthetic
    @kotlin.PublishedApi
    internal fun _build(): com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadata = _builder.build()

    /**
     * ```
     * Current destination 
     * ```
     *
     * `.vmeta.Location destination = 1;`
     */
    public var destination: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location
      @JvmName("getDestination")
      get() = _builder.getDestination()
      @JvmName("setDestination")
      set(value) {
        _builder.setDestination(value)
      }
    /**
     * ```
     * Current destination 
     * ```
     *
     * `.vmeta.Location destination = 1;`
     */
    public fun clearDestination() {
      _builder.clearDestination()
    }
    /**
     * ```
     * Current destination 
     * ```
     *
     * `.vmeta.Location destination = 1;`
     * @return Whether the destination field is set.
     */
    public fun hasDestination(): kotlin.Boolean {
      return _builder.hasDestination()
    }

    /**
     * ```
     * Tracking target location 
     * ```
     *
     * `.vmeta.Location target_location = 2;`
     */
    public var targetLocation: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location
      @JvmName("getTargetLocation")
      get() = _builder.getTargetLocation()
      @JvmName("setTargetLocation")
      set(value) {
        _builder.setTargetLocation(value)
      }
    /**
     * ```
     * Tracking target location 
     * ```
     *
     * `.vmeta.Location target_location = 2;`
     */
    public fun clearTargetLocation() {
      _builder.clearTargetLocation()
    }
    /**
     * ```
     * Tracking target location 
     * ```
     *
     * `.vmeta.Location target_location = 2;`
     * @return Whether the targetLocation field is set.
     */
    public fun hasTargetLocation(): kotlin.Boolean {
      return _builder.hasTargetLocation()
    }

    /**
     * ```
     * Follow-me enabled 
     * ```
     *
     * `bool follow_me = 3;`
     */
    public var followMe: kotlin.Boolean
      @JvmName("getFollowMe")
      get() = _builder.getFollowMe()
      @JvmName("setFollowMe")
      set(value) {
        _builder.setFollowMe(value)
      }
    /**
     * ```
     * Follow-me enabled 
     * ```
     *
     * `bool follow_me = 3;`
     */
    public fun clearFollowMe() {
      _builder.clearFollowMe()
    }

    /**
     * ```
     * Look-at-me enabled 
     * ```
     *
     * `bool lookat_me = 4;`
     */
    public var lookatMe: kotlin.Boolean
      @JvmName("getLookatMe")
      get() = _builder.getLookatMe()
      @JvmName("setLookatMe")
      set(value) {
        _builder.setLookatMe(value)
      }
    /**
     * ```
     * Look-at-me enabled 
     * ```
     *
     * `bool lookat_me = 4;`
     */
    public fun clearLookatMe() {
      _builder.clearLookatMe()
    }

    /**
     * ```
     * Angle-locked:
     * false: NED (North-East-Down) absolute angle mode
     * true: constant angle relative to the target movement 
     * ```
     *
     * `bool angle_locked = 5;`
     */
    public var angleLocked: kotlin.Boolean
      @JvmName("getAngleLocked")
      get() = _builder.getAngleLocked()
      @JvmName("setAngleLocked")
      set(value) {
        _builder.setAngleLocked(value)
      }
    /**
     * ```
     * Angle-locked:
     * false: NED (North-East-Down) absolute angle mode
     * true: constant angle relative to the target movement 
     * ```
     *
     * `bool angle_locked = 5;`
     */
    public fun clearAngleLocked() {
      _builder.clearAngleLocked()
    }

    /**
     * ```
     * Current animation 
     * ```
     *
     * `.vmeta.Animation animation = 6;`
     */
    public var animation: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Animation
      @JvmName("getAnimation")
      get() = _builder.getAnimation()
      @JvmName("setAnimation")
      set(value) {
        _builder.setAnimation(value)
      }
    public var animationValue: kotlin.Int
      @JvmName("getAnimationValue")
      get() = _builder.getAnimationValue()
      @JvmName("setAnimationValue")
      set(value) {
        _builder.setAnimationValue(value)
      }
    /**
     * ```
     * Current animation 
     * ```
     *
     * `.vmeta.Animation animation = 6;`
     */
    public fun clearAnimation() {
      _builder.clearAnimation()
    }
  }
}
@kotlin.jvm.JvmSynthetic
public inline fun com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadata.copy(block: com.parrot.drone.groundsdk.protobuf.AutomationMetadataKt.Dsl.() -> kotlin.Unit): com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadata =
  com.parrot.drone.groundsdk.protobuf.AutomationMetadataKt.Dsl._create(this.toBuilder()).apply { block() }._build()

public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadataOrBuilder.destinationOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location?
  get() = if (hasDestination()) getDestination() else null

public val com.parrot.drone.groundsdk.protobuf.VideoMetadata.AutomationMetadataOrBuilder.targetLocationOrNull: com.parrot.drone.groundsdk.protobuf.VideoMetadata.Location?
  get() = if (hasTargetLocation()) getTargetLocation() else null