docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class InteractiveMarkerControlMsg

    ROS visualization_msgs/InteractiveMarkerControl message.

    Inheritance
    object
    InteractiveMarkerControlMsg
    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 InteractiveMarkerControlMsg : IMessage

    Constructors

    InteractiveMarkerControlMsg()

    Initializes a new instance with default values.

    Declaration
    public InteractiveMarkerControlMsg()

    InteractiveMarkerControlMsg(string, QuaternionMsg, byte, byte, bool, MarkerMsg[], bool, string)

    Initializes a new instance with default values.

    Declaration
    public InteractiveMarkerControlMsg(string name, QuaternionMsg orientation, byte orientation_mode, byte interaction_mode, bool always_visible, MarkerMsg[] markers, bool independent_marker_orientation, string description)
    Parameters
    Type Name Description
    string name

    Identifying name or label.

    QuaternionMsg orientation

    Orientation expressed as a quaternion.

    byte orientation_mode

    Integer code specifying how orientation behaves during interaction.

    byte interaction_mode

    Integer code specifying the type of user interaction allowed.

    bool always_visible

    The always visible.

    MarkerMsg[] markers

    Array of visualization markers.

    bool independent_marker_orientation

    Whether the marker orientation is independent of the control.

    string description

    Human-readable description.

    Fields

    BUTTON

    Constant value for BUTTON.

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

    FIXED

    Constant value for FIXED.

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

    INHERIT

    Orientation mode: controls how orientation changes. INHERIT: Follow orientation of interactive marker FIXED: Keep orientation fixed at initial state VIEW_FACING: Align y-z plane with screen (x: forward, y:left, z:up).

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

    MENU

    Constant value for MENU.

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

    MOVE_3D

    "3D" interaction modes work with the mouse+SHIFT+CTRL or with 3D cursors. MOVE_3D: Translate freely in 3D space. ROTATE_3D: Rotate freely in 3D space about the origin of parent frame. MOVE_ROTATE_3D: Full 6-DOF freedom of translation and rotation about the cursor origin.

    Declaration
    public const byte MOVE_3D = 7
    Field Value
    Type Description
    byte

    MOVE_AXIS

    Constant value for MOVE_AXIS.

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

    MOVE_PLANE

    Constant value for MOVE_PLANE.

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

    MOVE_ROTATE

    Constant value for MOVE_ROTATE.

    Declaration
    public const byte MOVE_ROTATE = 6
    Field Value
    Type Description
    byte

    MOVE_ROTATE_3D

    Constant value for MOVE_ROTATE_3D.

    Declaration
    public const byte MOVE_ROTATE_3D = 9
    Field Value
    Type Description
    byte

    NONE

    Interaction mode for this control NONE: This control is only meant for visualization; no context menu. MENU: Like NONE, but right-click menu is active. BUTTON: Element can be left-clicked. MOVE_AXIS: Translate along local x-axis. MOVE_PLANE: Translate in local y-z plane. ROTATE_AXIS: Rotate around local x-axis. MOVE_ROTATE: Combines MOVE_PLANE and ROTATE_AXIS.

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

    ROTATE_3D

    Constant value for ROTATE_3D.

    Declaration
    public const byte ROTATE_3D = 8
    Field Value
    Type Description
    byte

    ROTATE_AXIS

    Constant value for ROTATE_AXIS.

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

    VIEW_FACING

    Constant value for VIEW_FACING.

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

    always_visible

    If true, the contained markers will also be visible when the gui is not in interactive mode.

    Declaration
    public bool always_visible
    Field Value
    Type Description
    bool

    description

    Short description (< 40 characters) of what this control does, e.g. "Move the robot". Default: A generic description based on the interaction mode

    Declaration
    public string description
    Field Value
    Type Description
    string

    independent_marker_orientation

    In VIEW_FACING mode, set this to true if you don't want the markers to be aligned with the camera view point. The markers will show up as in INHERIT mode.

    Declaration
    public bool independent_marker_orientation
    Field Value
    Type Description
    bool

    interaction_mode

    Interaction mode field.

    Declaration
    public byte interaction_mode
    Field Value
    Type Description
    byte

    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/InteractiveMarkerControl"
    Field Value
    Type Description
    string

    markers

    Markers to be displayed as custom visual representation. Leave this empty to use the default control handles. Note:

    • The markers can be defined in an arbitrary coordinate frame, but will be transformed into the local frame of the interactive marker.
    • If the header of a marker is empty, its pose will be interpreted as relative to the pose of the parent interactive marker.
    Declaration
    public MarkerMsg[] markers
    Field Value
    Type Description
    MarkerMsg[]

    name

    Represents a control that is to be displayed together with an interactive marker Identifying string for this control. You need to assign a unique value to this to receive feedback from the GUI on what actions the user performs on this control (e.g. a button click).

    Declaration
    public string name
    Field Value
    Type Description
    string

    orientation

    Defines the local coordinate frame (relative to the pose of the parent interactive marker) in which is being rotated and translated. Default: Identity

    Declaration
    public QuaternionMsg orientation
    Field Value
    Type Description
    QuaternionMsg

    orientation_mode

    Orientation mode field.

    Declaration
    public byte orientation_mode
    Field Value
    Type Description
    byte

    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 InteractiveMarkerControlMsg from the given deserializer.

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

    The deserializer.

    Returns
    Type Description
    InteractiveMarkerControlMsg

    A new InteractiveMarkerControlMsg 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)