01: /*
02: * $RCSfile: EncapsulatingGroup.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.2 $
41: * $Date: 2007/02/09 17:17:01 $
42: * $State: Exp $
43: */
44:
45: package org.jdesktop.j3d.utils.scenegraph;
46:
47: import javax.media.j3d.Node;
48:
49: /**
50: * Interface for groups that encapsulate other scene graph nodes and
51: * override getChild, addChild etc to hide that fact. For example lg3d
52: * J3dComponent3D. Unless this interface is used to provide full access
53: * to the graph applications/tools that use the SceneGraphChangeListener
54: * can get very confused because they are passed parent nodes of
55: * which they have no knowledge.
56: *
57: * @author paulby
58: */
59: public interface EncapsulatingGroup {
60:
61: /**
62: * Return the encapsulated child at the specified index
63: *
64: * @param index the index of the child to be returned
65: * @return the children at location index. The index must be a value greater than or equal to 0 and less than numChildren().
66: * @throws CapabilityNotSetException - if the appropriate capability is not set and this group node is part of live or compiled scene graph
67: java.lang.IndexOutOfBoundsException - if index is invalid.
68: */
69: public Node getEncapsulatedChild(int index);
70:
71: /**
72: * Return the number of encapsulated children
73: *
74: * @return the number of encapsulated children
75: */
76: public int numEncapsulatedChildren();
77:
78: }
|