1 /*
  2   Copyright (c) 2008 Seneca College
  3   Licenced under the MIT License (http://www.c3dl.org/index.php/mit-license/)
  4 */
  5 
  6 
  7 /**
  8 	@class c3dl.PickingResult is contains the result of the user picking something
  9 	in the scene. This object is created within the library and sent to the picking
 10 	callback function. You can query things such as which objects were picked, which 
 11 	canvas and which button was used for the pick.
 12 */
 13 c3dl.PickingResult = function()
 14 {
 15 	// NOTE
 16 	// These functions are empty because we only want jsdoc toolkit creating the doc
 17 	// files.  Within the picking code, we create an instance of this class and override
 18 	// these functions. This is done because adding functions such as setButtonUsed, setObjectsHit, etc
 19 	// which the picking code can call allows other code to call those methods as well.
 20 	
 21 	/**
 22 		Get the mouse button that was used for the pick.
 23 		
 24 		@returns {int} the mouse button used for the pick.
 25 	*/
 26 	this.getButtonUsed = function(){}
 27 
 28 	/**
 29 		Get the canvas the user clicked on.
 30 		
 31 		@returns {HTMLComponent} the canvas the user clicked on.
 32 	*/
 33 	this.getCanvas = function(){}
 34 	
 35 	/**
 36 		Get the list of objects which were picked. This list contains points,
 37 		lines and collada objects.
 38 
 39 		@returns {Array} References to objects which have been picked.
 40 	*/
 41 	this.getObjects = function(){}
 42 }
 43