Class Index | File Index

Classes


Class ROS3D.OrbitControls


Defined in: OrbitControls.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ROS3D.OrbitControls(scene, camera, userZoomSpeed, userRotateSpeed, autoRotate, autoRotate)
Behaves like THREE.OrbitControls, but uses right-handed coordinates and z as up vector.
Method Summary
Method Attributes Method Name and Description
<inner>  
onMouseDown(event3D)
Handle the mousedown 3D event.
<inner>  
onMouseMove(event3D)
Handle the movemove 3D event.
<inner>  
onMouseUp(event3D)
Handle the mouseup 3D event.
<inner>  
onMouseWheel(event3D)
Handle the mousewheel 3D event.
<inner>  
onTouchDown(event3D)
Handle the touchdown 3D event.
<inner>  
onTouchMove(event3D)
Handle the touchmove 3D event.
 
rotateDown(angle)
Rotate the camera down by the given angle.
 
rotateLeft(angle)
Rotate the camera to the left by the given angle.
 
rotateRight(angle)
Rotate the camera to the right by the given angle.
 
rotateUp(angle)
Rotate the camera up by the given angle.
 
Display the main axes for 1 second.
 
Update the camera to the current settings.
 
zoomIn(zoomScale)
Zoom in by the given scale.
 
zoomOut(zoomScale)
Zoom out by the given scale.
Class Detail
ROS3D.OrbitControls(scene, camera, userZoomSpeed, userRotateSpeed, autoRotate, autoRotate)
Behaves like THREE.OrbitControls, but uses right-handed coordinates and z as up vector.
Parameters:
scene
- the global scene to use
camera
- the camera to use
userZoomSpeed
(optional) - the speed for zooming
userRotateSpeed
(optional) - the speed for rotating
autoRotate
(optional) - if the orbit should auto rotate
autoRotate
(optional) - the speed for auto rotating
Method Detail
<inner> onMouseDown(event3D)
Handle the mousedown 3D event.
Parameters:
event3D
- the 3D event to handle

<inner> onMouseMove(event3D)
Handle the movemove 3D event.
Parameters:
event3D
- the 3D event to handle

<inner> onMouseUp(event3D)
Handle the mouseup 3D event.
Parameters:
event3D
- the 3D event to handle

<inner> onMouseWheel(event3D)
Handle the mousewheel 3D event.
Parameters:
event3D
- the 3D event to handle

<inner> onTouchDown(event3D)
Handle the touchdown 3D event.
Parameters:
event3D
- the 3D event to handle

<inner> onTouchMove(event3D)
Handle the touchmove 3D event.
Parameters:
event3D
- the 3D event to handle

rotateDown(angle)
Rotate the camera down by the given angle.
Parameters:
angle
(optional) - the angle to rotate by

rotateLeft(angle)
Rotate the camera to the left by the given angle.
Parameters:
angle
(optional) - the angle to rotate by

rotateRight(angle)
Rotate the camera to the right by the given angle.
Parameters:
angle
(optional) - the angle to rotate by

rotateUp(angle)
Rotate the camera up by the given angle.
Parameters:
angle
(optional) - the angle to rotate by

showAxes()
Display the main axes for 1 second.

update()
Update the camera to the current settings.

zoomIn(zoomScale)
Zoom in by the given scale.
Parameters:
zoomScale
(optional) - the scale to zoom in by

zoomOut(zoomScale)
Zoom out by the given scale.
Parameters:
zoomScale
(optional) - the scale to zoom in by

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