Package heronarts.lx.audio

Class SoundStage

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.audio.SoundStage

All Implemented Interfaces:

LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class SoundStage
extends LXComponent
implements LXOscComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SoundStage.MeterMode
static enum	SoundStage.ObjectPositionMode
static enum	SoundStage.StageMode

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.Placeholder, LXComponent.PluginRequired, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final BoundedParameter	azimuthAbsolute
final BoundedParameter	azimuthRelative
final LXVector	center
final BoundedParameter	depthAbsolute
final BoundedParameter	depthRelative
final BoundedParameter	elevationAbsolute
final BoundedParameter	elevationRelative
final BoundedParameter	heightAbsolute
final BoundedParameter	heightRelative
final EnumParameter<SoundStage.StageMode>	mode
final LXVector	rotation
final BooleanParameter	showSoundObjects
final BooleanParameter	showSoundStage
final LXVector	size
final EnumParameter<SoundStage.MeterMode>	soundObjectMeterMode
final BoundedParameter	soundObjectSize
final BoundedParameter	widthAbsolute
final BoundedParameter	widthRelative
final BoundedParameter	xAbsolute
final BoundedParameter	xRelative
final BoundedParameter	yAbsolute
final BoundedParameter	yRelative
final BoundedParameter	zAbsolute
final BoundedParameter	zRelative

Fields inherited from class heronarts.lx.LXComponent

childArrays, children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
SoundStage(LX lx)

Method Summary

Modifier and Type	Method	Description
LXVector	getNormalizedObjectPosition(SoundObject object)	Gets the normalized sound object position in the global model space
LXVector	getNormalizedObjectPosition(SoundObject object, SoundStage.ObjectPositionMode mode, LXModel reference)	For the given sound object, determine its position using the given mode of placement in the sound stage, and then re-normalized it against the bounds of the reference model.
LXVector	getNormalizedObjectPosition(SoundObject object, SoundStage.ObjectPositionMode mode, LXModel model, LXVector position)	For the given sound object, determine its position using the given mode of placement in the sound stage, and then re-normalized it against the bounds of the reference model
LXVector	getNormalizedObjectPosition(SoundObject object, LXModel reference)	Gets the normalized sound object position in the global model space
void	load(LX lx, JsonObject obj)	Loads the LX component.

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, dispose, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, onParameterChanged, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

rotation

public final LXVector rotation

center

public final LXVector center

size

public final LXVector size

mode

public final EnumParameter<SoundStage.StageMode> mode

xAbsolute

public final BoundedParameter xAbsolute

yAbsolute

public final BoundedParameter yAbsolute

zAbsolute

public final BoundedParameter zAbsolute

widthAbsolute

public final BoundedParameter widthAbsolute

heightAbsolute

public final BoundedParameter heightAbsolute

depthAbsolute

public final BoundedParameter depthAbsolute

azimuthAbsolute

public final BoundedParameter azimuthAbsolute

elevationAbsolute

public final BoundedParameter elevationAbsolute

xRelative

public final BoundedParameter xRelative

yRelative

public final BoundedParameter yRelative

zRelative

public final BoundedParameter zRelative

widthRelative

public final BoundedParameter widthRelative

heightRelative

public final BoundedParameter heightRelative

depthRelative

public final BoundedParameter depthRelative

azimuthRelative

public final BoundedParameter azimuthRelative

elevationRelative

public final BoundedParameter elevationRelative

showSoundStage

public final BooleanParameter showSoundStage

showSoundObjects

public final BooleanParameter showSoundObjects

soundObjectMeterMode

public final EnumParameter<SoundStage.MeterMode> soundObjectMeterMode

soundObjectSize

public final BoundedParameter soundObjectSize

Constructor Details

SoundStage

public SoundStage(LX lx)

Method Details

getNormalizedObjectPosition

public LXVector getNormalizedObjectPosition(SoundObject object)

Gets the normalized sound object position in the global model space

Parameters:

object - Sound object

Returns:

Vector of normalized x/y/z values for sound object position

getNormalizedObjectPosition

public LXVector getNormalizedObjectPosition(SoundObject object,
 LXModel reference)

Gets the normalized sound object position in the global model space

Parameters:

object - Sound object

reference - Model to perform normalization against

Returns:

Vector of normalized x/y/z values for sound object position

getNormalizedObjectPosition

public LXVector getNormalizedObjectPosition(SoundObject object,
 SoundStage.ObjectPositionMode mode,
 LXModel reference)

For the given sound object, determine its position using the given mode of placement in the sound stage, and then re-normalized it against the bounds of the reference model. Note that this version of the method allocates memory.

Parameters:

object - Sound object

mode - Sound stage positioning mode

reference - Reference model

Returns:

The position vector

getNormalizedObjectPosition

public LXVector getNormalizedObjectPosition(SoundObject object,
 SoundStage.ObjectPositionMode mode,
 LXModel model,
 LXVector position)

For the given sound object, determine its position using the given mode of placement in the sound stage, and then re-normalized it against the bounds of the reference model

Parameters:

object - Sound object

mode - Sound stage positioning mode

model - Model being rendered to

position - Position vector to fill

Returns:

The position vector

load

public void load(LX lx,
 JsonObject obj)

Description copied from class: LXComponent

Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.

Specified by:

load in interface LXSerializable

Overrides:

load in class LXComponent

Parameters:

lx - LX instance

obj - Object to deserialize