Mercurial > hg > cmdp
diff src/uk/ac/qmul/eecs/depic/patterns/SequenceMapping.java @ 2:c0412c81d274
Added documentation
| author | Fiore Martin <f.martin@qmul.ac.uk> |
|---|---|
| date | Thu, 18 Feb 2016 18:35:26 +0000 |
| parents | 3074a84ef81e |
| children |
line wrap: on
line diff
--- a/src/uk/ac/qmul/eecs/depic/patterns/SequenceMapping.java Wed Feb 17 14:43:35 2016 +0000 +++ b/src/uk/ac/qmul/eecs/depic/patterns/SequenceMapping.java Thu Feb 18 18:35:26 2016 +0000 @@ -31,9 +31,14 @@ public float DURATION_INF = Float.POSITIVE_INFINITY; public float DURATION_STOP = -1.0f; + /** + * renders a single value of the sequence + * @param val + */ public void renderValue(Sequence.Value val); /** + * Renders the whole curve, from start to end * * @param m * @param startTime the time in millisecond the curve rendering has to start from, if @@ -43,9 +48,9 @@ /** * - * Render a curve at precise time in sound. + * Render a curve at precise time * - * The sound lasts {@code duration} milliseconds and then fades out. + * If sound is used for rendering, the sound lasts {@code duration} milliseconds and then fades out. * If {@code INF} is passed as duration the sound will go on forever. Successive calls with {@code INF} as duration * will have the effect of changing the sound in order to represent the curve at the new {@code time} passed as argument. * Successive calls with {@code duration} different from {@code DURATION_INF} will carry on the sound for {@code duration}