Constructor Detail

• BackgroundSound

  public BackgroundSound()

  Constructs a new BackgroundSound node using the default parameters for Sound nodes.

• BackgroundSound

  public BackgroundSound(MediaContainer soundData,
                         float initialGain)

  Constructs a BackgroundSound node object using only the provided parameter values for sound data and sample gain. The remaining fields are set to the default values for a Sound node.

  Parameters:

  soundData - sound data associated with this sound source node

  initialGain - amplitude scale factor applied to sound source

• BackgroundSound

  public BackgroundSound(MediaContainer soundData,
                         float initialGain,
                         int loopCount,
                         boolean release,
                         boolean continuous,
                         boolean enable,
                         Bounds region,
                         float priority)

  Constructs a BackgroundSound object accepting all the parameters associated with a Sound node.

  Parameters:

  soundData - sound data associated with this sound source node

  initialGain - amplitude scale factor applied to sound source

  loopCount - number of times loop is looped

  release - flag denoting playing sound data to end

  continuous - denotes that sound silently plays when disabled

  enable - sound switched on/off

  region - scheduling bounds

  priority - playback ranking value

Method Detail

• cloneNode

  public Node cloneNode(boolean forceDuplicate)

  Creates a new instance of the node. This routine is called by cloneTree to duplicate the current node.

  Overrides:

  cloneNode in class Node

  Parameters:

  forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree variable determines whether NodeComponent data is duplicated or copied.

  See Also:

  Node.cloneTree(), Node.cloneNode(boolean), Node.duplicateNode(org.scijava.java3d.Node, boolean), NodeComponent.setDuplicateOnCloneTree(boolean)

• duplicateNode

  public void duplicateNode(Node originalNode,
                            boolean forceDuplicate)

  Copies all node information from originalNode into the current node. This method is called from the cloneNode method which is, in turn, called by the cloneTree method.

  For any NodeComponent objects contained by the object being duplicated, each NodeComponent object's duplicateOnCloneTree value is used to determine whether the NodeComponent should be duplicated in the new node or if just a reference to the current node should be placed in the new node. This flag can be overridden by setting the forceDuplicate parameter in the cloneTree method to true.
  NOTE: Applications should not call this method directly. It should only be called by the cloneNode method.

  Overrides:

  duplicateNode in class Node

  Parameters:

  originalNode - the original node to duplicate.

  forceDuplicate - when set to true, causes the duplicateOnCloneTree flag to be ignored. When false, the value of each node's duplicateOnCloneTree variable determines whether NodeComponent data is duplicated or copied.

  Throws:

  ClassCastException - if originalNode is not an instance of Sound

  See Also:

  Node.cloneTree(), Node.cloneNode(boolean), NodeComponent.setDuplicateOnCloneTree(boolean)