Viam SDK
    Preparing search index...

    Class Geometry

    Geometry contains the dimensions of a given geometry and the pose of its center. The geometry is one of either a sphere or a box.

    from message viam.common.v1.Geometry

    Hierarchy

    Index

    Constructors

    Properties

    center?: commonApi.Pose

    Pose of a geometries center point

    from field: viam.common.v1.Pose center = 1;

    geometryType:
        | { case: "sphere"; value: commonApi.Sphere }
        | { case: "box"; value: commonApi.RectangularPrism }
        | { case: "capsule"; value: commonApi.Capsule }
        | { case: "mesh"; value: Mesh }
        | { case: "pointcloud"; value: commonApi.PointCloud }
        | { case: undefined; value?: undefined }

    Dimensions of a given geometry. This can be one of several types

    Type Declaration

    from oneof viam.common.v1.Geometry.geometry_type

    label: string

    Label of the geometry. If none supplied, will be an empty string.

    from field: string label = 4;

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

    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.Geometry>

    • 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.Geometry

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns commonApi.Geometry