Class Index | File Index

Classes


Class ROS3D.MouseHandler


Defined in: MouseHandler.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
A handler for mouse events within a 3D viewer.
Method Summary
Method Attributes Method Name and Description
 
Destroy this mouse handler and its associated listeners.
 
notify(target, type, event3D)
Notify the listener of the type of event that occurred.
 
processDomEvent(domEvent)
Process the particular DOM even that has occurred based on the mouse's position in the scene.
Class Detail
ROS3D.MouseHandler(options)
A handler for mouse events within a 3D viewer.
Parameters:
options
- object with following keys: * renderer - the main renderer * camera - the main camera in the scene * rootObject - the root object to check for mouse events * fallbackTarget - the fallback target, e.g., the camera controls
Method Detail
destroy()
Destroy this mouse handler and its associated listeners.

notify(target, type, event3D)
Notify the listener of the type of event that occurred.
Parameters:
target
- the target of the event
type
- the type of event that occurred
event3D
- the 3D mouse even information
Returns:
if an event was canceled

processDomEvent(domEvent)
Process the particular DOM even that has occurred based on the mouse's position in the scene.
Parameters:
domEvent
- the DOM event to process

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