1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
* Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*
*/
package javax.media.j3d;
/**
* The SharedGroup provides the ability to manipulate an
* instanced scene graph.
* A SharedGroup node allows multiple Link leaf nodes to share its
* subgraph according to the following semantics:
* <P><UL>
* <LI>A SharedGroup may be referenced by one or more Link leaf
* nodes. Any runtime changes to a node or component object in this
* shared subgraph affect all graphs that refer to this subgraph.</LI><P>
*
* <LI>A SharedGroup may be compiled by calling its compile method
* prior to being referenced by any Link leaf nodes.</LI><P>
*
* <LI>Only Link leaf nodes may refer to SharedGroup nodes. A
* SharedGroup node cannot have parents or be attached to a Locale.</LI><P>
* </UL>
*
* A shared subgraph may contain any group node, except an embedded
* SharedGroup node (SharedGroup nodes cannot have parents). However,
* only the following leaf nodes may appear in a shared subgraph:
* <P><UL>
* <LI>Light</LI>
* <LI>Link</LI>
* <LI>Morph</LI>
* <LI>Shape</LI>
* <LI>Sound</LI></UL><P>
*
* An IllegalSharingException is thrown if any of the following leaf nodes
* appear in a shared subgraph:<P>
* <UL>
* <LI>AlternateAppearance</LI>
* <LI>Background</LI>
* <LI>Behavior</LI>
* <LI>BoundingLeaf</LI>
* <LI>Clip</LI>
* <LI>Fog</LI>
* <LI>ModelClip</LI>
* <LI>Soundscape</LI>
* <LI>ViewPlatform</LI></UL>
* <P>
*
* @see IllegalSharingException
*/
public class SharedGroup extends Group {
/**
* Specifies that this SharedGroup node allows reading the
* list of links that refer to this node.
*
* @since Java 3D 1.3
*/
public static final int
ALLOW_LINK_READ = CapabilityBits.SHARED_GROUP_ALLOW_LINK_READ;
// Array for setting default read capabilities
private static final int[] readCapabilities = {
ALLOW_LINK_READ
};
/**
* Constructs and initializes a new SharedGroup node object.
*/
public SharedGroup() {
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
}
/**
* Returns the list of Link nodes that refer to this SharedGroup node.
* @return An array of Link nodes that refer to this SharedGroup node.
*
* @since Java 3D 1.3
*/
public Link[] getLinks() {
if (isLiveOrCompiled()) {
if (!this.getCapability(ALLOW_LINK_READ)) {
throw new CapabilityNotSetException(J3dI18N.getString("SharedGroup1"));
}
}
return ((SharedGroupRetained)retained).getLinks();
}
/**
* Creates the retained mode SharedGroupRetained object that this
* SharedGroup component object will point to.
*/
@Override
void createRetained() {
this.retained = new SharedGroupRetained();
this.retained.setSource(this);
}
/**
* Compiles the source SharedGroup associated with this object and
* creates and caches a compiled scene graph.
* @exception SceneGraphCycleException if there is a cycle in the
* scene graph
* @exception RestrictedAccessException if the method is called
* when this object is part of a live scene graph.
*/
public void compile() {
if (isLive()) {
throw new RestrictedAccessException(J3dI18N.getString("SharedGroup0"));
}
if (isCompiled() == false) {
// will throw SceneGraphCycleException if there is a cycle
// in the scene graph
checkForCycle();
((SharedGroupRetained)this.retained).compile();
}
}
/**
* Used to create a new instance of the node. This routine is called
* by <code>cloneTree</code> to duplicate the current node.
* @param forceDuplicate when set to <code>true</code>, causes the
* <code>duplicateOnCloneTree</code> flag to be ignored. When
* <code>false</code>, the value of each node's
* <code>duplicateOnCloneTree</code> variable determines whether
* NodeComponent data is duplicated or copied.
*
* @see Node#cloneTree
* @see Node#cloneNode
* @see Node#duplicateNode
* @see NodeComponent#setDuplicateOnCloneTree
*/
@Override
public Node cloneNode(boolean forceDuplicate) {
SharedGroup sg = new SharedGroup();
sg.duplicateNode(this, forceDuplicate);
return sg;
}
}
|
