/* -------------------------------------------------------------------
    * Java source file for the class SelectableUniverse
    * 
    * Copyright (c), 2003, Masahiro Takatsuka.
    * All Rights Researved.
    * 
    * Original Author: Masahiro Takatsuka (masa@jbeans.net)
    * $Author: takatsukam $
    * 
   * $Date: 2004/03/03 11:53:06 $
   * 
   * $Id: SelectableUniverse.java,v 1.3 2004/03/03 11:53:06 takatsukam Exp $
   * 
   * Reference:		Document no:
   * ___				___
   * 
   * To Do:
   * ___
   * 
  ------------------------------------------------------------------- */
  
  /* --------------------------- Package ---------------------------- */
  package net.jbeans.j3d.universe;
  
  /* ------------------ Import classes (packages) ------------------- *//package-summary/html">class="comment"> ------------------ Import classes (packages) ------------------- *//package-summary.html">class="comment">/* ------------------ Import classes (packages) ------------------- *//package-summary.html">class="comment"> ------------------ Import classes (packages) ------------------- */
  import java.awt.*;
  import java.awt.event.*;
  import java.net.*;
  import java.util.*;
  import javax.media.j3d.*;
  import javax.vecmath.*;
  import javax.swing.event.*;
  import com.sun.j3d.utils.universe.*;
  import com.sun.j3d.utils.picking.*;
  
  import net.jbeans.j3d.util.*;
  import net.jbeans.j3d.util.picking.behavior.*;
  
  import net.jbeans.util.debug.*;
  
  /*====================================================================
                Implementation of class SelectableUniverse              
  ====================================================================*/
  /***
   * This class is basically the same as the SimpleUniverse.  It, however,
   * allows a user to select an object.
   * 
   * @version $Revision: 1.3 $
   * @author Masahiro Takatsuka (masa@jbeans.net)
   * @see Universe
   * @see PickMouseListener
   */
  
  /*
   * this class needs to be public but its constructors can be package.
   */
  public class SelectableUniverse extends Universe implements PickMouseListener {
  	private static final boolean DEBUG = Debug.getDebugFlag(SelectableUniverse.class);
  	
  	/* ------------------------ not serialized ------------------------ */
  	private transient EventListenerList listenerList;
  
  	/* -------------------------- serialized -------------------------- */
  	/***
  	* Node selection behavior
  	*/
  	private PickMouseBehavior pickMouseBehavior;
  	
  	/***
  	* A transform group of viewingplatform
  	*/
  	protected TransformGroup viewingTG;
  
  	/***
  	* A transform group of world
  	*/
  	protected TransformGroup worldTG;
  
  	/***
  	* A current transform group which is the target of for rot/trans/zoom
  	*/
  	protected TransformGroup currentTG;
  
  	/***
  	* A current shape3d object which is the target of for rot/trans/zoom
  	*/
  	private Shape3D currentS3D;
  
  	/***
  	* A current center which is the target of for rot/trans/zoom
  	*/
  	protected Point3d center;
  
  	/***
  	 * A current boundingbox which is the target of for rot/trans/zoom
  	*/
  	private Bounds currentBounds;
  	
  	private Vector4d tmpcenter;
 	
     /***
      * Creates a locale, a single ViewingPlatform, and
      * and a Viewer object (both with their default values).
      *
      * @see Locale
      * @see Viewer
      * @see ViewingPlatform
      */
     SelectableUniverse() {
         this(null, 1, null, null);
     }
 
     /***
      * Creates a locale, a single ViewingPlatform (with default values), and
      * and a Viewer object.  The Viewer object uses default values for
      * everything but the canvas.
      *
      * @param canvas The canvas to associate with the Viewer object.  Passing
      *  in null will cause this parameter to be ignored and a canvas to be
      *  created by the utility.
      *
      * @see Locale
      * @see Viewer
      * @see ViewingPlatform
      */
     SelectableUniverse(Canvas3D canvas) {
         this(null, 1, canvas, null);
     }
 
     /***
      * Creates the "view" side of the scene graph.  The passed in parameters
      * override the default values where appropriate.
      *
      * @param origin The origin used to set the origin of the Locale object.
      *  If this object is null, then 0.0 is used.
      * @param numTransforms The number of transforms to be in the
      *  MultiTransformGroup object.
      * @param canvas The canvas to draw into.  If this is null, it is
      *  ignored and a canvas will be created by the utility.
      * @param userConfig The URL to the user's configuration file, used
      *  by the Viewer object.  Passing in null causes the default values
      *  to be used.
      *
      * @see Locale
      * @see Viewer
      * @see ViewingPlatform
      * @see MultiTransformGroup
      */
     SelectableUniverse(HiResCoord origin, int numTransforms, Canvas3D canvas, URL userConfig) {
 		super(origin, numTransforms, canvas, userConfig);
 		this.center = new Point3d();
     }
 
     /***
      * Creates the "view" side of the scene graph. 
      *
      * @param viewingPlatform The viewingPlatform to use to create
      *  the "view" side of the scene graph.
      * @param viewer The viewer object to use to create
      *  the "view" side of the scene graph.
      */
     SelectableUniverse(ViewingPlatform viewingPlatform, Viewer viewer) {
 		super(viewingPlatform, viewer);
 		this.center = new Point3d();		
     }
 
 	protected void setCenter(Point3d center) {
 		this.center = center;
 	}
 
 	protected Point3d getCenter() {
 		return this.center;
 	}
 	
 	protected World createNewWorld(int numTransformGroup) {
 		World world = super.createNewWorld(numTransformGroup);
 
 		// set transform groups 
 		setupTransformGroups(world);
 			
 		// setup PickMouseBehavior before addign the world to the locale.
 		setupPickMouse(world);
 
 		return world;
 	}
 
 	public void setPickMode(int pickMode) {
 		if (this.pickMouseBehavior != null) {
 			this.pickMouseBehavior.setMode(pickMode);
 		}
 	}
 
 	protected void setupTransformGroups(World world) {
 		// get transform group of viewingplatform
 		this.viewingTG = getViewingPlatform().getViewPlatformTransform();
 		
 		// get transform group of world
 		this.worldTG = world.getWorldTransform();
 
 		// manipulate world TG as a default.
   		this.currentTG = this.worldTG;		
 	}
 	
 	protected void setupPickMouse(World world) {
 		// set up selection behavior
 		Canvas3D canvas3d = getCanvas();
 		this.pickMouseBehavior = new PickMouseBehavior(canvas3d,
 													   world,
 													   J3DUtil.DEFAULT_BOUNDS,
 													   PickTool.GEOMETRY_INTERSECT_INFO);		
 		this.pickMouseBehavior.addPickMouseListener(this);
 		// add the behavior to the scene graph
 		world.addChild(this.pickMouseBehavior);
 	}
 
 	/***
      * Invoked when an object is picked.
 	* <PRE>
 	* </PRE>
 	* 
 	* @param node the picked node
 	* @return void
 	*/
 	/*
 	* @param nodeType is the logical OR of one o or more of:
 	* PickObject.SHAPE3D, PickObject.MORPH, PickObject.PRIMITIVE,
 	* PickObject.LINK, PickObject.GROUP, PickObject.TRANSFORM_GROUP,
 	* PickObject.BRANCH_GROUP, PickObject.SWITCH
 	*/
 	public void picked(PickMouseEvent event) {
 		MouseEvent mevent = event.getMouseEvent();
 		int cond = mevent.getModifiers();		
 		int clickCount = mevent.getClickCount();
 		PickResult pickResult = event.getPickResult();
 		PickIntersection intersection = null;
 		Point3d pickedPoint = null;
 		if (pickResult != null) {
 			intersection = pickResult.getIntersection(0);
 			pickedPoint = intersection.getPointCoordinatesVW();
 		}
 		if (DEBUG) {
 			System.out.println("SelectableUniverse:picked cond = " + cond);
 		}
 		if (((cond & InputEvent.BUTTON1_MASK) != 0) &&
 			(clickCount > 1)) { // left button double clicked
 			if ((cond & Event.CTRL_MASK) != 0) {	// select CENTER !
 				if (pickedPoint != null) {
 					this.center.x = pickedPoint.x;
 					this.center.y = pickedPoint.y;
 					this.center.z = pickedPoint.z;
 					if (DEBUG) {
 						System.out.println("SelectableUniverse:picked center = " + this.center);
 					}
 				} else {		// no intersection.
 					this.center.set(0, 0, 0);
 				}
 			} else {			// select object.
 				if (pickResult != null) {
 					this.currentTG = (TransformGroup) pickResult.getNode(PickResult.TRANSFORM_GROUP);
 					this.currentS3D = (Shape3D) pickResult.getNode(PickResult.SHAPE3D);
 				} else {
 					this.currentTG = null;
 				}
 				if (DEBUG) {
 					System.out.println("SelectableUniverse: target = " + this.currentTG);
 				}
 				if (this.currentTG == null) {
 					if ((cond & Event.SHIFT_MASK) != 0) { // shift key down! == select viewer
 						this.currentTG = this.viewingTG;
 						if (DEBUG) {
 							System.out.println("SelectableUniverse: target = viewer");
 						}
 					} else {
 						this.currentTG = this.worldTG;
 						if (DEBUG) {
 							System.out.println("SelectableUniverse: target = world");
 						}
 					}
 					this.currentS3D = null;
 				}
 				try {
 					if (this.currentS3D != null) {
 						this.currentBounds = this.currentS3D.getBounds();
 					}
 				} catch (CapabilityNotSetException e) {
 					System.out.println("An exception occured, but it's ignored..");
 					e.printStackTrace();
 				}
 			}
 		}
 		firePickedEvent(event);
 	}
 
 	/***
      * Invoked when an object is selected.
 	* <PRE>
 	* </PRE>
 	* 
 	* @param node the selected node
 	* @return void
 	*/
 	/*
 	* @param nodeType is the logical OR of one o or more of:
 	* PickObject.SHAPE3D, PickObject.MORPH, PickObject.PRIMITIVE,
 	* PickObject.LINK, PickObject.GROUP, PickObject.TRANSFORM_GROUP,
 	* PickObject.BRANCH_GROUP, PickObject.SWITCH
 	*/
 	public void selected(PickMouseEvent event) {
 		MouseEvent mevent = event.getMouseEvent();
 		int cond = mevent.getModifiers();		
 		int clickCount = mevent.getClickCount();
 		PickResult pickResult = event.getPickResult();
 		PickIntersection intersection = null;
 		Point3d pickedPoint = null;
 
 		fireSelectedEvent(event);		
 	}
 
 	private void checkListeners() {
 		if (this.listenerList == null) {
 			this.listenerList = new EventListenerList();
 		}
 	}
 	
     /***
      * Adds a PickMouseListener to the slider.
      *
      * @param l the PickMouseListener to add
      */
     public void addPickMouseListener(PickMouseListener l) {
 		checkListeners();
         this.listenerList.add(PickMouseListener.class, l);
     }
 	
     /***
      * Removes a PickMouseListener from the slider.
      *
      * @param l the PickMouseListener to remove
 	 
      */
     public void removePickMouseListener(PickMouseListener l) {
 		checkListeners();
         this.listenerList.remove(PickMouseListener.class, l);
     }
 	
     /***
      * Send the Pick node to listeners.
      */
 	protected void firePickedEvent(PickMouseEvent event) {
 		checkListeners();
         Object[] listeners = this.listenerList.getListenerList();
         for (int i = listeners.length - 2; i >= 0; i -= 2) {
             if (listeners[i] == PickMouseListener.class) {
                 ((PickMouseListener)listeners[i+1]).picked(event);
             }
         }
     }   
 
     /***
      * Send the Selection node to listeners.
      */
 	protected void fireSelectedEvent(PickMouseEvent event) {
 		checkListeners();
         Object[] listeners = this.listenerList.getListenerList();
         for (int i = listeners.length - 2; i >= 0; i -= 2) {
             if (listeners[i] == PickMouseListener.class) {
                 ((PickMouseListener)listeners[i+1]).selected(event);
             }
         }
     }   
 }