docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Namespace Unity.SimulationPro.Foundation.Visualizations

    Classes

    AccelDefaultVisualizer

    Default visualizer for geometry_msgs/Accel messages. Draws a linear-acceleration arrow and an angular-velocity ring at a configurable origin.

    AccelWithCovarianceStampedDefaultVisualizer

    Default visualizer for geometry_msgs/AccelWithCovarianceStamped messages. Draws a linear-acceleration arrow and an angular-velocity ring with optional TF frame tracking.

    ActivateVisualization

    MonoBehaviour that programmatically enables or disables 2D and 3D visualizations for a configured topic each frame, optionally rendering a fullscreen texture.

    BaseVisualFactory<T>

    Abstract base class for MonoBehaviour-based visual factories that subscribe to a typed ROS message and create IVisual instances per topic.

    BatteryStateDefaultVisualizer

    Default visualizer for sensor_msgs/BatteryState messages. Displays voltage, temperature, charge, and power-supply status in the HUD.

    CameraInfoDefaultVisualizer

    Default visualizer for sensor_msgs/CameraInfo messages. Displays camera intrinsic matrices and, when a region of interest is active, renders a cropped texture from a companion image topic.

    CompressedImageDefaultVisualizer

    Default visualizer for sensor_msgs/CompressedImage messages. Decodes the compressed image data to a Texture2D and displays it in the HUD.

    DiagnosticArrayDefaultVisualizer

    Default visualizer for diagnostic_msgs/DiagnosticArray messages. Displays the header and each diagnostic status entry in the HUD.

    DiagnosticStatusDefaultVisualizer

    Default visualizer for diagnostic_msgs/DiagnosticStatus messages. Displays the component name, hardware ID, status level, and key-value pairs in the HUD.

    DisparityImageDefaultVisualizer

    Default visualizer for stereo_msgs/DisparityImage messages. Renders the disparity image using a dedicated shader that maps disparity values to visible colors.

    Drawing3d

    MonoBehaviour that accumulates 3D geometry (lines, shapes, point clouds, mesh instances, labels) into a single mesh and renders it each frame.

    Drawing3dManager

    Singleton MonoBehaviour that manages all active Drawing3d instances, refreshes dirty drawings each LateUpdate, and renders 3D labels via OnGUI.

    DrawingVisualizerWithSettings<TMessage, TDrawingSettings>

    A DrawingVisualizer<T> that delegates drawing and GUI creation to a configurable VisualizerSettingsGeneric<T> ScriptableObject asset.

    DrawingVisualizer<T>

    Abstract base class for visualizers that render incoming ROS messages as 3D geometry using a Drawing3d canvas.

    DrawingVisualizer<T>.DrawingVisual

    Subscribes to a topic and delegates drawing and GUI to the parent DrawingVisualizer<T>.

    GoalIDDefaultVisualizer

    Default visualizer for actionlib_msgs/GoalID messages. Displays the goal stamp and ID string in the HUD.

    GoalStatusArrayDefaultVisualizer

    Default visualizer for actionlib_msgs/GoalStatusArray messages. Displays the header and each goal status entry in the HUD.

    GoalStatusDefaultVisualizer

    Default visualizer for actionlib_msgs/GoalStatus messages. Displays the goal ID and its human-readable status string in the HUD.

    GridCellsDefaultVisualizer

    Default visualizer for nav_msgs/GridCells messages. Renders each cell as a point in a point cloud.

    GuiVisualizer<T>

    Abstract base class for visualizers that only display 2D GUI output and do not produce 3D drawings.

    GuiVisualizer<T>.GuiVisual

    Subscribes to a topic and delegates GUI rendering to the parent GuiVisualizer<T>.

    HistoryDrawingVisualizer<T>

    Abstract base class for visualizers that maintain a rolling history of received messages and render all of them together in a single 3D drawing pass.

    HistoryDrawingVisualizer<T>.HistoryDrawingVisual

    Maintains a bounded queue of messages and redraws the history each time a new message arrives.

    ImageDefaultVisualizer

    Default visualizer for sensor_msgs/Image messages. Renders raw ROS images in the HUD, supporting BGR conversion, debayering, single-channel gradient mapping, and configurable brightness scaling.

    ImageDefaultVisualizer.ImageVisual

    The ITextureVisual implementation that subscribes to an image topic, lazily converts raw message data to a Texture2D, and notifies registered texture-change listeners.

    ImuDefaultVisualizer

    Default visualizer for sensor_msgs/Imu messages. Draws orientation axes, a linear-acceleration arrow, and an angular-velocity ring.

    InertiaDefaultVisualizer

    Default visualizer for geometry_msgs/Inertia messages. Draws the center-of-mass position as a labeled point.

    InertiaStampedDefaultVisualizer

    Default visualizer for geometry_msgs/InertiaStamped messages. Draws the center-of-mass position as a labeled point with optional TF frame tracking.

    JoyFeedbackDefaultVisualizer

    Default visualizer for sensor_msgs/JoyFeedback messages. Displays the feedback type, ID, and intensity value in the HUD.

    MarkerDefaultVisualizer

    Default visualizer for visualization_msgs/Marker and visualization_msgs/MarkerArray messages. Renders each marker according to its type (arrow, cube, sphere, cylinder, line strip, etc.) into per-namespace Drawing3d instances.

    MarkerDefaultVisualizer.MarkersVisual

    The IVisual implementation that subscribes to both Marker and MarkerArray topics, maintaining per-namespace and per-ID Drawing3d instances and routing add/delete/deleteAll actions.

    NavSatFixDefaultVisualizer

    Default visualizer for sensor_msgs/NavSatFix messages. Displays GPS coordinates, altitude, satellite status, and position covariance in the HUD.

    OccupancyGridDefaultVisualizer

    Default visualizer for nav_msgs/OccupancyGrid messages. Renders the grid as a textured mesh scaled to the grid's resolution and origin pose.

    OccupancyGridDefaultVisualizer.OccupancyGridVisual

    The IVisual implementation used by OccupancyGridDefaultVisualizer. Subscribes to the topic, maintains a Texture2D from the raw grid data, and draws a textured quad via a Drawing3d.

    OdometryDefaultVisualizer

    Default visualizer for nav_msgs/Odometry messages. Draws coordinate axes for the pose and velocity arrows for the twist.

    PathDefaultVisualizer

    Default visualizer for nav_msgs/Path messages. Draws the path as a connected line strip through all pose positions.

    Point32DefaultVisualizer

    Default visualizer for geometry_msgs/Point32 messages. Draws a point at the position with an optional label.

    PointCloud2VisualizerSettings

    ScriptableObject settings for the PointCloud2 visualizer. Configures which message fields map to XYZ position, color channels, and point size, as well as the color mode used to compute per-point colors.

    PointCloudDrawing

    MonoBehaviour that renders a billboard-quad point cloud by accumulating per-point geometry into a single Mesh and uploading it each frame.

    PointDefaultVisualizer

    Default visualizer for geometry_msgs/Point messages. Draws a point at the message position with an optional label.

    PointFieldDefaultVisualizer

    Default visualizer for sensor_msgs/PointField messages. Displays the field name, offset, data type, and count in the HUD.

    PointStampedDefaultVisualizer

    Default visualizer for geometry_msgs/PointStamped messages. Draws a point with an optional label and TF frame tracking.

    PointTracingVisualizerExample

    Example custom visualizer for geometry_msgs/Point messages that draws a traced path through all received point positions.

    PolygonDefaultVisualizer

    Default visualizer for geometry_msgs/Polygon messages. Draws the polygon outline as a closed line strip.

    PolygonStampedDefaultVisualizer

    Default visualizer for geometry_msgs/PolygonStamped messages. Draws the polygon outline as a closed line strip with optional TF frame tracking.

    PoseArrayDefaultVisualizer

    Default visualizer for geometry_msgs/PoseArray messages. Draws coordinate-axis vectors for every pose in the array.

    PoseDefaultVisualizer

    Default visualizer for geometry_msgs/Pose messages. Draws coordinate-axis vectors at the pose position and orientation.

    PoseStampedDefaultVisualizer

    Default visualizer for geometry_msgs/PoseStamped messages. Draws coordinate-axis vectors at the pose position with optional TF frame tracking.

    PoseWithCovarianceDefaultVisualizer

    Default visualizer for geometry_msgs/PoseWithCovariance messages. Draws coordinate-axis vectors at the pose position.

    PoseWithCovarianceStampedDefaultVisualizer

    Default visualizer for geometry_msgs/PoseWithCovarianceStamped messages. Draws coordinate-axis vectors at the pose position with optional TF frame tracking.

    PrefabVisualizerExample

    Example custom visualizer for geometry_msgs/Pose messages. Instantiates a user-configured prefab at each incoming pose position and orientation.

    PrioritySetter

    MonoBehaviour that propagates a configured priority value to all IPriority components found on this GameObject and its children during Awake.

    QuaternionDefaultVisualizer

    Default visualizer for geometry_msgs/Quaternion messages. Draws coordinate-axis vectors representing the orientation at a configurable position.

    QuaternionStampedDefaultVisualizer

    Default visualizer for geometry_msgs/QuaternionStamped messages. Draws orientation axes and an optional label, with TF frame tracking support.

    TFSystemVisualizer

    MonoBehaviour and IHudTab that visualizes the ROS transform tree by drawing coordinate axes, parent-child link lines, and frame-name labels for each TFStream, and exposes per-frame visibility toggles in the "Transforms" HUD tab.

    TFTrackingSettings

    Combines a TFTrackingType mode with an optional override TFSystemComponent to use instead of the scene's default TF system.

    TextureVisualizer<T>

    Abstract base class for visualizers that convert incoming ROS messages into a Texture2D for 2D display.

    TextureVisualizer<T>.TextureVisual

    Subscribes to a topic, caches generated textures, and notifies registered listeners when the texture changes.

    TimeReferenceDefaultVisualizer

    Default visualizer for sensor_msgs/TimeReference messages. Displays the reference timestamp and its source identifier in the HUD.

    TransformDefaultVisualizer

    Default visualizer for geometry_msgs/Transform messages. Draws coordinate-axis vectors at the transform translation with an optional label.

    TransformStampedDefaultVisualizer

    Default visualizer for geometry_msgs/TransformStamped messages. Draws coordinate-axis vectors at the transform translation with optional TF tracking and a label.

    TwistDefaultVisualizer

    Default visualizer for geometry_msgs/Twist messages. Draws a linear-velocity arrow and an angular-velocity ring at a configurable origin.

    TwistStampedDefaultVisualizer

    Default visualizer for geometry_msgs/TwistStamped messages. Draws linear and angular velocity vectors at a configurable origin, with optional TF frame tracking.

    TwistWithCovarianceDefaultVisualizer

    Default visualizer for geometry_msgs/TwistWithCovariance messages. Draws linear and angular velocity vectors at a configurable origin.

    TwistWithCovarianceStampedDefaultVisualizer

    Default visualizer for geometry_msgs/TwistWithCovarianceStamped messages. Draws linear and angular velocity vectors at a configurable origin with optional TF frame tracking.

    Vector3DefaultVisualizer

    Default visualizer for geometry_msgs/Vector3 messages. Draws a point at the vector position with an optional label.

    Vector3StampedDefaultVisualizer

    Default visualizer for geometry_msgs/Vector3Stamped messages. Draws a point with an optional label and TF frame tracking.

    VisualFactoryRegistry

    Global registry that maps ROS topics and message types to their highest-priority IVisualFactory per IConnector.

    VisualizationLayoutTab

    Implements the "Layout" tab in the ConnectorHud, providing Import and Export buttons for saving and loading visualization layout JSON files.

    VisualizationTopicsTab

    MonoBehaviour that manages the "Topics" tab in the ConnectorHud, listing all known ROS topics and allowing the user to toggle 2D and 3D visualizations.

    VisualizationTopicsTabEntry

    Represents a single row in the VisualizationTopicsTab, tracking whether 2D and 3D visualizations are active and managing the associated HUD window.

    VisualizationTopicsTabEntry.SaveState

    Serializable snapshot of the visualization state for a single topic, used when saving and loading layout files.

    VisualizationUtils

    Static utility methods and extension methods used across visualizer implementations for color selection, drawing, GUI layout, and TF tracking.

    VisualizerSettingsGeneric<T>

    Abstract ScriptableObject base class for visualizer settings that control how a typed ROS message is drawn and displayed.

    WrenchDefaultVisualizer

    Default visualizer for geometry_msgs/Wrench messages. Draws a force arrow and a torque ring at a configurable origin.

    WrenchStampedDefaultVisualizer

    Default visualizer for geometry_msgs/WrenchStamped messages. Draws force and torque vectors at a configurable origin with optional TF frame tracking.

    Structs

    MessageMetadata

    Carries contextual information about a received message, including the topic it arrived on and the time of receipt.

    Interfaces

    ITextureVisual

    Extends IVisual with the ability to expose a Texture2D representation of the visualized message.

    IVisual

    Represents a visualization that can display 3D drawings and 2D GUI content for a subscribed topic.

    IVisualFactory

    Creates and manages IVisual instances for topics, and can be registered in VisualFactoryRegistry.

    Enums

    PointCloud2VisualizerSettings.ColorMode

    Specifies how per-point colors are derived from message channel data.

    TFTrackingType

    Controls how a Drawing3d is positioned in the scene relative to the ROS TF hierarchy.

    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)