001: /*
002: * $RCSfile: BackgroundSound.java,v $
003: *
004: * Copyright 1997-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:19 $
029: * $State: Exp $
030: */
031:
032: package javax.media.j3d;
033:
034: /**
035: * A BackgroundSound node defines an unattenuated, nonspatialized sound
036: * source that has no position or direction. It has the same attributes as a
037: * Sound node. This type of sound is simply added to the sound mix without
038: * modification and is useful for playing a mono or stereo music track, or an
039: * ambient sound effect. Unlike a Background (visual) node, more than one
040: * BackgroundSound node can be simultaneously enabled and active.
041: */
042: public class BackgroundSound extends Sound {
043: /**
044: * Constructs a new BackgroundSound node using the default parameters
045: * for Sound nodes.
046: */
047: public BackgroundSound() {
048: /**
049: * Uses default values defined in SoundRetained.java
050: */
051: }
052:
053: /**
054: * Constructs a BackgroundSound node object using only the provided
055: * parameter values for sound data and sample gain. The remaining fields
056: * are set to the default values for a Sound node.
057: * @param soundData sound data associated with this sound source node
058: * @param initialGain amplitude scale factor applied to sound source
059: */
060: public BackgroundSound(MediaContainer soundData, float initialGain) {
061: super (soundData, initialGain);
062: }
063:
064: /**
065: * Constructs a BackgroundSound object accepting all the parameters
066: * associated with a Sound node.
067: * @param soundData sound data associated with this sound source node
068: * @param initialGain amplitude scale factor applied to sound source
069: * @param loopCount number of times loop is looped
070: * @param release flag denoting playing sound data to end
071: * @param continuous denotes that sound silently plays when disabled
072: * @param enable sound switched on/off
073: * @param region scheduling bounds
074: * @param priority playback ranking value
075: */
076: public BackgroundSound(MediaContainer soundData, float initialGain,
077: int loopCount, boolean release, boolean continuous,
078: boolean enable, Bounds region, float priority) {
079:
080: super (soundData, initialGain, loopCount, release, continuous,
081: enable, region, priority);
082: }
083:
084: /**
085: * Creates the retained mode BackgroundSoundRetained object that this
086: * BackgroundSound component object will point to.
087: */
088: void createRetained() {
089: this .retained = new BackgroundSoundRetained();
090: this .retained.setSource(this );
091: }
092:
093: /**
094: * Creates a new instance of the node. This routine is called
095: * by <code>cloneTree</code> to duplicate the current node.
096: * @param forceDuplicate when set to <code>true</code>, causes the
097: * <code>duplicateOnCloneTree</code> flag to be ignored. When
098: * <code>false</code>, the value of each node's
099: * <code>duplicateOnCloneTree</code> variable determines whether
100: * NodeComponent data is duplicated or copied.
101: *
102: * @see Node#cloneTree
103: * @see Node#cloneNode
104: * @see Node#duplicateNode
105: * @see NodeComponent#setDuplicateOnCloneTree
106: */
107: public Node cloneNode(boolean forceDuplicate) {
108: BackgroundSound b = new BackgroundSound();
109: b.duplicateNode(this , forceDuplicate);
110: return b;
111: }
112:
113: /**
114: * Copies all node information from <code>originalNode</code> into
115: * the current node. This method is called from the
116: * <code>cloneNode</code> method which is, in turn, called by the
117: * <code>cloneTree</code> method.
118: * <P>
119: * For any <code>NodeComponent</code> objects
120: * contained by the object being duplicated, each <code>NodeComponent</code>
121: * object's <code>duplicateOnCloneTree</code> value is used to determine
122: * whether the <code>NodeComponent</code> should be duplicated in the new node
123: * or if just a reference to the current node should be placed in the
124: * new node. This flag can be overridden by setting the
125: * <code>forceDuplicate</code> parameter in the <code>cloneTree</code>
126: * method to <code>true</code>.
127: *
128: * <br>
129: * NOTE: Applications should <i>not</i> call this method directly.
130: * It should only be called by the cloneNode method.
131: *
132: * @param originalNode the original node to duplicate.
133: * @param forceDuplicate when set to <code>true</code>, causes the
134: * <code>duplicateOnCloneTree</code> flag to be ignored. When
135: * <code>false</code>, the value of each node's
136: * <code>duplicateOnCloneTree</code> variable determines whether
137: * NodeComponent data is duplicated or copied.
138: * @exception ClassCastException if originalNode is not an instance of
139: * <code>Sound</code>
140: *
141: * @see Node#cloneTree
142: * @see Node#cloneNode
143: * @see NodeComponent#setDuplicateOnCloneTree
144: */
145: public void duplicateNode(Node originalNode, boolean forceDuplicate) {
146: checkDuplicateNode(originalNode, forceDuplicate);
147: }
148: }
|