docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BaseVisualFactory<T>

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

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    BaseVisualFactory<T>
    DrawingVisualizer<T>
    GuiVisualizer<T>
    HistoryDrawingVisualizer<T>
    ImageDefaultVisualizer
    MarkerDefaultVisualizer
    OccupancyGridDefaultVisualizer
    PrefabVisualizerExample
    TextureVisualizer<T>
    Implements
    IVisualFactory
    IPriority
    Inherited Members
    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 BaseVisualFactory<T> : MonoBehaviour, IVisualFactory, IPriority where T : IMessage
    Type Parameters
    Name Description
    T

    The ROS message type this factory handles.

    Fields

    m_ID

    The scene-persistent unique identifier for this factory instance.

    Declaration
    [SerializeField]
    [HideInInspector]
    protected string m_ID
    Field Value
    Type Description
    string

    m_Topic

    The topic.

    Declaration
    [SerializeField]
    protected string m_Topic
    Field Value
    Type Description
    string

    Properties

    AllVisuals

    Gets all IVisual instances currently managed by this factory.

    Declaration
    public IEnumerable<IVisual> AllVisuals { get; }
    Property Value
    Type Description
    IEnumerable<IVisual>

    CanShowDrawing

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

    Declaration
    public abstract bool CanShowDrawing { get; }
    Property Value
    Type Description
    bool

    Connector

    Gets the IConnector associated with this factory.

    Declaration
    public IConnector Connector { get; }
    Property Value
    Type Description
    IConnector

    ID

    Gets the scene-persistent unique identifier for this factory instance.

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

    Name

    Gets the human-readable display name of this factory.

    Declaration
    public virtual string Name { get; }
    Property Value
    Type Description
    string

    Priority

    Gets or sets the priority of this object. Higher values take precedence over lower values.

    Declaration
    public int Priority { get; set; }
    Property Value
    Type Description
    int

    Topic

    Gets or sets the topic this factory subscribes to. An empty string registers the factory as a type-wide default.

    Declaration
    public string Topic { get; set; }
    Property Value
    Type Description
    string

    Methods

    Awake()

    Finds and caches the IConnector for this GameObject.

    Declaration
    public virtual void Awake()

    CreateVisual(string)

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

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

    ROS topic name.

    Returns
    Type Description
    IVisual

    A new IVisual for the topic.

    GetOrCreateVisual(IConnector, string)

    Returns an existing IVisual for the given topic, or creates one if none exists.

    Declaration
    public virtual IVisual GetOrCreateVisual(IConnector connector, string topic)
    Parameters
    Type Name Description
    IConnector connector

    The connector providing topic subscriptions.

    string topic

    The ROS topic name.

    Returns
    Type Description
    IVisual

    The IVisual instance for the topic.

    ListenForMessages(IConnector, string, Action<IMessage>)

    Subscribes to incoming messages on the specified topic, using the message type's disambiguator to resolve the subscription.

    Declaration
    public static void ListenForMessages(IConnector connector, string topic, Action<IMessage> callback)
    Parameters
    Type Name Description
    IConnector connector

    The connector to subscribe on.

    string topic

    ROS topic name.

    Action<IMessage> callback

    The action invoked when a message arrives.

    Start()

    Registers this factory with VisualFactoryRegistry for the configured topic or message type.

    Declaration
    public virtual void Start()

    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)