Class: InteractiveMarkerHandle

ROS3D. InteractiveMarkerHandle

new InteractiveMarkerHandle(options)

Handle with signals for a single interactive marker.

Emits the following events:

  • 'pose' - emitted when a new pose comes from the server
Parameters:
Name Type Description
options

object with following keys:

  • message - the interactive marker message
  • feedbackTopic - the ROSLIB.Topic associated with the feedback
  • tfClient - a handle to the TF client to use
  • menuFontSize (optional) - the menu font size
Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 20

Methods

emitServerPoseUpdate()

Emit the new pose that has come from the server.

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 53

onButtonClick(event)

Send the button click feedback to the server.

Parameters:
Name Type Description
event

the event associated with the button click

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 112

onMenuSelect(event)

Send the menu select feedback to the server.

Parameters:
Name Type Description
event

the event associated with the menu select

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 145

onMouseDown(event)

Send the mousedown feedback to the server.

Parameters:
Name Type Description
event

the event associated with the mousedown

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 122

onMouseUp(event)

Send the mouseup feedback to the server.

Parameters:
Name Type Description
event

the event associated with the mouseup

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 132

sendFeedback(eventType, clickPosition, menuEntryID, controlName)

Send feedback to the interactive marker server.

Parameters:
Name Type Description
eventType

the type of event that happened

clickPosition

(optional) - the position in ROS space the click happened

menuEntryID

(optional) - the menu entry ID that is associated

controlName

the name of the control

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 157

setPoseFromClient(event)

Set the pose from the client based on the given event.

Parameters:
Name Type Description
event

the event to base the change off of

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 84

setPoseFromServer(poseMsg)

Update the pose based on the pose given by the server.

Parameters:
Name Type Description
poseMsg

the pose given by the server

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 64

subscribeTf()

Subscribe to the TF associated with this interactive marker.

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 43

tfUpdate(transformMsg)

Update the pose based on the TF given by the server.

Parameters:
Name Type Description
transformMsg

the TF given by the server

Source:
  • interactivemarkers/InteractiveMarkerHandle.js, line 74