docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class InteractiveMarkerUpdateMsg

    ROS visualization_msgs/InteractiveMarkerUpdate message.

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

    Constructors

    InteractiveMarkerUpdateMsg()

    Initializes a new instance with default values.

    Declaration
    public InteractiveMarkerUpdateMsg()

    InteractiveMarkerUpdateMsg(string, ulong, byte, InteractiveMarkerMsg[], InteractiveMarkerPoseMsg[], string[])

    Initializes a new instance with default values.

    Declaration
    public InteractiveMarkerUpdateMsg(string server_id, ulong seq_num, byte type, InteractiveMarkerMsg[] markers, InteractiveMarkerPoseMsg[] poses, string[] erases)
    Parameters
    Type Name Description
    string server_id

    Unique identifier of the interactive marker server.

    ulong seq_num

    Sequence number for interactive marker updates.

    byte type

    Integer type code specifying the variant or category.

    InteractiveMarkerMsg[] markers

    Array of visualization markers.

    InteractiveMarkerPoseMsg[] poses

    Array of poses.

    string[] erases

    Array of marker names to remove.

    Fields

    KEEP_ALIVE

    Type holds the purpose of this message. It must be one of UPDATE or KEEP_ALIVE. UPDATE: Incremental update to previous state. The sequence number must be 1 higher than for the previous update. KEEP_ALIVE: Indicates the that the server is still living. The sequence number does not increase. No payload data should be filled out (markers, poses, or erases).

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

    UPDATE

    Constant value for UPDATE.

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

    erases

    Names of markers to be erased

    Declaration
    public string[] erases
    Field Value
    Type Description
    string[]

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

    markers

    Note: No guarantees on the order of processing. Contents must be kept consistent by sender. Markers to be added or updated

    Declaration
    public InteractiveMarkerMsg[] markers
    Field Value
    Type Description
    InteractiveMarkerMsg[]

    poses

    Poses of markers that should be moved

    Declaration
    public InteractiveMarkerPoseMsg[] poses
    Field Value
    Type Description
    InteractiveMarkerPoseMsg[]

    seq_num

    Sequence number. The client will use this to detect if it has missed an update.

    Declaration
    public ulong seq_num
    Field Value
    Type Description
    ulong

    server_id

    Identifying string. Must be unique in the topic namespace that this server works on.

    Declaration
    public string server_id
    Field Value
    Type Description
    string

    type

    Type field.

    Declaration
    public byte type
    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 InteractiveMarkerUpdateMsg from the given deserializer.

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

    The deserializer.

    Returns
    Type Description
    InteractiveMarkerUpdateMsg

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