/* -------------------------------------------------------------------
    * Java source file for the class Universe
    * 
    * 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: Universe.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.net.*;
  import java.util.*;
  import javax.media.j3d.*;
  
  /*====================================================================
                     Implementation of class Universe                   
  ====================================================================*/
  /***
   * This class is basically the same as the SimpleUniverse.  It, however, uses
   * Locale to view and edit the SceneGraph nodes.
   * 
   * @version $Revision: 1.3 $
   * @author Masahiro Takatsuka (masa@jbeans.net)
   * @see VirtualUniverse
   */
  
  /*
   * this class needs to be public, but its constructors can be package.
   */
  public class Universe extends VirtualUniverse {
      /***
       * Locale reference needed to create the "view" portion
       * of the scene graph.
       */
      private Locale locale;
  
      /***
       * Viewer reference needed to create the "view" portion
       * of the scene graph.
       */
  	private com.sun.j3d.utils.universe.Viewer viewer;
  
  	/***
  	* An array of viewers
  	*/
      private java.util.List viewers;
  
      /***
       * ViewingPlatform reference needed to create the "view" portion
       * of the scene graph.
       */
  	private ViewingPlatform viewingPlatform;
  
  	/***
  	 * An array of viewers
  	 */
      private java.util.List viewingPlatforms;
  
  	/***
  	 * World
  	 */
  	private World world;
  
  	private int initialNumChild;
  
      /***
       * Creates a locale, a single ViewingPlatform, and
       * and a Viewer object (both with their default values).
       *
       * @see Locale
       * @see Viewer
       * @see ViewingPlatform
       */
      Universe() {
          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
      */
     Universe(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
      */
     Universe(HiResCoord origin, int numTransforms, Canvas3D canvas, URL userConfig) {
         // See if the HiResCoord was given
         if (origin == null) {
             this.locale = new Locale(this);
 		} else {
             this.locale = new Locale(this, origin);
 		}
 
 		setViewingPlatformAndViewer(new ViewingPlatform(numTransforms),
 									new Viewer(canvas, userConfig));
 		// setup world BG and TG
 		setupWorld();
     }
 
     /***
      * 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.
      */
     Universe(ViewingPlatform viewingPlatform, com.sun.j3d.utils.universe.Viewer viewer) {
         this.locale = new Locale(this);
 
 		setViewingPlatformAndViewer(viewingPlatform, viewer);
 
 		// setup world BG and TG
 		setupWorld();
     }
 
 	private final void setViewingPlatformAndViewer(ViewingPlatform viewingPlatform, com.sun.j3d.utils.universe.Viewer viewer) {
 		// Create the arrays of Viewer and ViewingPlatform
 		if (this.viewingPlatforms == null) {
 			this.viewingPlatforms = Collections.synchronizedList(new ArrayList());
 		}
 		if (this.viewers == null) {
 			this.viewers = Collections.synchronizedList(new ArrayList());
 		}
 
         // Create the ViewingPlatform and Viewer objects, passing
         // down the appropriate parameters.
         this.viewingPlatform = viewingPlatform;
         this.viewingPlatforms.add(this.viewingPlatform);
 		this.viewer = viewer;
         this.viewers.add(this.viewer);
 
         // Add the ViewingPlatform to the Viewer object.
         this.viewer.setViewingPlatform(this.viewingPlatform);
         this.viewingPlatform.setViewer(this.viewer);
 		this.locale.setView(this.viewer.getView());
 
 		TransformGroup tg = this.viewingPlatform.getViewPlatformTransform();
 		tg.setCapability(Node.ALLOW_LOCAL_TO_VWORLD_READ);
 
         // Add the ViewingPlatform to the locale - the scene
         // graph is now "live".
         this.locale.addBranchGraph(this.viewingPlatform);
 	}
 
 	protected World createNewWorld(int numTransformGroup) {
 		World world = new World(numTransformGroup);
 		TransformGroup tg = world.getWorldTransform();
 		tg.setCapability(Node.ALLOW_LOCAL_TO_VWORLD_READ);
 
 		return world;
 	}
 
 	public final void setWorld(World world) {
 		if (this.world != null) {
 			this.world.detach();
 		}
 		this.world = world;
 		this.locale.addBranchGraph(this.world);
 	}
 
 	public int getNumOfChildren() {
 		return this.world.getWorldTransform().numChildren();
 	}
 	
 	public final void setInitialNumChildren() {
 		this.initialNumChild = this.world.getWorldTransform().numChildren();
 	}
 
 	protected final int getInitialNumChild() {
 		return this.initialNumChild;
 	}
 
 	private final void setupWorld() {
 		World world = createNewWorld(1);
 		setWorld(world);
 	}
 
 	/***
      * Returns the Locale object associated with this scene graph.
      *
      * @return The Locale object used in the construction of this scene
      *  graph.
      */
     public final javax.media.j3d.Locale getLocale() {
         return this.locale;
     }
 
     /***
      * Returns the Viewer object associated with this scene graph.
      * SimpleUniverse creates a single Viewer object for use in the
      * scene graph.
      *
      * @return The Viewer object associated with this scene graph.
      */
     public final com.sun.j3d.utils.universe.Viewer getViewer() {
         return this.viewer;
     }
 
     /***
      * Returns the Viewer object associated with this scene graph.
      * SimpleUniverse creates a single Viewer object for use in the
      * scene graph.
      *
      * @return The Viewer object associated with this scene graph.
      */
     public final com.sun.j3d.utils.universe.Viewer getViewer(int index) {
         return (com.sun.j3d.utils.universe.Viewer) this.viewers.get(index);
 	}
 
 	/***
 	* adds a viewer to the specified viewingPlatform.
 	*/
 	private final void addViewer(ViewingPlatform platform, com.sun.j3d.utils.universe.Viewer viewer) {
         // Create the Viewer objects, passing
         // down the appropriate parameters.
 		this.viewer = viewer;
         this.viewers.add(this.viewer);
 
         // Add the ViewingPlatform to the Viewer object.
         this.viewer.setViewingPlatform(platform);
 		this.locale.setView(this.viewer.getView());
 
 	}
 	public final void addViewer(com.sun.j3d.utils.universe.Viewer viewer) {
 		addViewer(this.viewingPlatform, viewer);
 	}
 
 	/***
 	* adds a viewer to the specified viewingPlatform.
 	*/
 	public final void addViewer(int index, com.sun.j3d.utils.universe.Viewer viewer) {
         // Create the Viewer objects, passing
         // down the appropriate parameters.
 		ViewingPlatform vp = (ViewingPlatform) this.viewingPlatforms.get(index);
 		if (vp != null) {
 			addViewer(vp, viewer);
 		}
 	}
 
 	/***
 	 * removes the specified viewer.
 	 */
 	public final void removeViewer(com.sun.j3d.utils.universe.Viewer viewer) {
 		if ((this.viewers.size() == 1) || // don't let the last one remove.
 			(!this.viewers.contains(viewer))) {
 			return;
 		}
 		if (this.viewer == viewer) {
 			com.sun.j3d.utils.universe.Viewer newViewer = (Viewer) this.viewers.get(0);
 			this.viewer = newViewer;
 		}
 		if (viewer instanceof Viewer) {
 			com.sun.j3d.utils.universe.ViewingPlatform platform = ((Viewer) viewer).getViewingPlatform();
 			if (platform instanceof ViewingPlatform) {
 				((ViewingPlatform) platform).removeViewer(viewer);
 			}
 		}
 		this.viewers.remove(viewer);
 	}
 
     /***
      * Returns the ViewingPlatform object associated with this scene graph.
      *
      * @return The ViewingPlatform object of this scene graph.
      */
     public final ViewingPlatform getViewingPlatform() {
         return this.viewingPlatform;
     }
 
     /***
      * Returns the ViewingPlatform object associated with this scene graph.
      *
      * @return The ViewingPlatform object of this scene graph.
      */
     public final ViewingPlatform getViewingPlatform(int index) {
         return (ViewingPlatform) this.viewingPlatforms.get(index);
     }
 
 	/***
 	 * add a viewing platform.
 	 */
 	public final void addViewingPlatform(ViewingPlatform viewingPlatform) {
         // Create the ViewingPlatform and Viewer objects, passing
         // down the appropriate parameters.
         this.viewingPlatform = viewingPlatform;
         this.viewingPlatforms.add(this.viewingPlatform);
 
 		TransformGroup tg = this.viewingPlatform.getViewPlatformTransform();
 		tg.setCapability(Node.ALLOW_LOCAL_TO_VWORLD_READ);
 
         // Add the ViewingPlatform to the locale - the scene
         // graph is now "live".
         this.locale.addBranchGraph(this.viewingPlatform);
 	}
 
 	/***
 	 * removes the specified viewing platform.
 	 */
 	public final void removeViewingPlatform(ViewingPlatform viewingPlatform) {
 		if ((this.viewingPlatforms.size() == 1) || // don't let the last one remove.
 			(!this.viewingPlatforms.contains(viewingPlatform))) {
 			return;
 		}
 		if (this.viewingPlatform == viewingPlatform) {
 			ViewingPlatform newPlatform = (ViewingPlatform) this.viewingPlatforms.get(0);
 			this.viewingPlatform = newPlatform;
 		}
         // Add the ViewingPlatform to the locale - the scene
         // graph is now "live".
         this.locale.detachBranchGraph(viewingPlatform);
 		this.viewingPlatforms.remove(viewingPlatform);
 	}
 
     /***
      * Returns the Canvas3D object associated with this Java 3D Universe.
      *
      * @return A reference to the Canvas3D object associated with the
      *  Viewer object.  This method is equivalent to calling getCanvas(0).
      *
      * @see Viewer
      */
     public Canvas3D getCanvas() {
         return getCanvas(0);
     }
 
     /***
      * Returns the Canvas3D object at the specified index associated with
      * this Java 3D Universe.
      *
      * @param canvasNum The index of the Canvas3D object to retrieve.
      *  If there is no Canvas3D object for the given index, null is returned.
      *
      * @return A reference to the Canvas3D object associated with the
      */
     public Canvas3D getCanvas(int canvasNum) {
         return this.viewer.getCanvas3D();
     }
 
 	public World getWorld() {
 		return this.world;
 	}
 
     /***
      * Used to add Nodes to the geometry side (as opposed to the view side)
      * of the scene graph.  This is a short cut to getting the Locale object
      * and calling that object's addBranchGraph() method.
      *
      * @param BranchGroup The BranchGroup to attach to this Universe's Locale.
      */
     public void addBranchGraph(BranchGroup bg) {
         this.world.addBranchGraph(bg);
     }
 
 	/***
 	 * Detaches the specified BranchGroup object.
 	 */
     public final void removeBranchGraph(BranchGroup bg) {
 		//BranchGroupUtil.detachBranchGroup(this.world, bg);
 		this.world.detachBranchGraph(bg);
     }
 
 	public final void removeAllBranchGraph() {
 		this.world.detachAllBranchGraph();
 	}
 	
     /***
      * Finds the preferred <code>GraphicsConfiguration</code> object
      * for the system.  This object can then be used to create the
      * Canvas3D objet for this system.
      *
      * @return The best <code>GraphicsConfiguration</code> object for
      *  the system.
      */
     public static GraphicsConfiguration getPreferredConfiguration() {
         GraphicsConfigTemplate3D template = new GraphicsConfigTemplate3D();
 
         // Check if the user has set the Java 3D stereo option.
         // Getting the system properties causes appletviewer to fail with a
         //  security exception without a try/catch.
         String stereo = (String) java.security.AccessController.doPrivileged(
 		 new java.security.PrivilegedAction() {
 				 public Object run() {
 					 return System.getProperties().getProperty("j3d.stereo");
 				 }
 			 });
 
         // update template based on properties.
         if (stereo != null) {
             if (stereo.equals("REQUIRED")) {
                 template.setStereo(template.REQUIRED);
 			} else if (stereo.equals("PREFERRED")) {
                 template.setStereo(template.PREFERRED);
 			}
         } else {				// if stereo is not requested
 			template.setStereo(template.PREFERRED);
 		}
 
         // Return the GraphicsConfiguration that best fits our needs.
         return GraphicsEnvironment.getLocalGraphicsEnvironment().
 			getDefaultScreenDevice().getBestConfiguration(template);
     }
 }