Class GuiVisualizer<T>
Abstract base class for visualizers that only display 2D GUI output and do not produce 3D drawings.
Inherited Members
Object.GetEntityId()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: Unity.SimulationPro.Foundation.Visualizations
Assembly: Unity.SimulationPro.Foundation.Visualizations.dll
Syntax
public abstract class GuiVisualizer<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
Methods
CreateGUI(T, MessageMetadata)
Returns an Action that renders the 2D GUI panel 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. |