Class Index | File Index

Classes


Class ROS3D.InteractiveMarker


Defined in: InteractiveMarker.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
The main interactive marker object.
Method Summary
Method Attributes Method Name and Description
 
buttonClick(control, event3d)
Handle a button click.
 
feedbackEvent(type, control)
Dispatch the given event type.
 
moveAxis(control, origAxis, event3d)
Move the axis based on the given event information.
 
movePlane(control, origNormal, event3d)
Move with respect to the plane based on the contorl and event.
 
Update the marker based when the pose is set from the server.
 
rotateAxis(control, origOrientation, event3d)
Rotate based on the control and event given.
 
setOrientation(control, event3d)
Handle a user pose change for the orientation.
 
setPosition(control, event3d)
Handle a user pose change for the position.
 
showMenu(control, event)
Show the interactive marker menu associated with this marker.
 
startDrag(control, event3d)
Start a drag action.
 
stopDrag(control, event3d)
Stop a drag action.
Class Detail
ROS3D.InteractiveMarker(options)
The main interactive marker object.
Parameters:
options
- object with following keys: * handle - the ROS3D.InteractiveMarkerHandle for this marker * camera - the main camera associated with the viewer for this marker * path (optional) - the base path to any meshes that will be loaded
Method Detail
buttonClick(control, event3d)
Handle a button click.
Parameters:
control
- the control to use
event3d
- the event that caused this

feedbackEvent(type, control)
Dispatch the given event type.
Parameters:
type
- the type of event
control
- the control to use

moveAxis(control, origAxis, event3d)
Move the axis based on the given event information.
Parameters:
control
- the control to use
origAxis
- the origin of the axis
event3d
- the event that caused this

movePlane(control, origNormal, event3d)
Move with respect to the plane based on the contorl and event.
Parameters:
control
- the control to use
origNormal
- the normal of the origin
event3d
- the event that caused this

onServerSetPose(event)
Update the marker based when the pose is set from the server.
Parameters:
event
- the event that caused this

rotateAxis(control, origOrientation, event3d)
Rotate based on the control and event given.
Parameters:
control
- the control to use
origOrientation
- the orientation of the origin
event3d
- the event that caused this

setOrientation(control, event3d)
Handle a user pose change for the orientation.
Parameters:
control
- the control to use
event3d
- the event that caused this

setPosition(control, event3d)
Handle a user pose change for the position.
Parameters:
control
- the control to use
event3d
- the event that caused this

showMenu(control, event)
Show the interactive marker menu associated with this marker.
Parameters:
control
- the control to use
event
- the event that caused this

startDrag(control, event3d)
Start a drag action.
Parameters:
control
- the control to use
event3d
- the event that caused this

stopDrag(control, event3d)
Stop a drag action.
Parameters:
control
- the control to use
event3d
- the event that caused this

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