com.soundhelix.component.lfo.impl

Class RectangleLFO

java.lang.Object

com.soundhelix.component.lfo.impl.AbstractLFO

com.soundhelix.component.lfo.impl.RectangleLFO

All Implemented Interfaces:

Component, LFO, RandomSeedable, XMLConfigurable

public class RectangleLFO
extends AbstractLFO

Implements a low frequency oscillator (LFO) using a rectangle wave, starting with 0. A full LFO rotation corresponds to an angle of 2*Pi radians (360 degrees).

Author:

Thomas Schuerger (thomas@schuerger.com)

Field Summary

Fields inherited from class com.soundhelix.component.lfo.impl.AbstractLFO

isConfigured, randomSeed, songContext, TWO_PI

Constructor Summary

Constructors

Constructor and Description
RectangleLFO()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(SongContext songContext, Node node) Configures the instance using the specified XML node.
double	getValue(double angle) Returns the LFO's value of the given angle as a double.

Methods inherited from class com.soundhelix.component.lfo.impl.AbstractLFO

getRandomSeed, getRawTickValue, getTickValue, setActivitySpeed, setBeatSpeed, setMaxAmplitude, setMaxValue, setMinAmplitude, setMinValue, setPhase, setRandomSeed, setSegmentPairSpeed, setSongContext, setSongSpeed, setTimeSpeed

Methods inherited from class java.lang.Object

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

Constructor Detail

RectangleLFO

public RectangleLFO()

Method Detail

getValue

public double getValue(double angle)

Description copied from class: AbstractLFO

Returns the LFO's value of the given angle as a double. The returned value must be between 0 and 1 (both inclusive).

Specified by:

getValue in class AbstractLFO

Parameters:

angle - the angle in radians (non-negative)

Returns:

the LFO's value (between 0 and 1, both inclusive)

configure

public final void configure(SongContext songContext,
             Node node)
                     throws XPathException

Description copied from interface: XMLConfigurable

Configures the instance using the specified XML node. The method should read all supported configuration tags and should call the corresponding setter methods of the class. All settings of the class that are settable using XML should also be settable by using public methods (for example, if the beats per minute are settable using an XML tag, then the class should also provide a public method setBPM(), which does the same). XML configuration can also be a recursive process, if XML settings contain nodes that require XML configuration themselves, but this is up to the implementation of this method. The method should (but need not) use XPath to access the node's tags. Only the node and its descendant nodes may be used for configuration.

Parameters:

songContext - the song context

node - the parent XML node of the configuration tags

Throws:

XPathException - in case of an XPath problem