Changeset 1352

Timestamp:

09/03/08 04:36:20 (3 months ago)

Author:

ArcRiley

Message:

No Ticket :

• further docs and cleanup for soy.actions
  
• renamed soy.actions.Stdout to soy.actions.Print to prep for Python3.0 API
  

Location:

trunk/pysoy

Files:

• include/soy.actions.pxd (modified) (1 diff)
• src/actions/Callback.pym (modified) (1 diff)
• src/actions/Force.pym (modified) (1 diff)
• src/actions/Print.pym (moved) (moved from trunk/pysoy/src/actions/Stdout.pym) (4 diffs, 1 prop)
• src/actions/Quit.pym (modified) (1 diff)
• src/actions/Torque.pym (modified) (1 diff)
• src/actions/soy.actions.pyx (modified) (1 diff)

trunk/pysoy/include/soy.actions.pxd

@@ -26 +26 @@
   cdef void                    _perform        ( self, unsigned int )
 
+cdef class Callback (Action) :
+  cdef object                  _callback
+
 cdef class Force (Action) :
   cdef soy.bodies.Body         _target
   cdef soy.atoms.Vector        _vector
 
-cdef class Stdout (Action) :
+cdef class Print (Action) :
   cdef char*                   _text
-
-cdef class Callback (Action) :
-  cdef object                  _callback
 
 cdef class Torque (Action) :

trunk/pysoy/src/actions/Callback.pym

@@ -23 +23 @@
   '''soy.actions.Callback
 
-    This is a Python function callback action.
+    This L{action<soy.action.Action>} calls a Python function when activated.
 
     @type  callback : function

trunk/pysoy/src/actions/Force.pym

@@ -21 +21 @@
   '''soy.actions.Force
 
-    Adds velocity to a target L{body<soy.bodies.Body>}.
+    This L{action<soy.action.Action>} adds linear force (velocity) to a target 
+    L{body<soy.bodies.Body>} when activated.
 
     @type  target : soy.bodies.Body

trunk/pysoy/src/actions/Print.pym

@@ -1 @@
-# PySoy actions.Quit class
+# PySoy's actions.Print class
 #
 # Copyright (C) 2006,2007,2008 PySoy Group
@@ -18 +18 @@
 # $Id: Print.pxi 732 2008-01-01 22:37:47Z DavidCzech $
 
-cdef class Stdout (Action):
-  '''PySoy Print
+cdef class Print (Action) :
+  '''soy.actions.Print
   
-    When called PySoy will print to stdout. There is an argument for what text to print.
-    See soy.actions.Action for more information.
+    This L{action<soy.action.Action>} prints the specified text on activation.
+
+    Note that as of Python 3.0, this class will use the standard print 
+    function which can be overridden for adjustable behavior.
+
+    @type  target : string
+    @param target : Formatted string to be printed
   '''
 
@@ -30 +35 @@
   #
 
-  def __cinit__(self,text,*args, **kw) :
+  def __cinit__(self, text, *args, **kw) :
     self._text = text
 
@@ -40 +45 @@
     
   cdef void _perform(self, unsigned int _duration) :
+    #
+    # This will change during the Python 3.0 API update
+    #
     stdio.printf("%s\n", self._text)

trunk/pysoy/src/actions/Quit.pym

@@ -21 +21 @@
   '''soy.actions.Quit
 
-    When called PySoy will quit.  There are no arguments to this class.
+    This L{action<soy.action.Action>} terminates Python when activated.
   '''
 

trunk/pysoy/src/actions/Torque.pym

@@ -21 +21 @@
   '''soy.actions.Torque
 
-    Adds rotational velocity to a target L{body<soy.bodies.Body>}.
+    This L{action<soy.action.Action>} adds rotational force (torque) to a 
+    target L{body<soy.bodies.Body>} when activated.
 
     @type  target : soy.bodies.Body

trunk/pysoy/src/actions/soy.actions.pyx

@@ -22 +22 @@
 include "Callback.pym"
 include "Force.pym"
+include "Print.pym"
 include "Quit.pym"
-include "Stdout.pym"
 include "Torque.pym"