docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class VisualizerSettingsGeneric<T>

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

    Inheritance
    object
    Object
    ScriptableObject
    VisualizerSettingsGeneric<T>
    LaserScanVisualizerSettings
    MultiEchoLaserScanVisualizerSettings
    PointCloudVisualizerSettings
    PointCloud2VisualizerSettings
    Inherited Members
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    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 class VisualizerSettingsGeneric<T> : ScriptableObject where T : IMessage
    Type Parameters
    Name Description
    T

    The ROS message type these settings apply to.

    Fields

    m_TFTrackingSettings

    The tftracking settings.

    Declaration
    [SerializeField]
    protected TFTrackingSettings m_TFTrackingSettings
    Field Value
    Type Description
    TFTrackingSettings

    Properties

    MessageTypeName

    Gets the ROS message type name string for the configured message type.

    Declaration
    public string MessageTypeName { get; }
    Property Value
    Type Description
    string

    TFTrackingSettings

    Gets or sets the TF tracking settings that control how the drawing is positioned relative to the ROS transform hierarchy.

    Declaration
    public TFTrackingSettings TFTrackingSettings { get; set; }
    Property Value
    Type Description
    TFTrackingSettings

    Methods

    CreateGUI(T, MessageMetadata)

    Returns an Action that renders the 2D GUI for the given message. Returns null by default; override to provide custom GUI.

    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, or null.

    Draw(Drawing3d, T, MessageMetadata, Transform)

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

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

    The 3D drawing canvas.

    T message

    The message data to visualize.

    MessageMetadata meta

    Contextual metadata about the message.

    Transform visualizerTransform

    The transform of the visualizer component, used when tracking mode is RelativeToVisualizer.

    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)