Package com.simsilica.lemur

Class SequenceModels

java.lang.Object

com.simsilica.lemur.SequenceModels

public class SequenceModels
extends Object

Factory methods for standard sequence models.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SequenceModels.AbstractSequence<T>
static class	SequenceModels.DoubleSequence
static class	SequenceModels.ListSequence<T>
static class	SequenceModels.RangedSequence

Constructor Summary

Constructors

Constructor	Description
SequenceModels()

Method Summary

Modifier and Type	Method	Description
static SequenceModel<Double>	doubleSequence(double initialValue, double step)	Returns an unbounded sequence that iterates over double values with the specified increment.
static SequenceModel<Double>	doubleSequence(double initialValue, double step, double resolution)	Returns an unbounded sequence that iterates over double values with a specified increment.
static <T> SequenceModel<T>	listSequence(List<T> list)	Returns an unbounded sequence that iterates over a list and wraps in both directions.
static <T> SequenceModel<T>	listSequence(List<T> list, T initialItem)	Returns an unbounded sequence that iterates over a list and wraps in both directions.
static SequenceModel<Double>	rangedSequence(RangedValueModel model, double step, double resolution)	Returns a bounded double sequence using the specified range model, step, and resolution.

Methods inherited from class java.lang.Object

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

Constructor Details

SequenceModels

public SequenceModels()

Method Details

doubleSequence

public static SequenceModel<Double> doubleSequence(double initialValue,
 double step)

Returns an unbounded sequence that iterates over double values with the specified increment. The step size is also used for the resolution.

doubleSequence

public static SequenceModel<Double> doubleSequence(double initialValue,
 double step,
 double resolution)

Returns an unbounded sequence that iterates over double values with a specified increment. A specified resolution can be included that will make sure that externally set values do not exceed some precision. For example, a resolution of 0.001 makes sure that values will never be more precise than 3 decimal places.

rangedSequence

public static SequenceModel<Double> rangedSequence(RangedValueModel model,
 double step,
 double resolution)

Returns a bounded double sequence using the specified range model, step, and resolution.

listSequence

public static <T> SequenceModel<T> listSequence(List<T> list)

Returns an unbounded sequence that iterates over a list and wraps in both directions. Note: lists with duplicate values may confuse the sequence model and should be avoided.

listSequence

public static <T> SequenceModel<T> listSequence(List<T> list,
 T initialItem)

Returns an unbounded sequence that iterates over a list and wraps in both directions. Note: lists with duplicate values may confuse the sequence model and should be avoided.