01: /*
02: * $RCSfile: TransparencySortController.java,v $
03: *
04: * Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions
08: * are met:
09: *
10: * - Redistribution of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: *
13: * - Redistribution in binary form must reproduce the above copyright
14: * notice, this list of conditions and the following disclaimer in
15: * the documentation and/or other materials provided with the
16: * distribution.
17: *
18: * Neither the name of Sun Microsystems, Inc. or the names of
19: * contributors may be used to endorse or promote products derived
20: * from this software without specific prior written permission.
21: *
22: * This software is provided "AS IS," without a warranty of any
23: * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
24: * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
25: * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
26: * EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
27: * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
28: * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
29: * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
30: * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
31: * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
32: * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
33: * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
34: * POSSIBILITY OF SUCH DAMAGES.
35: *
36: * You acknowledge that this software is not designed, licensed or
37: * intended for use in the design, construction, operation or
38: * maintenance of any nuclear facility.
39: *
40: * $Revision: 1.5 $
41: * $Date: 2007/04/17 22:13:24 $
42: * $State: Exp $
43: */
44:
45: package com.sun.j3d.utils.scenegraph.transparency;
46:
47: import java.util.Comparator;
48: import java.util.WeakHashMap;
49: import javax.media.j3d.View;
50:
51: /**
52: * This class controls the Transparency Sorting scheme used by Java 3D when
53: * rendering transparent objects. By default (and in all previous versions of
54: * Java 3D) objects are sorted depending on the distance from the viewer of the
55: * centroid of their bounds. By supplying a different Comparator for a view using
56: * the static setComparator method the user can provide their own sorting scheme.
57: *
58: * The Comparator provided will be called with 2 objects of class
59: * TransparencySortGeom.
60: *
61: * @since Java 3D 1.4
62: */
63: public class TransparencySortController {
64:
65: // Issue 478 - use a WeakHashMap to avoid holding a reference to a View unnecessarily.
66: private static WeakHashMap<View, Comparator> comparators = new WeakHashMap<View, Comparator>();
67:
68: /**
69: * Set the comparator for the specified view.
70: *
71: * The comparators compare method will be called with 2 objects of type
72: * TransparencySortGeom and it's result should indicate which object is
73: * closer to the viewer. Object1 < Object2 if it is to be considered closer
74: * and rendered after.
75: *
76: * @param view the view to which the comparator applies
77: * @param comparator the comparator to call
78: */
79: public static void setComparator(View view, Comparator comparator) {
80: comparators.put(view, comparator);
81: }
82:
83: /**
84: * Returns the comparator for the specified view
85: *
86: * @return the comparator for the specified view, or null if there
87: * is no comparator for the view or the view is unknown.
88: */
89: public static Comparator getComparator(View view) {
90: return comparators.get(view);
91: }
92: }
|