Class InteractiveMarkerMsg
ROS visualization_msgs/InteractiveMarker message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.Visualization
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class InteractiveMarkerMsg : IMessage
Constructors
InteractiveMarkerMsg()
Initializes a new instance with default values.
Declaration
public InteractiveMarkerMsg()
InteractiveMarkerMsg(HeaderMsg, PoseMsg, string, string, float, MenuEntryMsg[], InteractiveMarkerControlMsg[])
Initializes a new instance with default values.
Declaration
public InteractiveMarkerMsg(HeaderMsg header, PoseMsg pose, string name, string description, float scale, MenuEntryMsg[] menu_entries, InteractiveMarkerControlMsg[] controls)
Parameters
| Type | Name | Description |
|---|---|---|
| HeaderMsg | header | ROS message header containing timestamp and coordinate frame identifier. |
| PoseMsg | pose | Position and orientation in 3D space. |
| string | name | Identifying name or label. |
| string | description | Human-readable description. |
| float | scale | Scale factor along each axis. |
| MenuEntryMsg[] | menu_entries | Array of context menu entries. |
| InteractiveMarkerControlMsg[] | controls | Array of interactive marker controls. |
Fields
controls
List of controls displayed for this marker.
Declaration
public InteractiveMarkerControlMsg[] controls
Field Value
| Type | Description |
|---|---|
| InteractiveMarkerControlMsg[] |
description
Short description (< 40 characters).
Declaration
public string description
Field Value
| Type | Description |
|---|---|
| string |
header
Time/frame info. If header.time is set to 0, the marker will be retransformed into its frame on each timestep. You will receive the pose feedback in the same frame. Otherwise, you might receive feedback in a different frame. For rviz, this will be the current 'fixed frame' set by the user.
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/InteractiveMarker"
Field Value
| Type | Description |
|---|---|
| string |
menu_entries
All menu and submenu entries associated with this marker.
Declaration
public MenuEntryMsg[] menu_entries
Field Value
| Type | Description |
|---|---|
| MenuEntryMsg[] |
name
Identifying string. Must be globally unique in the topic that this message is sent through.
Declaration
public string name
Field Value
| Type | Description |
|---|---|
| string |
pose
Initial pose. Also, defines the pivot point for rotations.
Declaration
public PoseMsg pose
Field Value
| Type | Description |
|---|---|
| PoseMsg |
scale
Scale to be used for default controls (default=1).
Declaration
public float scale
Field Value
| Type | Description |
|---|---|
| float |
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 InteractiveMarkerMsg from the given deserializer.
Declaration
public static InteractiveMarkerMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| InteractiveMarkerMsg | A new InteractiveMarkerMsg 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
WriteTo(IMessageSerializer)
Serializes this message to the given serializer.
Declaration
public void WriteTo(IMessageSerializer serializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageSerializer | serializer | The serializer. |