Viam SDK
    Preparing search index...

    Class Transform

    Transform contains a pose and two reference frames. The first reference frame is the starting reference frame, and the second reference frame is the observer reference frame. The second reference frame has a pose which represents the pose of an object in the first reference frame as observed within the second reference frame.

    from message viam.common.v1.Transform

    Hierarchy

    Index

    Constructors

    Properties

    metadata?: Struct

    Can hold information like color, opacity, points colors, collision_allowed, etc...

    from field: optional google.protobuf.Struct metadata = 5;

    physicalObject?: commonApi.Geometry

    from field: optional viam.common.v1.Geometry physical_object = 3;

    poseInObserverFrame?: commonApi.PoseInFrame

    the pose of the above reference frame with respect to a different observer reference frame

    from field: viam.common.v1.PoseInFrame pose_in_observer_frame = 2;

    referenceFrame: string

    the name of a given reference frame

    from field: string reference_frame = 1;

    uuid: Uint8Array

    The UUID of the transform

    from field: bytes uuid = 4;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.common.v1.Transform"

    Methods

    • 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<commonApi.Transform>

    • 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 commonApi.Transform

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns commonApi.Transform