All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class vlc.vrml.external.geometry.Sound

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

public class Sound

extends ChildrenNode

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

_set_direction

_set_intensity

_set_location

_set_maxBack

_set_maxFront

_set_minBack

_set_minFront

_set_priority

_set_source

Sound()

Default Constructor

Sound(boolean)

Constructor used when you don't want to use the default fields

Sound(Browser)

Default constructor when supplying your own Browser reference

Sound(Browser, boolean)

Constructor used when you don't want to use the default fields and you wish to supply your own browser reference.

cleanup()

Call when about to remove the node from the scenegraph.

clone()

Make a clone of this object

get_direction()

Gets the direction vector field of the node

get_intensity()

Gets the intensity field of the node

get_location()

Gets the location of the sound source

get_maxBack()

Get the current maxBack setting

get_maxFront()

Get the current maxFront setting

get_minBack()

Get the current minBack setting

get_minFront()

Get the current minFront setting

get_priority()

Get the priority of this sound source

get_source()

Get the current source node that is used by this node

get_spatialize()

Get the setting of the spatialize field.

set_direction(float[])

Sets the direction vector field of the node

set_intensity(float)

Sets the intensity field of the node

set_location(float[])

Sets the location of the sound source

set_maxBack(float)

Set the maxBack field of the node

set_maxFront(float)

Set the maxFront field of the node

set_minBack(float)

Set the minBack field of the node

set_minFront(float)

Set the minFront field of the node

set_priority(float)

Set the priority of this sound source

set_source(AudioNode)

Set the source node for this sound.

writeReset()

Resets the internal reference counting system prior to a call to writeToStream.

writeToStream(int)

Prints the formatted contents of this node to the given stream.

 protected EventInSFVec3f _set_direction

 protected EventInSFFloat _set_intensity

 protected EventInSFVec3f _set_location

 protected EventInSFFloat _set_maxBack

 protected EventInSFFloat _set_maxFront

 protected EventInSFFloat _set_minBack

 protected EventInSFFloat _set_minFront

 protected EventInSFFloat _set_priority

 protected EventInSFNode _set_source

 public Sound()

Default Constructor

 public Sound(Browser b)

Default constructor when supplying your own Browser reference

Parameters:

b - A valid Browser reference

 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

 public Sound(Browser b,
              boolean spatialize)

Constructor used when you don't want to use the default fields and you wish to supply your own browser reference.

Parameters:

spatialize - true if you want to use spaitalized sound

 public void cleanup()

Call when about to remove the node from the scenegraph.

Overrides:

cleanup in class VrmlObject

 public void writeReset()

Resets the internal reference counting system prior to a call to writeToStream. Should always be called so that the DEF/USE constructs work correctly

Overrides:

writeReset in class VrmlObject

 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

 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

 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

 public void set_intensity(float val)

Sets the intensity field of the node

Parameters:

val - The required intensity value

 public float get_intensity()

Gets the intensity field of the node

Returns:

The current intensity value

 public void set_location(float location[])

Sets the location of the sound source

Parameters:

location - An array representing the x, y, and z coordinates

 public float[] get_location()

Gets the location of the sound source

Returns:

An array representing the current x, y, and z coordinates

 public void set_maxBack(float val)

Set the maxBack field of the node

Parameters:

val - The new value to be set.

 public float get_maxBack()

Get the current maxBack setting

Returns:

the maxBack value

 public void set_maxFront(float val)

Set the maxFront field of the node

Parameters:

val - The new value to be set.

 public float get_maxFront()

Get the current maxFront setting

Returns:

The current maxFront value

 public void set_minBack(float val)

Set the minBack field of the node

Parameters:

val - The new value to be set.

 public float get_minBack()

Get the current minBack setting

Returns:

The current minBack value

 public void set_minFront(float val)

Set the minFront field of the node

Parameters:

val - The new value to be set.

 public float get_minFront()

Get the current minFront setting

Returns:

The current minFront value

 public void set_priority(float priority)

Set the priority of this sound source

Parameters:

priority - A value between 0 (low) and 1 (high)

 public float get_priority()

Get the priority of this sound source

Returns:

The current priority. A value between 0 (low) and 1 (high)

 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

 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.

 public boolean get_spatialize()

Get the setting of the spatialize field. This was set during construction of this node

Returns:

The current spatialize setting

 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