Class Index | File Index

Classes


Class ROS3D.InteractiveMarkerHandle


Defined in: InteractiveMarkerHandle.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Handle with signals for a single interactive marker.
Method Summary
Method Attributes Method Name and Description
 
Emit the new pose that has come from the server.
 
Send the button click feedback to the server.
 
onMenuSelect(event)
Send the menu select feedback to the server.
 
onMouseDown(event)
Send the mousedown feedback to the server.
 
onMouseUp(event)
Send the mouseup feedback to the server.
 
sendFeedback(eventType, clickPosition, menuEntryID, controlName)
Send feedback to the interactive marker server.
 
Set the pose from the client based on the given event.
 
Update the pose based on the pose given by the server.
 
Subscribe to the TF associated with this interactive marker.
 
tfUpdate(transformMsg)
Update the pose based on the TF given by the server.
Class Detail
ROS3D.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:
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
Method Detail
emitServerPoseUpdate()
Emit the new pose that has come from the server.

onButtonClick(event)
Send the button click feedback to the server.
Parameters:
event
- the event associated with the button click

onMenuSelect(event)
Send the menu select feedback to the server.
Parameters:
event
- the event associated with the menu select

onMouseDown(event)
Send the mousedown feedback to the server.
Parameters:
event
- the event associated with the mousedown

onMouseUp(event)
Send the mouseup feedback to the server.
Parameters:
event
- the event associated with the mouseup

sendFeedback(eventType, clickPosition, menuEntryID, controlName)
Send feedback to the interactive marker server.
Parameters:
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

setPoseFromClient(event)
Set the pose from the client based on the given event.
Parameters:
event
- the event to base the change off of

setPoseFromServer(poseMsg)
Update the pose based on the pose given by the server.
Parameters:
poseMsg
- the pose given by the server

subscribeTf()
Subscribe to the TF associated with this interactive marker.

tfUpdate(transformMsg)
Update the pose based on the TF given by the server.
Parameters:
transformMsg
- the TF given by the server

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Apr 03 2013 18:15:58 GMT-0700 (PDT)