docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DrawingVisualizer<T>

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

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    BaseVisualFactory<T>
    DrawingVisualizer<T>
    AccelStampedDefaultVisualizer
    AccelWithCovarianceDefaultVisualizer
    JointStateDefaultVisualizer
    JointTrajectoryDefaultVisualizer
    MagneticFieldDefaultVisualizer
    MeshDefaultVisualizer
    MultiDOFJointStateDefaultVisualizer
    PlaneDefaultVisualizer
    PointVisualizerExample
    RangeDefaultVisualizer
    SolidPrimitiveDefaultVisualizer
    AccelDefaultVisualizer
    AccelWithCovarianceStampedDefaultVisualizer
    DrawingVisualizerWithSettings<TMessage, TDrawingSettings>
    GridCellsDefaultVisualizer
    ImuDefaultVisualizer
    InertiaDefaultVisualizer
    InertiaStampedDefaultVisualizer
    OdometryDefaultVisualizer
    PathDefaultVisualizer
    Point32DefaultVisualizer
    PointDefaultVisualizer
    PointFieldDefaultVisualizer
    PointStampedDefaultVisualizer
    PolygonDefaultVisualizer
    PolygonStampedDefaultVisualizer
    PoseArrayDefaultVisualizer
    PoseDefaultVisualizer
    PoseStampedDefaultVisualizer
    PoseWithCovarianceDefaultVisualizer
    PoseWithCovarianceStampedDefaultVisualizer
    QuaternionDefaultVisualizer
    QuaternionStampedDefaultVisualizer
    TransformDefaultVisualizer
    TransformStampedDefaultVisualizer
    TwistDefaultVisualizer
    TwistStampedDefaultVisualizer
    TwistWithCovarianceDefaultVisualizer
    TwistWithCovarianceStampedDefaultVisualizer
    Vector3DefaultVisualizer
    Vector3StampedDefaultVisualizer
    WrenchDefaultVisualizer
    WrenchStampedDefaultVisualizer
    Implements
    IVisualFactory
    IPriority
    Inherited Members
    BaseVisualFactory<T>.m_Topic
    BaseVisualFactory<T>.Topic
    BaseVisualFactory<T>.m_ID
    BaseVisualFactory<T>.ID
    BaseVisualFactory<T>.Name
    BaseVisualFactory<T>.Priority
    BaseVisualFactory<T>.AllVisuals
    BaseVisualFactory<T>.GetOrCreateVisual(IConnector, string)
    BaseVisualFactory<T>.Connector
    BaseVisualFactory<T>.Awake()
    BaseVisualFactory<T>.Start()
    BaseVisualFactory<T>.ListenForMessages(IConnector, string, Action<IMessage>)
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.destroyCancellationToken
    MonoBehaviour.useGUILayout
    MonoBehaviour.didStart
    MonoBehaviour.didAwake
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.GetComponentIndex()
    Component.CompareTag(string)
    Component.CompareTag(TagHandle)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.transformHandle
    Component.gameObject
    Component.tag
    Object.GetEntityId()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.SimulationPro.Foundation.Visualizations
    Assembly: Unity.SimulationPro.Foundation.Visualizations.dll
    Syntax
    public abstract class DrawingVisualizer<T> : BaseVisualFactory<T>, IVisualFactory, IPriority where T : IMessage
    Type Parameters
    Name Description
    T

    The ROS message type this visualizer subscribes to.

    Properties

    CanShowDrawing

    Gets a value indicating whether this factory produces visuals that support 3D drawing output.

    Declaration
    public override bool CanShowDrawing { get; }
    Property Value
    Type Description
    bool
    Overrides
    BaseVisualFactory<T>.CanShowDrawing

    Methods

    CreateGUI(T, MessageMetadata)

    Returns an Action that renders the 2D GUI for the given message. By default displays a string representation of the message.

    Declaration
    public virtual Action CreateGUI(T message, MessageMetadata meta)
    Parameters
    Type Name Description
    T message

    The message data to visualize.

    MessageMetadata meta

    Contextual metadata about the message.

    Returns
    Type Description
    Action

    A GUI rendering action.

    CreateVisual(string)

    Creates a new IVisual instance for the given topic. Called the first time a topic is encountered.

    Declaration
    protected override IVisual CreateVisual(string topic)
    Parameters
    Type Name Description
    string topic

    ROS topic name.

    Returns
    Type Description
    IVisual

    A new IVisual for the topic.

    Overrides
    BaseVisualFactory<T>.CreateVisual(string)

    Draw(Drawing3d, T, MessageMetadata)

    Override this method to render message data into the provided Drawing3d canvas.

    Declaration
    public virtual void Draw(Drawing3d drawing, T message, MessageMetadata meta)
    Parameters
    Type Name Description
    Drawing3d drawing

    The 3D drawing canvas.

    T message

    The message data to visualize.

    MessageMetadata meta

    Contextual metadata about the message.

    Draw(DrawingVisual, T, MessageMetadata)

    Called to render a message into the DrawingVisualizer<T>.DrawingVisual. Delegates to Draw(Drawing3d, T, MessageMetadata) by default.

    Declaration
    public virtual void Draw(DrawingVisualizer<T>.DrawingVisual drawing, T message, MessageMetadata meta)
    Parameters
    Type Name Description
    DrawingVisualizer<T>.DrawingVisual drawing

    The drawing visual providing the Drawing3d canvas.

    T message

    The message data to visualize.

    MessageMetadata meta

    Contextual metadata about the message.

    SelectColor(Color, MessageMetadata)

    Returns userColor if it is non-zero and non-transparent; otherwise returns a color derived from the topic name.

    Declaration
    public Color SelectColor(Color userColor, MessageMetadata meta)
    Parameters
    Type Name Description
    Color userColor

    The user-configured color.

    MessageMetadata meta

    Metadata providing the topic name used for automatic color selection.

    Returns
    Type Description
    Color

    The resolved color.

    SelectLabel(string, MessageMetadata)

    Returns userLabel if non-empty; otherwise returns the topic name from meta.

    Declaration
    public string SelectLabel(string userLabel, MessageMetadata meta)
    Parameters
    Type Name Description
    string userLabel

    The user-configured label.

    MessageMetadata meta

    Metadata providing the topic name used as the fallback label.

    Returns
    Type Description
    string

    The resolved label string.

    Implements

    IVisualFactory
    IPriority
    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)