From 5fb3ea060025241105dc8e9a174513c112f9a133 Mon Sep 17 00:00:00 2001
From: rcoh <rcoh@mit.edu>
Date: Thu, 27 Jan 2011 16:50:59 -0500
Subject: A metric $#%$-ton of changes.  Added doc-strings to EVERYTHING. 
 Phew.  Fixed a massive bug that increases performance in by up to a factor of
 60.  A bunch of new behaviors for the class.

---
 pixelevents/DecayEvent.py       | 4 ++++
 pixelevents/SingleFrameEvent.py | 3 +++
 2 files changed, 7 insertions(+)

(limited to 'pixelevents')

diff --git a/pixelevents/DecayEvent.py b/pixelevents/DecayEvent.py
index f8d5ef0..8ff423c 100644
--- a/pixelevents/DecayEvent.py
+++ b/pixelevents/DecayEvent.py
@@ -3,6 +3,10 @@ import math
 from util.ColorOps import * 
 import util.Geo as Geo
 class DecayEvent(PixelEvent):
+    """DecayEvent is a pixel event that can decay either Exponentially or Proportionally.  Specify:
+    <DecayType> -- Exponential or Proportional
+    <Coefficient> -- Controls the speed of decay."""
+
     def initEvent(self):
         self.coefficient = float(abs(self.Coefficient))
         if self.DecayType == 'Exponential':
diff --git a/pixelevents/SingleFrameEvent.py b/pixelevents/SingleFrameEvent.py
index 767f403..252e31b 100644
--- a/pixelevents/SingleFrameEvent.py
+++ b/pixelevents/SingleFrameEvent.py
@@ -1,5 +1,8 @@
 from operationscore.PixelEvent import *
 class SingleFrameEvent(PixelEvent):
+    """SingleFrameEvent is a PixelEvent that will only render for the first frame on which it is
+    queried"""
+
     def initEvent(self):
         self.timeState = -1 
     def state(self, timeDelay):
-- 
cgit v1.2.3