foxglove.CylinderPrimitive

A primitive representing a cylinder, elliptic cylinder, or truncated cone

RoboticsObservabilityVisualizationData PlatformPhysical AIAutonomyFleet ManagementDeveloper ToolsMCAPROS

Properties

Name	Type	Description
pose	object	Position of the center of the cylinder and orientation of the cylinder. The flat face(s) are perpendicular to the z-axis.
size	object	Size of the cylinder's bounding box
bottom_scale	number	0-1, ratio of the diameter of the cylinder's bottom face (min z) to the bottom of the bounding box
top_scale	number	0-1, ratio of the diameter of the cylinder's top face (max z) to the top of the bounding box
color	object	Color of the cylinder

View JSON Schema on GitHub

JSON Schema

{
  "title": "foxglove.CylinderPrimitive",
  "description": "A primitive representing a cylinder, elliptic cylinder, or truncated cone",
  "$comment": "Generated by https://github.com/foxglove/foxglove-sdk",
  "type": "object",
  "properties": {
    "pose": {
      "title": "foxglove.Pose",
      "description": "Position of the center of the cylinder and orientation of the cylinder. The flat face(s) are perpendicular to the z-axis.",
      "type": "object",
      "properties": {
        "position": {
          "title": "foxglove.Vector3",
          "description": "Point denoting position in 3D space",
          "type": "object",
          "properties": {
            "x": {
              "type": "number",
              "description": "x component"
            },
            "y": {
              "type": "number",
              "description": "y component"
            },
            "z": {
              "type": "number",
              "description": "z component"
            }
          },
          "required": [
            "x",
            "y",
            "z"
          ]
        },
        "orientation": {
          "title": "foxglove.Quaternion",
          "description": "Quaternion denoting orientation in 3D space",
          "type": "object",
          "properties": {
            "x": {
              "type": "number",
              "description": "x value"
            },
            "y": {
              "type": "number",
              "description": "y value"
            },
            "z": {
              "type": "number",
              "description": "z value"
            },
            "w": {
              "type": "number",
              "description": "w value"
            }
          },
          "required": [
            "x",
            "y",
            "z",
            "w"
          ]
        }
      },
      "required": [
        "position",
        "orientation"
      ]
    },
    "size": {
      "title": "foxglove.Vector3",
      "description": "Size of the cylinder's bounding box",
      "type": "object",
      "properties": {
        "x": {
          "type": "number",
          "description": "x component"
        },
        "y": {
          "type": "number",
          "description": "y component"
        },
        "z": {
          "type": "number",
          "description": "z component"
        }
      },
      "required": [
        "x",
        "y",
        "z"
      ]
    },
    "bottom_scale": {
      "type": "number",
      "description": "0-1, ratio of the diameter of the cylinder's bottom face (min z) to the bottom of the bounding box"
    },
    "top_scale": {
      "type": "number",
      "description": "0-1, ratio of the diameter of the cylinder's top face (max z) to the top of the bounding box"
    },
    "color": {
      "title": "foxglove.Color",
      "description": "Color of the cylinder",
      "type": "object",
      "properties": {
        "r": {
          "type": "number",
          "description": "Red value between 0 and 1"
        },
        "g": {
          "type": "number",
          "description": "Green value between 0 and 1"
        },
        "b": {
          "type": "number",
          "description": "Blue value between 0 and 1"
        },
        "a": {
          "type": "number",
          "description": "Alpha value between 0 and 1"
        }
      },
      "required": [
        "r",
        "g",
        "b",
        "a"
      ]
    }
  },
  "required": [
    "pose",
    "size",
    "bottom_scale",
    "top_scale",
    "color"
  ]
}