001: /*
002: * $RCSfile: J3dStructure.java,v $
003: *
004: * Copyright 1998-2008 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
006: *
007: * This code is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU General Public License version 2 only, as
009: * published by the Free Software Foundation. Sun designates this
010: * particular file as subject to the "Classpath" exception as provided
011: * by Sun in the LICENSE file that accompanied this code.
012: *
013: * This code is distributed in the hope that it will be useful, but WITHOUT
014: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
015: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
016: * version 2 for more details (a copy is included in the LICENSE file that
017: * accompanied this code).
018: *
019: * You should have received a copy of the GNU General Public License version
020: * 2 along with this work; if not, write to the Free Software Foundation,
021: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
022: *
023: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
024: * CA 95054 USA or visit www.sun.com if you need additional information or
025: * have any questions.
026: *
027: * $Revision: 1.5 $
028: * $Date: 2008/02/28 20:17:25 $
029: * $State: Exp $
030: */
031:
032: package javax.media.j3d;
033:
034: import java.util.ArrayList;
035: import java.util.Arrays;
036:
037: /**
038: * The J3dStructure is the super class of all structures in Java 3D.
039: * A structure is a object that organizes a collection of objects.
040: */
041:
042: abstract class J3dStructure extends Object {
043: /**
044: * This is the list of messages to be processed by this structure
045: */
046: UnorderList messageList = new UnorderList(5, J3dMessage.class);
047:
048: /**
049: * This is the update Thread for this structure
050: */
051:
052: StructureUpdateThread updateThread = null;
053:
054: /**
055: * This is the type of update thread
056: */
057: int threadType = -1;
058:
059: /**
060: * The universe of this structure
061: */
062: VirtualUniverse universe = null;
063:
064: /**
065: * The thread data for the update thread
066: */
067: J3dThreadData threadData = new J3dThreadData();
068:
069: /**
070: * number of messages for this snapshot of time
071: */
072: int nMessage = 0;
073: J3dMessage[] msgList = new J3dMessage[5];
074:
075: /**
076: * This constructor does nothing
077: */
078: J3dStructure(VirtualUniverse u, int type) {
079: universe = u;
080: threadType = type;
081: threadData.threadType = type;
082: }
083:
084: /**
085: * This returns the thread data for this thread.
086: */
087: final J3dThreadData getUpdateThreadData() {
088: return (threadData);
089: }
090:
091: /**
092: * This adds a message to the list of messages for this structure
093: */
094: final void addMessage(J3dMessage message) {
095:
096: if (threadData != null) {
097: threadData.lastUpdateTime = message.time;
098: } else {
099: // this force message to consume when initialized
100: message.time = -1;
101: }
102: message.incRefcount();
103: messageList.add(message);
104: }
105:
106: /**
107: * This returns whether or not there are any pending messages
108: */
109: final J3dMessage[] getMessages(long referenceTime) {
110: int sz, n = 0;
111:
112: synchronized (messageList) {
113: if ((sz = messageList.size()) > 0) {
114: J3dMessage mess[] = (J3dMessage[]) messageList
115: .toArray(false);
116: for (n = 0; n < sz; n++) {
117: if (mess[n].time > referenceTime) {
118: break;
119: }
120: }
121: if (n > 0) {
122: if (msgList.length < n) {
123: msgList = new J3dMessage[n];
124: }
125: messageList.shift(msgList, n);
126: }
127: }
128: }
129:
130: nMessage = n;
131: return msgList;
132: }
133:
134: final void clearMessages() {
135: synchronized (messageList) {
136: int nmessage = messageList.size();
137: if (nmessage > 0) {
138: J3dMessage mess[] = (J3dMessage[]) messageList
139: .toArray(false);
140: for (int i = nmessage - 1; i >= 0; i--) {
141: mess[i].decRefcount();
142: }
143: messageList.clear();
144: }
145: nMessage = 0;
146: msgList = new J3dMessage[5];
147: }
148:
149: }
150:
151: int getNumMessage() {
152: return nMessage;
153: }
154:
155: /**
156: * This gets overriden by the structure
157: */
158: abstract void processMessages(long referenceTime);
159:
160: /**
161: * This is used by MasterControl to process any unused message
162: * for final cleanup. DON'T decrememt message count in
163: * the method, as it is done by MasterControl.
164: */
165: abstract void removeNodes(J3dMessage m);
166:
167: /**
168: * Release resource associate with this structure before GC
169: * We need to clear all those IndexedUnorderSet/WakeupIndexedList
170: * so that the listIdx associate with IndexedObject reset to -1.
171: */
172: abstract void cleanup();
173: }
|