diff CollidoscopeApp/include/Wave.h @ 7:a4a336624f5a

added some comments DrawInfo dependency from NUM_WAVES
author Fiore Martin <f.martin@qmul.ac.uk>
date Fri, 15 Jul 2016 16:05:34 +0200
parents 75b744078d66
children 4dad0b810f18
line wrap: on
line diff
--- a/CollidoscopeApp/include/Wave.h	Thu Jul 14 15:08:31 2016 +0200
+++ b/CollidoscopeApp/include/Wave.h	Fri Jul 15 16:05:34 2016 +0200
@@ -87,7 +87,10 @@
         /** Sets the size of selection. size is the number of chunks the selection is made of */
         void setSize( size_t size );
         
-        /** Particle spread is used to calculate the size of the cloud of particles */
+        /** The particle spread parameter affects the size of the cloud of particles
+         *  The cloud is the visual conterpart of the grain duration coefficien in sound.
+         *  Indeed spread accepts values from 1 to 8, exactly as the duration coefficient
+         */
         void inline setParticleSpread( float spread ){
             mParticleSpread = spread;
         }