Class PlaneDefaultVisualizer
Default visualizer for shape_msgs/Plane messages. Draws a finite quad representing the plane, centered at the closest point on the plane to a configurable origin.
Inheritance
Inherited Members
Namespace: Global Namespace
Assembly: Unity.SimulationPro.Foundation.Visualizations.dll
Syntax
public class PlaneDefaultVisualizer : DrawingVisualizer<PlaneMsg>, IVisualFactory, IPriority
Methods
CreateGUI(PlaneMsg, MessageMetadata)
Creates a GUI callback that renders an Inspector panel for the message data.
Declaration
public override Action CreateGUI(PlaneMsg message, MessageMetadata meta)
Parameters
| Type | Name | Description |
|---|---|---|
| PlaneMsg | 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, PlaneMsg, MessageMetadata)
Draws a 3D visualization of the message data.
Declaration
public override void Draw(Drawing3d drawing, PlaneMsg message, MessageMetadata meta)
Parameters
| Type | Name | Description |
|---|---|---|
| Drawing3d | drawing | The 3D drawing context to render into. |
| PlaneMsg | message | The message data to visualize. |
| MessageMetadata | meta | Metadata about the received message (topic, timestamp, frame). |
Overrides
Draw<C>(PlaneMsg, Drawing3d, Color, GameObject, float)
Draws the plane as a finite quad centered at the closest point on the plane to the given center object.
Declaration
public static void Draw<C>(PlaneMsg message, Drawing3d drawing, Color color, GameObject center = null, float size = 10) where C : ICoordinateSpace, new()
Parameters
| Type | Name | Description |
|---|---|---|
| PlaneMsg | message | The message data to visualize. |
| Drawing3d | drawing | The Drawing3d to draw into. |
| Color | color | RGBA color. |
| GameObject | center | Optional |
| float | size | Half the side length of the quad in world units. |
Type Parameters
| Name | Description |
|---|---|
| C | The coordinate space of the plane coefficient data. |
Draw<C>(PlaneMsg, Drawing3d, Color, Vector3, float)
Draws the plane as a finite quad centered at the closest point on the plane to the given origin position.
Declaration
public static void Draw<C>(PlaneMsg message, Drawing3d drawing, Color color, Vector3 origin, float size = 10) where C : ICoordinateSpace, new()
Parameters
| Type | Name | Description |
|---|---|---|
| PlaneMsg | message | The message data to visualize. |
| Drawing3d | drawing | The Drawing3d to draw into. |
| Color | color | RGBA color. |
| Vector3 | origin | The world-space reference point used to determine the center of the drawn quad. |
| float | size | Half the side length of the quad in world units. |
Type Parameters
| Name | Description |
|---|---|
| C | The coordinate space of the plane coefficient data. |