Author: EricStein
Date: 2008-03-18 15:27:01 -0400 (Tue, 18 Mar 2008)
New Revision: 1162

Modified:
   trunk/pysoy/src/fields/Field.pxi
   trunk/pysoy/src/scenes/Scene.pxi
Log:
some commenting work. more later.


Modified: trunk/pysoy/src/fields/Field.pxi
===================================================================
--- trunk/pysoy/src/fields/Field.pxi    2008-03-18 19:26:32 UTC (rev 1161)
+++ trunk/pysoy/src/fields/Field.pxi    2008-03-18 19:27:01 UTC (rev 1162)
@@ -40,10 +40,17 @@
     return _r
 
   cdef int _exert(self, soy.bodies.Body _other) :
+    # This function is applied once per physics cycle for each combination
+    # of affected body and field.
     return 1
 
   cdef void _give(self, int _data) :
+    # This function is called by the physics cycle for each field before
+    # any calls to _exert.  It is used for any initialization or cleanup that
+    # the Field requires.
     return
 
   cdef void _commit(self) :
+    # This function is called by the physics cycle after every call to _exert
+    # has been done
     return

Modified: trunk/pysoy/src/scenes/Scene.pxi
===================================================================
--- trunk/pysoy/src/scenes/Scene.pxi    2008-03-18 19:26:32 UTC (rev 1161)
+++ trunk/pysoy/src/scenes/Scene.pxi    2008-03-18 19:27:01 UTC (rev 1162)
@@ -41,7 +41,9 @@
     self._stepSize     = 0.01
     self._prevTime     = _time()
     self._stepMutex    = py.PyThread_allocate_lock()
+    # a list cor keeping track of the fields in the scene.
     self._giveFields   = soy._internals.PointerSet()
+    # 
     self._callFields   = soy._internals.PointerSet()
     _scenes._append(<void*> self)
 
@@ -90,7 +92,7 @@
     for _i from 0 <= _i < self._bodies._current :
       if isinstance(<soy.bodies.Body> self._bodies._list[_i], 
                     soy.fields.Field) :
-        # Apply fields; add incompletly applied fiels to the list
+        # Apply fields; add incompletly applied fields to the list
         if not (<soy.fields.Field> self._bodies._list[_i])._apply() :
           pass
           #self._callFields._insert(self._bodies.list[_i])

_______________________________________________
PySoy-SVN mailing list
PySoy-SVN@pysoy.org
http://www.pysoy.org/mailman/listinfo/pysoy-svn

Reply via email to