Class MagneticFieldDefaultVisualizer
Default visualizer for sensor_msgs/MagneticField messages. Draws the magnetic field vector as an arrow with optional TF frame tracking.
Inheritance
MagneticFieldDefaultVisualizer
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: Global Namespace
Assembly: Unity.SimulationPro.Foundation.Visualizations.dll
Syntax
public class MagneticFieldDefaultVisualizer : DrawingVisualizer<MagneticFieldMsg>, IVisualFactory, IPriority
Methods
CreateGUI(MagneticFieldMsg, MessageMetadata)
Creates a GUI callback that renders an Inspector panel for the message data.
Declaration
public override Action CreateGUI(MagneticFieldMsg message, MessageMetadata meta)
Parameters
| Type | Name | Description |
|---|---|---|
| MagneticFieldMsg | message | The message data to visualize. |
| MessageMetadata | meta | Metadata about the received message (topic, timestamp, frame). |
Returns
| Type | Description |
|---|---|
| Action | An action that draws the GUI. |
Overrides
Draw(Drawing3d, MagneticFieldMsg, MessageMetadata)
Draws a 3D visualization of the message data.
Declaration
public override void Draw(Drawing3d drawing, MagneticFieldMsg message, MessageMetadata meta)
Parameters
| Type | Name | Description |
|---|---|---|
| Drawing3d | drawing | The 3D drawing context to render into. |
| MagneticFieldMsg | message | The message data to visualize. |
| MessageMetadata | meta | Metadata about the received message (topic, timestamp, frame). |
Overrides
Draw<C>(MagneticFieldMsg, Drawing3d, Color, float)
Draws the magnetic field vector as an arrow scaled by lengthScale.
Declaration
public static void Draw<C>(MagneticFieldMsg message, Drawing3d drawing, Color color, float lengthScale = 1) where C : ICoordinateSpace, new()
Parameters
| Type | Name | Description |
|---|---|---|
| MagneticFieldMsg | message | The message data to visualize. |
| Drawing3d | drawing | The Drawing3d to draw into. |
| Color | color | RGBA color. |
| float | lengthScale | Multiplier applied to the field vector length. |
Type Parameters
| Name | Description |
|---|---|
| C | The coordinate space of the message data. |