Class VisualizerSettingsGeneric<T>
Abstract ScriptableObject base class for visualizer settings that control how a typed ROS message is drawn and displayed.
Inherited Members
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 |
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. |