Changeset 1355

Timestamp:

09/08/08 04:24:34 (3 months ago)

Author:

ArcRiley

Message:

More docs work.

Location:

trunk/pysoy/src

Files:

• actions/Print.pym (modified) (1 diff)
• models/Axis.pym (modified) (2 diffs)
• models/Billboard.pym (modified) (1 diff)

trunk/pysoy/src/actions/Print.pym

@@ -21 +21 @@
   '''soy.actions.Print
   
-    This L{action<soy.action.Action>} prints the specified text on performance.
+    This L{actions class<soy.actions>} prints the specified text on 
+    performance.  This is useful for debugging.
 
     Note that as of Python 3.0, this class will use the standard print 

trunk/pysoy/src/models/Axis.pym

@@ -21 +21 @@
   '''soy.models.Axis
 
-    This models class renders an XYZ axis at the center of bodies.
+    This L{models class<soy.models>} renders a "XYZ axis" oriented to each 
+    body it's attached to.  This is useful for debugging.
   '''
 
@@ -31 +32 @@
 
   cdef void _render(self, soy.bodies.Body _body) :
+    #
+    # This should be upgraded to use VBO.  Test for buffer ID here.
+    #
     gl.glPushMatrix()
     gl.glDisable(gl.GL_CULL_FACE)

trunk/pysoy/src/models/Billboard.pym

@@ -21 +21 @@
   '''soy.models.Billboard
   
-    This mesh rendering quad always facing the camera
+    This L{models class<soy.models>} renders a L{material<soy.materials>} 
+    which always faces the L{camera<soy.bodies.Camera>} viewing it.
+
+    @type  material : soy.materials.Material
+    @param material : Material to be used
+    @type  size     : tuple
+    @param size     : Initial size of the Billboard
   '''
 
 
-  def __cinit__(self, material,size=(1,1), *args, **kwargs):
+  def __cinit__(self, material, size=(1,1), *args, **kwargs):
     self._material = material
     self._size[0]  = size[0]