Class: InteractiveMarker

ROS3D. InteractiveMarker

new InteractiveMarker(options)

The main interactive marker object.

Parameters:
Name Type Description
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
  • loader (optional) - the Collada loader to use (e.g., an instance of ROS3D.COLLADA_LOADER ROS3D.COLLADA_LOADER_2) -- defaults to ROS3D.COLLADA_LOADER_2
Source:
  • interactivemarkers/InteractiveMarker.js, line 17

Methods

buttonClick(control, event3d)

Handle a button click.

Parameters:
Name Type Description
control

the control to use

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 256

dispose()

Free memory of elements in this marker.

Source:
  • interactivemarkers/InteractiveMarker.js, line 312

feedbackEvent(type, control)

Dispatch the given event type.

Parameters:
Name Type Description
type

the type of event

control

the control to use

Source:
  • interactivemarkers/InteractiveMarker.js, line 201

moveAxis(control, origAxis, event3d)

Move the axis based on the given event information.

Parameters:
Name Type Description
control

the control to use

origAxis

the origin of the axis

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 90

movePlane(control, origNormal, event3d)

Move with respect to the plane based on the contorl and event.

Parameters:
Name Type Description
control

the control to use

origNormal

the normal of the origin

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 120

onServerSetPose(event)

Update the marker based when the pose is set from the server.

Parameters:
Name Type Description
event

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 289

rotateAxis(control, origOrientation, event3d)

Rotate based on the control and event given.

Parameters:
Name Type Description
control

the control to use

origOrientation

the orientation of the origin

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 147

setOrientation(control, event3d)

Handle a user pose change for the orientation.

Parameters:
Name Type Description
control

the control to use

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 278

setPosition(control, event3d)

Handle a user pose change for the position.

Parameters:
Name Type Description
control

the control to use

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 267

showMenu(control, event)

Show the interactive marker menu associated with this marker.

Parameters:
Name Type Description
control

the control to use

event

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 77

startDrag(control, event3d)

Start a drag action.

Parameters:
Name Type Description
control

the control to use

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 216

stopDrag(control, event3d)

Stop a drag action.

Parameters:
Name Type Description
control

the control to use

event3d

the event that caused this

Source:
  • interactivemarkers/InteractiveMarker.js, line 238