org.jaudiolibs.pipes.graph

Class Property

java.lang.Object

org.jaudiolibs.pipes.graph.Property

All Implemented Interfaces:

Graph.Dependent

public final class Property
extends Object
implements Graph.Dependent

A wrapper type for double values that supports key frame animation in sync with the Graph. This type partly parallels the same named type in the PraxisLIVE (audio) API.

Property fields may be annotated with Inject.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Property.Animator Provides keyframe animation support for Property.

Constructor Summary

Constructors

Constructor and Description
Property()

Method Summary

Modifier and Type	Method and Description
Property.Animator	animator() Return the Animator for the Property, creating it if necessary.
void	attach(Graph graph) Optional hook called when attached to the Graph.
Property	clearLinks() Clear all Linkables from the Property.
void	detach(Graph graph) Optional hook to be informed when removed from the graph.
double	get() Return the current value.
boolean	isAnimating() Return whether the property is currently animating.
Property	link(DoubleConsumer consumer) Call the provided consumer with the double value whenever the value changes.
Property	set(double value) Set the value of this property.
Property.Animator	to(double... to) Animate the property value to the provided values.
void	update() Called before every new buffer is processed.
Linkable.Double	values() Return a new Linkable.Double for observing changing values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property()

Method Detail

set

public Property set(double value)

Set the value of this property. This will cancel any active animation, and notify any attached links.

Parameters:

value -

Returns:

this

get

public double get()

Return the current value.

Returns:

value

link

public Property link(DoubleConsumer consumer)

Call the provided consumer with the double value whenever the value changes. This is a shorthand for values().link(consumer);. The double value will be as if calling #getDouble().

Parameters:

consumer - double consumer

Returns:

this

values

public Linkable.Double values()

Return a new Linkable.Double for observing changing values. The double value will be as if calling get().

Returns:

Linkable.Double of values.

clearLinks

public Property clearLinks()

Clear all Linkables from the Property.

Returns:

this

animator

public Property.Animator animator()

Return the Animator for the Property, creating it if necessary.

Returns:

property animator

to

public Property.Animator to(double... to)

Animate the property value to the provided values. This is a shorthand for calling animator().to(...).

This method returns the animator so that you can chain calls, eg. prop.to(1, 0).in(1, 0.25).easeInOut();

Returns:

property animator

attach

public void attach(Graph graph)

Description copied from interface: Graph.Dependent

Optional hook called when attached to the Graph.

Specified by:

attach in interface Graph.Dependent

Parameters:

graph - the Graph being added to

detach

public void detach(Graph graph)

Description copied from interface: Graph.Dependent

Optional hook to be informed when removed from the graph.

Specified by:

detach in interface Graph.Dependent

Parameters:

graph - the Graph being removed from

update

public void update()

Description copied from interface: Graph.Dependent

Called before every new buffer is processed.

Specified by:

update in interface Graph.Dependent

isAnimating

public boolean isAnimating()

Return whether the property is currently animating.

Returns:

property animator active