All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class vlc.vrml.generic.geometry.Sound

java.lang.Object
   |
   +----vlc.vrml.generic.geometry.VrmlObject
           |
           +----vlc.vrml.generic.geometry.ChildrenNode
                   |
                   +----vlc.vrml.generic.geometry.Sound

public class Sound
extends ChildrenNode
JVerge

Version:
0.8 (beta 4) Copyright 1997 The Virtual Light Company under the GNU LGPL

The latest information and bugs in JVerge can be found at http://www.vlc.com.au/JVerge

For definition of the Anchor node please see the VRML 97 Anchor specification

Author:
Justin Couch justin@vlc.com.au

Constructor Index

 o Sound()
Set the Appearance node attribute of this shape.
 o Sound(boolean)
Constructor used when you don't want to use the default fields

Method Index

 o cleanup()
Call when about to remove the node from the scenegraph.
 o clone()
Make a clone of this object
 o get_direction()
Gets the direction vector field of the node
 o get_intensity()
Gets the intensity field of the node
 o get_location()
Gets the location of the sound source
 o get_maxBack()
Get the current maxBack setting
 o get_maxFront()
Get the current maxFront setting
 o get_minBack()
Get the current minBack setting
 o get_minFront()
Get the current minFront setting
 o get_priority()
Get the priority of this sound source
 o get_source()
Get the current source node that is used by this node
 o get_spatialize()
Get the setting of the spatialize field.
 o set_direction(float[])
Sets the direction vector field of the node
 o set_intensity(float)
Sets the intensity field of the node
 o set_location(float[])
Sets the location of the sound source
 o set_maxBack(float)
Set the maxBack field of the node
 o set_maxFront(float)
Get the current maxBack setting
 o set_minBack(float)
Set the minBack field of the node
 o set_minFront(float)
Set the minFront field of the node
 o set_priority(float)
Set the priority of this sound source
 o set_source(AudioNode)
Set the source node for this sound.
 o writeToStream(int)
Prints the formatted contents of this node to the given stream.

Constructors

 o Sound
 public Sound()
Set the Appearance node attribute of this shape.

Parameters:
app - A valid JVerge Appearance node or null if to remove the currently set one.
 o Sound
 public Sound(boolean spatialize)
Constructor used when you don't want to use the default fields

Parameters:
spatialize - true if you want to use spaitalized sound

Methods

 o cleanup
 public void cleanup()
Call when about to remove the node from the scenegraph.

Overrides:
cleanup in class VrmlObject
 o writeToStream
 public void writeToStream(int indent)
Prints the formatted contents of this node to the given stream.

Parameters:
indent - The number of spaces to indent this node in the string
Overrides:
writeToStream in class VrmlObject
 o set_direction
 public void set_direction(float direction[])
Sets the direction vector field of the node

Parameters:
direction - Array representing the x, y and z components of the vector
 o get_direction
 public float[] get_direction()
Gets the direction vector field of the node

Returns:
Array representing the current x, y and z components of the vector
 o set_intensity
 public void set_intensity(float val)
Sets the intensity field of the node

Parameters:
val - The required intensity value
 o get_intensity
 public float get_intensity()
Gets the intensity field of the node

Returns:
The current intensity value
 o set_location
 public void set_location(float location[])
Sets the location of the sound source

Parameters:
location - An array representing the x, y, and z coordinates
 o get_location
 public float[] get_location()
Gets the location of the sound source

Returns:
An array representing the current x, y, and z coordinates
 o set_maxBack
 public void set_maxBack(float val)
Set the maxBack field of the node

Parameters:
val - The new value to be set.
 o get_maxBack
 public float get_maxBack()
Get the current maxBack setting

Returns:
the maxBack value
 o set_maxFront
 public void set_maxFront(float val)
Get the current maxBack setting

Returns:
the maxBack value
 o get_maxFront
 public float get_maxFront()
Get the current maxFront setting

Returns:
The current maxFront value
 o set_minBack
 public void set_minBack(float val)
Set the minBack field of the node

Parameters:
val - The new value to be set.
 o get_minBack
 public float get_minBack()
Get the current minBack setting

Returns:
The current minBack value
 o set_minFront
 public void set_minFront(float val)
Set the minFront field of the node

Parameters:
val - The new value to be set.
 o get_minFront
 public float get_minFront()
Get the current minFront setting

Returns:
The current minFront value
 o set_priority
 public void set_priority(float priority)
Set the priority of this sound source

Parameters:
priority - A value between 0 (low) and 1 (high)
 o get_priority
 public float get_priority()
Get the priority of this sound source

Returns:
The current priority. A value between 0 (low) and 1 (high)
 o set_source
 public void set_source(AudioNode source)
Set the source node for this sound. As per the VRML 97 sepcification, This could be either a MovieTexture or a AudioClip.

Parameters:
source - A subclass of the AudioNode.
See Also:
MovieTexture, AudioClip
 o get_source
 public AudioNode get_source()
Get the current source node that is used by this node

Returns:
A subclass if the AudioNode interface. This will need to be \ cast to the appropriate subclass before use.
 o get_spatialize
 public boolean get_spatialize()
Get the setting of the spatialize field. This was set during construction of this node

Returns:
The current spatialize setting
 o clone
 public Object clone()
Make a clone of this object

Returns:
A deep clone copy of this object
Overrides:
clone in class VrmlObject

All Packages  Class Hierarchy  This Package  Previous  Next  Index