docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class InteractiveMarkerFeedbackMsg

    ROS visualization_msgs/InteractiveMarkerFeedback message.

    Inheritance
    object
    InteractiveMarkerFeedbackMsg
    Implements
    IMessage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.SimulationPro.Foundation.Visualization
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class InteractiveMarkerFeedbackMsg : IMessage

    Constructors

    InteractiveMarkerFeedbackMsg()

    Initializes a new instance with default values.

    Declaration
    public InteractiveMarkerFeedbackMsg()

    InteractiveMarkerFeedbackMsg(HeaderMsg, string, string, string, byte, PoseMsg, uint, PointMsg, bool)

    Initializes a new instance with default values.

    Declaration
    public InteractiveMarkerFeedbackMsg(HeaderMsg header, string client_id, string marker_name, string control_name, byte event_type, PoseMsg pose, uint menu_entry_id, PointMsg mouse_point, bool mouse_point_valid)
    Parameters
    Type Name Description
    HeaderMsg header

    ROS message header containing timestamp and coordinate frame identifier.

    string client_id

    Identifier of the client that triggered the interaction.

    string marker_name

    Name of the target interactive marker.

    string control_name

    Name of this interactive marker control.

    byte event_type

    Integer code for the type of interaction event.

    PoseMsg pose

    Position and orientation in 3D space.

    uint menu_entry_id

    Identifier of the selected menu entry.

    PointMsg mouse_point

    3D point under the mouse cursor.

    bool mouse_point_valid

    Whether the mouse point was successfully computed.

    Fields

    BUTTON_CLICK

    Constant value for BUTTON_CLICK.

    Declaration
    public const byte BUTTON_CLICK = 3
    Field Value
    Type Description
    byte

    KEEP_ALIVE

    Type of the event KEEP_ALIVE: sent while dragging to keep up control of the marker MENU_SELECT: a menu entry has been selected BUTTON_CLICK: a button control has been clicked POSE_UPDATE: the pose has been changed using one of the controls

    Declaration
    public const byte KEEP_ALIVE = 0
    Field Value
    Type Description
    byte

    MENU_SELECT

    Constant value for MENU_SELECT.

    Declaration
    public const byte MENU_SELECT = 2
    Field Value
    Type Description
    byte

    MOUSE_DOWN

    Constant value for MOUSE_DOWN.

    Declaration
    public const byte MOUSE_DOWN = 4
    Field Value
    Type Description
    byte

    MOUSE_UP

    Constant value for MOUSE_UP.

    Declaration
    public const byte MOUSE_UP = 5
    Field Value
    Type Description
    byte

    POSE_UPDATE

    Constant value for POSE_UPDATE.

    Declaration
    public const byte POSE_UPDATE = 1
    Field Value
    Type Description
    byte

    client_id

    Identifying string. Must be unique in the topic namespace.

    Declaration
    public string client_id
    Field Value
    Type Description
    string

    control_name

    Control name field.

    Declaration
    public string control_name
    Field Value
    Type Description
    string

    event_type

    Event type field.

    Declaration
    public byte event_type
    Field Value
    Type Description
    byte

    header

    Time/frame info.

    Declaration
    public HeaderMsg header
    Field Value
    Type Description
    HeaderMsg

    k_MessageTypeId

    Identifier for this message type.

    Declaration
    public static readonly MessageTypeId k_MessageTypeId
    Field Value
    Type Description
    MessageTypeId

    k_MessageTypeName

    The ROS message type name string used for serialization and topic matching.

    Declaration
    public const string k_MessageTypeName = "visualization_msgs/InteractiveMarkerFeedback"
    Field Value
    Type Description
    string

    marker_name

    Feedback message sent back from the GUI, e.g. when the status of an interactive marker was modified by the user. Specifies which interactive marker and control this message refers to

    Declaration
    public string marker_name
    Field Value
    Type Description
    string

    menu_entry_id

    Contains the ID of the selected menu entry Only valid for MENU_SELECT events.

    Declaration
    public uint menu_entry_id
    Field Value
    Type Description
    uint

    mouse_point

    If event_type is BUTTON_CLICK, MOUSE_DOWN, or MOUSE_UP, mouse_point may contain the 3 dimensional position of the event on the control. If it does, mouse_point_valid will be true. mouse_point will be relative to the frame listed in the header.

    Declaration
    public PointMsg mouse_point
    Field Value
    Type Description
    PointMsg

    mouse_point_valid

    Mouse point valid field.

    Declaration
    public bool mouse_point_valid
    Field Value
    Type Description
    bool

    pose

    Current pose of the marker Note: Has to be valid for all feedback types.

    Declaration
    public PoseMsg pose
    Field Value
    Type Description
    PoseMsg

    Properties

    MessageTypeId

    Gets the unique runtime identifier for this message type.

    Declaration
    public MessageTypeId MessageTypeId { get; }
    Property Value
    Type Description
    MessageTypeId

    MessageTypeName

    Gets the ROS message type name for this message.

    Declaration
    public string MessageTypeName { get; }
    Property Value
    Type Description
    string

    Methods

    Deserialize(IMessageDeserializer)

    Deserializes a InteractiveMarkerFeedbackMsg from the given deserializer.

    Declaration
    public static InteractiveMarkerFeedbackMsg Deserialize(IMessageDeserializer deserializer)
    Parameters
    Type Name Description
    IMessageDeserializer deserializer

    The deserializer.

    Returns
    Type Description
    InteractiveMarkerFeedbackMsg

    A new InteractiveMarkerFeedbackMsg instance.

    Register()

    Registers this message type with the MessageTypeRegistry.

    Declaration
    [InitializeOnLoadMethod]
    public static void Register()

    ToString()

    Returns a human-readable string representation of this message.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of this instance.

    Overrides
    object.ToString()

    WriteTo(IMessageSerializer)

    Serializes this message to the given serializer.

    Declaration
    public void WriteTo(IMessageSerializer serializer)
    Parameters
    Type Name Description
    IMessageSerializer serializer

    The serializer.

    Implements

    IMessage
    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)