Add some documentation and cleanup of mapping code

[SugarCubes.git] / SugarCubes.pde

/**
 *           +-+-+-+-+-+               +-+-+-+-+-+
 *          /         /|               |\         \
 *         /         / +               + \         \
 *        +-+-+-+-+-+  |   +-+-+-+-+   |  +-+-+-+-+-+
 *        |         |  +  /         \  +  |         |
 *        +   THE   + /  /           \  \ +  CUBES  +
 *        |         |/  +-+-+-+-+-+-+-+  \|         |
 *        +-+-+-+-+-+   |             |   +-+-+-+-+-+
 *                      +             +
 *                      |    SUGAR    |
 *                      +             +
 *                      |             |
 *                      +-+-+-+-+-+-+-+
 *
 * Welcome to the Sugar Cubes! This Processing sketch is a fun place to build
 * animations, effects, and interactions for the platform. Most of the icky
 * code guts are embedded in the GLucose library extension. If you're an
 * artist, you shouldn't need to worry about any of that.
 *
 * Below, you will find definitions of the Patterns, Effects, and Interactions.
 * If you're an artist, create a new tab in the Processing environment with
 * your name. Implement your classes there, and add them to the list below.
 */ 

LXPattern[] patterns(GLucose glucose) {
  return new LXPattern[] {

    new ShiftingPlane(glucose),
    new AskewPlanes(glucose),
    new Swarm(glucose),
    new SpaceTime(glucose),
    new HelixPattern(glucose).setEligible(false),
    new Pong(glucose),
    new Noise(glucose),
    new Blinders(glucose),
    new CrossSections(glucose),
    new Psychedelia(glucose),
    new CubeEQ(glucose).setEligible(false),
    new PianoKeyPattern(glucose).setEligible(false),
    new GlitchPlasma(glucose),
    new FireEffect(glucose).setEligible(false),
    new StripBounce(glucose),
    new SoundRain(glucose).setEligible(false),
    new SoundSpikes(glucose).setEligible(false),
    new FaceSync(glucose),

    // Jack
    new Swim(glucose),
    new Breathe(glucose),

    new TimPlanes(glucose),
    new TimPinwheels(glucose),
    new TimRaindrops(glucose),
    new TimCubes(glucose),
    // new TimTrace(glucose),
    new TimSpheres(glucose),

    // Ben
    new DriveableCrossSections(glucose),
    new GranimTestPattern2(glucose),
     
    // Sam
    new JazzRainbow(glucose),
    
    // Basic test patterns for reference, not art    
    new TestCubePattern(glucose),
    new TestTowerPattern(glucose),
    new TestProjectionPattern(glucose),
    new TestStripPattern(glucose),
    // new TestHuePattern(glucose),
    // new TestXPattern(glucose),
    // new TestYPattern(glucose),
    // new TestZPattern(glucose),

  };
}

LXTransition[] transitions(GLucose glucose) {
  return new LXTransition[] {
    new DissolveTransition(lx),
    new SwipeTransition(glucose),
    new FadeTransition(lx),
  };
}

LXEffect[] effects(GLucose glucose) {
  return new LXEffect[] {
    new FlashEffect(lx),
    new BoomEffect(glucose),
    new DesaturationEffect(lx),
  };
}