Package com.viam.common.v1

Interface Common.TransformOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Common.Transform, Common.Transform.Builder
Enclosing class:
Common
public static interface Common.TransformOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Struct
    getMetadata()
    Can hold information like color, opacity, points colors, collision_allowed, etc...
    Common.Geometry
    getPhysicalObject()
    optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
    Common.PoseInFrame
    getPoseInObserverFrame()
    the pose of the above reference frame with respect to a different observer reference frame
    String
    getReferenceFrame()
    the name of a given reference frame
    com.google.protobuf.ByteString
    getReferenceFrameBytes()
    the name of a given reference frame
    com.google.protobuf.ByteString
    getUuid()
    The UUID of the transform
    boolean
    hasMetadata()
    Can hold information like color, opacity, points colors, collision_allowed, etc...
    boolean
    hasPhysicalObject()
    optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
    boolean
    hasPoseInObserverFrame()
    the pose of the above reference frame with respect to a different observer reference frame

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getReferenceFrame

      String getReferenceFrame()
       the name of a given reference frame
      string reference_frame = 1 [json_name = "referenceFrame"];
      Returns:
      The referenceFrame.

    • getReferenceFrameBytes

      com.google.protobuf.ByteString getReferenceFrameBytes()
       the name of a given reference frame
      string reference_frame = 1 [json_name = "referenceFrame"];
      Returns:
      The bytes for referenceFrame.

    • hasPoseInObserverFrame

      boolean hasPoseInObserverFrame()
       the pose of the above reference frame with respect to a different observer reference frame
      .viam.common.v1.PoseInFrame pose_in_observer_frame = 2 [json_name = "poseInObserverFrame"];
      Returns:
      Whether the poseInObserverFrame field is set.

    • getPoseInObserverFrame

      Common.PoseInFrame getPoseInObserverFrame()
       the pose of the above reference frame with respect to a different observer reference frame
      .viam.common.v1.PoseInFrame pose_in_observer_frame = 2 [json_name = "poseInObserverFrame"];
      Returns:
      The poseInObserverFrame.

    • hasPhysicalObject

      boolean hasPhysicalObject()
      optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
      Returns:
      Whether the physicalObject field is set.

    • getPhysicalObject

      Common.Geometry getPhysicalObject()
      optional .viam.common.v1.Geometry physical_object = 3 [json_name = "physicalObject"];
      Returns:
      The physicalObject.

    • getUuid

      com.google.protobuf.ByteString getUuid()
       The UUID of the transform
      bytes uuid = 4 [json_name = "uuid"];
      Returns:
      The uuid.

    • hasMetadata

      boolean hasMetadata()
       Can hold information like color, opacity, points colors, collision_allowed, etc...
      optional .google.protobuf.Struct metadata = 5 [json_name = "metadata"];
      Returns:
      Whether the metadata field is set.

    • getMetadata

      com.google.protobuf.Struct getMetadata()
       Can hold information like color, opacity, points colors, collision_allowed, etc...
      optional .google.protobuf.Struct metadata = 5 [json_name = "metadata"];
      Returns:
      The metadata.