Viam SDK
    Preparing search index...

    Class LinkPose

    LinkPose is a translation in mm and an orientation in degrees, identity when absent

    from message viam.common.v1.LinkPose

    Hierarchy

    Index
    • Parameters

      Returns LinkPose

    orientation:
        | { case: "quaternion"; value: Quaternion }
        | { case: "orientationVector"; value: commonApi.Orientation }
        | { case: "eulerAngles"; value: EulerAngles }
        | { case: "axisAngles"; value: AxisAngles }
        | { case: undefined; value?: undefined }

    Type Declaration

    • { case: "quaternion"; value: Quaternion }
      • case: "quaternion"
      • value: Quaternion

        from field: viam.common.v1.Quaternion quaternion = 2;

    • { case: "orientationVector"; value: commonApi.Orientation }
      • case: "orientationVector"
      • value: commonApi.Orientation

        theta in degrees

        from field: viam.common.v1.Orientation orientation_vector = 3;

    • { case: "eulerAngles"; value: EulerAngles }
      • case: "eulerAngles"
      • value: EulerAngles

        from field: viam.common.v1.EulerAngles euler_angles = 4;

    • { case: "axisAngles"; value: AxisAngles }
      • case: "axisAngles"
      • value: AxisAngles

        from field: viam.common.v1.AxisAngles axis_angles = 5;

    • { case: undefined; value?: undefined }

    from oneof viam.common.v1.LinkPose.orientation

    translation?: commonApi.Vector3

    from field: viam.common.v1.Vector3 translation = 1;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.common.v1.LinkPose"
    • Create a deep copy.

      Returns LinkPose

    • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

      Parameters

      Returns boolean

    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<LinkPose>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns LinkPose

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns LinkPose