interactiveMarkerControl QML Value Type

Represents a control that is to be displayed together with an interactive marker. More...

Properties

• alwaysVisible : bool
• description : string
• independentMarkerOrientation : bool
• interactionMode : uint8_t
• markers : list<marker>
• name : string
• orientation : quaternion
• orientationMode : uint8_t

Detailed Description

interactiveMarkerControl is a structured value type usable in QML. It maps directly to the visualization_msgs::msg::InteractiveMarkerControl ROS 2 message type.

Construct a interactiveMarkerControl in QML by assigning a JavaScript object whose keys are its component properties, or by setting those properties individually.

See also InteractiveMarkerControlPublisher and InteractiveMarkerControlSubscriber.

Property Documentation

alwaysVisible : bool

If true, the contained markers will also be visible

when the gui is not in interactive mode.

description : string

Short description (< 40 characters) of what this control does,

e.g. "Move the robot". Default: A generic description based on the interaction mode

independentMarkerOrientation : bool

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.

interactionMode : uint8_t

markers : list<marker>

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.

name : string

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

orientation : quaternion

Defines the local coordinate frame (relative to the pose of the parent

interactive marker) in which is being rotated and translated. Default: Identity

orientationMode : uint8_t