docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class WrenchDefaultVisualizer

    Default visualizer for geometry_msgs/Wrench messages. Draws a force arrow and a torque ring at a configurable origin.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    BaseVisualFactory<WrenchMsg>
    DrawingVisualizer<WrenchMsg>
    WrenchDefaultVisualizer
    Implements
    IVisualFactory
    IPriority
    Inherited Members
    DrawingVisualizer<WrenchMsg>.CanShowDrawing
    DrawingVisualizer<WrenchMsg>.CreateVisual(string)
    DrawingVisualizer<WrenchMsg>.SelectColor(Color, MessageMetadata)
    DrawingVisualizer<WrenchMsg>.SelectLabel(string, MessageMetadata)
    DrawingVisualizer<WrenchMsg>.Draw(DrawingVisualizer<WrenchMsg>.DrawingVisual, WrenchMsg, MessageMetadata)
    BaseVisualFactory<WrenchMsg>.m_Topic
    BaseVisualFactory<WrenchMsg>.Topic
    BaseVisualFactory<WrenchMsg>.m_ID
    BaseVisualFactory<WrenchMsg>.ID
    BaseVisualFactory<WrenchMsg>.Name
    BaseVisualFactory<WrenchMsg>.Priority
    BaseVisualFactory<WrenchMsg>.AllVisuals
    BaseVisualFactory<WrenchMsg>.GetOrCreateVisual(IConnector, string)
    BaseVisualFactory<WrenchMsg>.Connector
    BaseVisualFactory<WrenchMsg>.Awake()
    BaseVisualFactory<WrenchMsg>.Start()
    BaseVisualFactory<WrenchMsg>.ListenForMessages(IConnector, string, Action<IMessage>)
    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 class WrenchDefaultVisualizer : DrawingVisualizer<WrenchMsg>, IVisualFactory, IPriority

    Fields

    lengthScale

    The lengthScale.

    Declaration
    public float lengthScale
    Field Value
    Type Description
    float

    origin

    Optional GameObject whose world position serves as the drawing origin; if null, the world origin is used.

    Declaration
    public GameObject origin
    Field Value
    Type Description
    GameObject

    sphereRadius

    The sphereRadius.

    Declaration
    public float sphereRadius
    Field Value
    Type Description
    float

    thickness

    Line thickness in world units for drawing vectors and arcs.

    Declaration
    public float thickness
    Field Value
    Type Description
    float

    Methods

    CreateGUI(WrenchMsg, MessageMetadata)

    Creates a GUI callback that renders an Inspector panel for the message data.

    Declaration
    public override Action CreateGUI(WrenchMsg message, MessageMetadata meta)
    Parameters
    Type Name Description
    WrenchMsg 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
    DrawingVisualizer<WrenchMsg>.CreateGUI(WrenchMsg, MessageMetadata)

    Draw(Drawing3d, WrenchMsg, MessageMetadata)

    Draws a 3D visualization of the message data.

    Declaration
    public override void Draw(Drawing3d drawing, WrenchMsg message, MessageMetadata meta)
    Parameters
    Type Name Description
    Drawing3d drawing

    The 3D drawing context to render into.

    WrenchMsg message

    The message data to visualize.

    MessageMetadata meta

    Metadata about the received message (topic, timestamp, frame).

    Overrides
    DrawingVisualizer<WrenchMsg>.Draw(Drawing3d, WrenchMsg, MessageMetadata)

    Draw<C>(WrenchMsg, Drawing3d, Color, Vector3, float, float, float)

    Draws a force arrow and a torque ring for the given WrenchMsg using the specified coordinate space.

    Declaration
    public static void Draw<C>(WrenchMsg message, Drawing3d drawing, Color color, Vector3 origin, float lengthScale = 1, float sphereRadius = 1, float thickness = 0.01) where C : ICoordinateSpace, new()
    Parameters
    Type Name Description
    WrenchMsg message

    The message data to visualize.

    Drawing3d drawing

    The Drawing3d to draw into.

    Color color

    RGBA color.

    Vector3 origin

    The world-space position at which to draw.

    float lengthScale

    Multiplier applied to the force vector length.

    float sphereRadius

    Radius of the torque ring in world units.

    float thickness

    Line thickness in world units.

    Type Parameters
    Name Description
    C

    The coordinate space of the message data.

    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)