com.jayfella.jme.vehicle

Class Sound

java.lang.Object

com.jayfella.jme.vehicle.Sound

All Implemented Interfaces:

jme3utilities.Loadable

public class Sound
extends java.lang.Object
implements jme3utilities.Loadable

A collection of audio nodes used to render a sound at different pitches (fundamental frequencies) and volumes. Each node handles a specific range of pitches. At any given moment, at most one node is playing. Positional audio is used by default.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	logger message logger for this class

Constructor Summary

Constructors

Constructor and Description
Sound()

Method Summary

Modifier and Type	Method and Description
void	addAssetPath(java.lang.String assetPath, float recordedPitch) Add an audio asset to this Sound.
void	attachTo(com.jme3.scene.Node parent) Attach the audio nodes to the specified scene-graph node.
void	detach() Detach the audio nodes from the scene graph.
boolean	isPositional() Test whether this Sound is positional.
void	load(com.jme3.asset.AssetManager assetManager) Load the assets of this Sound without attaching them to any scene.
void	mute() Configure the audio nodes for silence.
void	setPitchAndVolume(float pitch, float volume) Configure the audio nodes for the specified pitch and volume.
void	setPositional(boolean newSetting) Alter whether this Sound is positional.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

public static final java.util.logging.Logger logger

message logger for this class

Constructor Detail

Sound

public Sound()

Method Detail

addAssetPath

public void addAssetPath(java.lang.String assetPath,
                         float recordedPitch)

Add an audio asset to this Sound.

Parameters:

assetPath - the asset path, including the extension (not null, not empty)

recordedPitch - the fundamental frequency of the asset (in cycles per second, >0)

attachTo

public void attachTo(com.jme3.scene.Node parent)

Attach the audio nodes to the specified scene-graph node.

Parameters:

parent - where to attach (not null, modified)

detach

public void detach()

Detach the audio nodes from the scene graph.

isPositional

public boolean isPositional()

Test whether this Sound is positional.

Returns:

true if it takes position/velocity/distance into account when playing, false if it plays in "headspace"

mute

public void mute()

Configure the audio nodes for silence.

setPitchAndVolume

public void setPitchAndVolume(float pitch,
                              float volume)

Configure the audio nodes for the specified pitch and volume.

Parameters:

pitch - the desired fundamental frequency (in cycles per second, >0)

volume - the desired relative volume (linear scale, ≥0)

setPositional

public void setPositional(boolean newSetting)

Alter whether this Sound is positional.

Parameters:

newSetting - true→take position/velocity/distance into account when playing, false→play in "headspace" (default=true)

load

public void load(com.jme3.asset.AssetManager assetManager)

Load the assets of this Sound without attaching them to any scene.

Specified by:

load in interface jme3utilities.Loadable

Parameters:

assetManager - for loading assets (not null, alias created)