docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class DrawingVisualizerWithSettings<TMessage, TDrawingSettings>

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

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    BaseVisualFactory<TMessage>
    DrawingVisualizer<TMessage>
    DrawingVisualizerWithSettings<TMessage, TDrawingSettings>
    LaserScanDefaultVisualizer
    MultiEchoLaserScanDefaultVisualizer
    PointCloud2DefaultVisualizer
    PointCloudDefaultVisualizer
    Implements
    IVisualFactory
    IPriority
    Inherited Members
    DrawingVisualizer<TMessage>.CanShowDrawing
    DrawingVisualizer<TMessage>.CreateVisual(string)
    DrawingVisualizer<TMessage>.SelectColor(Color, MessageMetadata)
    DrawingVisualizer<TMessage>.SelectLabel(string, MessageMetadata)
    DrawingVisualizer<TMessage>.Draw(DrawingVisualizer<TMessage>.DrawingVisual, TMessage, MessageMetadata)
    BaseVisualFactory<TMessage>.m_Topic
    BaseVisualFactory<TMessage>.Topic
    BaseVisualFactory<TMessage>.m_ID
    BaseVisualFactory<TMessage>.ID
    BaseVisualFactory<TMessage>.Priority
    BaseVisualFactory<TMessage>.AllVisuals
    BaseVisualFactory<TMessage>.GetOrCreateVisual(IConnector, string)
    BaseVisualFactory<TMessage>.Connector
    BaseVisualFactory<TMessage>.Start()
    BaseVisualFactory<TMessage>.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 DrawingVisualizerWithSettings<TMessage, TDrawingSettings> : DrawingVisualizer<TMessage>, IVisualFactory, IPriority where TMessage : IMessage where TDrawingSettings : VisualizerSettingsGeneric<TMessage>
    Type Parameters
    Name Description
    TMessage

    The ROS message type this visualizer subscribes to.

    TDrawingSettings

    The ScriptableObject settings type that controls visualization appearance.

    Fields

    ScriptableObjectsSettingsPath

    Base subdirectory path prefix used when loading settings assets from Resources.

    Declaration
    public const string ScriptableObjectsSettingsPath = "ScriptableObjects/"
    Field Value
    Type Description
    string

    Properties

    DefaultScriptableObjectPath

    Gets the Resources-relative path from which the default settings asset is loaded.

    Declaration
    public abstract string DefaultScriptableObjectPath { get; }
    Property Value
    Type Description
    string

    Name

    The name.

    Declaration
    public override string Name { get; }
    Property Value
    Type Description
    string
    Overrides
    BaseVisualFactory<TMessage>.Name

    Settings

    Gets or sets the settings asset used to configure visualization appearance.

    Declaration
    public TDrawingSettings Settings { get; set; }
    Property Value
    Type Description
    TDrawingSettings

    Methods

    Awake()

    Awake.

    Declaration
    public override void Awake()
    Overrides
    BaseVisualFactory<TMessage>.Awake()

    CreateGUI(TMessage, MessageMetadata)

    Creates a GUI callback that renders an Inspector panel for the specified TMessage data.

    Declaration
    public override Action CreateGUI(TMessage message, MessageMetadata meta)
    Parameters
    Type Name Description
    TMessage message

    The message to render.

    MessageMetadata meta

    Metadata about the message, such as its topic and receive time.

    Returns
    Type Description
    Action

    An action that renders the GUI for the message when invoked.

    Overrides
    DrawingVisualizer<TMessage>.CreateGUI(TMessage, MessageMetadata)

    Draw(Drawing3d, TMessage, MessageMetadata)

    Draws a 3D visualization of the specified TMessage data.

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

    The 3D drawing to render into.

    TMessage message

    The message to visualize.

    MessageMetadata meta

    Metadata about the message, such as its topic and receive time.

    Overrides
    DrawingVisualizer<TMessage>.Draw(Drawing3d, TMessage, MessageMetadata)

    Redraw()

    Forces all managed visuals to redraw, typically called after the settings asset is modified.

    Declaration
    public void Redraw()

    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)