Author: DavidCzech
Date: 2008-11-11 00:45:21 -0500 (Tue, 11 Nov 2008)
New Revision: 1375
Modified:
trunk/pysoy/src/_core/Screen-w32.pym
trunk/pysoy/src/_core/Screen-x11.pym
trunk/pysoy/src/_core/Window-w32.pym
trunk/pysoy/src/_core/Window-x11.pym
trunk/pysoy/src/_core/soy._core.pyx
trunk/pysoy/src/_datatypes/AudioDeviceTuple.pym
trunk/pysoy/src/_datatypes/FaceList.pym
trunk/pysoy/src/_datatypes/MaterialList.pym
trunk/pysoy/src/_datatypes/soy._datatypes.pyx
trunk/pysoy/src/_internals/soy._internals.pyx
trunk/pysoy/src/actions/Action.pym
trunk/pysoy/src/actions/Callback.pym
trunk/pysoy/src/actions/Force.pym
trunk/pysoy/src/actions/Print.pym
trunk/pysoy/src/actions/Quit.pym
trunk/pysoy/src/actions/Torque.pym
trunk/pysoy/src/actions/__init__.pym
trunk/pysoy/src/actions/soy.actions.pyx
trunk/pysoy/src/atoms/Axis.pym
trunk/pysoy/src/atoms/Face.pym
trunk/pysoy/src/atoms/Vertex.pym
trunk/pysoy/src/atoms/soy.atoms.pyx
trunk/pysoy/src/bodies/Body.pym
trunk/pysoy/src/bodies/Camera.pym
trunk/pysoy/src/bodies/__init__.pym
trunk/pysoy/src/controllers/Window.pym
trunk/pysoy/src/controllers/soy.controllers.pyx
trunk/pysoy/src/fields/Buoyancy.pym
trunk/pysoy/src/fields/soy.fields.pyx
trunk/pysoy/src/joints/Ball.pym
trunk/pysoy/src/joints/Fixed.pym
trunk/pysoy/src/joints/Hinge.pym
trunk/pysoy/src/joints/Hinge2.pym
trunk/pysoy/src/joints/Slider.pym
trunk/pysoy/src/joints/Universal.pym
trunk/pysoy/src/joints/soy.joints.pyx
trunk/pysoy/src/masses/Box.pym
trunk/pysoy/src/masses/Capsule.pym
trunk/pysoy/src/masses/Cylinder.pym
trunk/pysoy/src/masses/soy.masses.pyx
trunk/pysoy/src/models/Axis.pym
trunk/pysoy/src/models/Billboard.pym
trunk/pysoy/src/models/Liquid.pym
trunk/pysoy/src/models/Mesh.pym
trunk/pysoy/src/models/Shape.pym
trunk/pysoy/src/models/Sun.pym
trunk/pysoy/src/models/soy.models.pyx
trunk/pysoy/src/scenes/Landscape.pym
trunk/pysoy/src/scenes/Planar.pym
trunk/pysoy/src/scenes/Scene.pym
trunk/pysoy/src/scenes/soy.scenes.pyx
trunk/pysoy/src/shapes/Box.pym
trunk/pysoy/src/shapes/Capsule.pym
trunk/pysoy/src/shapes/Sphere.pym
trunk/pysoy/src/shapes/__init__.pym
trunk/pysoy/src/shapes/soy.shapes.pyx
trunk/pysoy/src/textures/Image.pym
trunk/pysoy/src/textures/soy.textures.pyx
trunk/pysoy/src/transports/soy.transports.pyx
trunk/pysoy/src/widgets/Canvas.pym
trunk/pysoy/src/widgets/Container.pym
trunk/pysoy/src/widgets/Projector.pym
trunk/pysoy/src/widgets/StackX.pym
trunk/pysoy/src/widgets/StackY.pym
trunk/pysoy/src/widgets/StackZ.pym
trunk/pysoy/src/widgets/Widget.pym
trunk/pysoy/src/widgets/__init__.pym
trunk/pysoy/src/widgets/soy.widgets.pyx
trunk/pysoy/src/windows/soy.windows.pyx
Log:
Ticket #969 : * Convertered most documentation from epydoc format to ReST Sphinx
* Some Axis VBO debugging
Modified: trunk/pysoy/src/_core/Screen-w32.pym
===================================================================
--- trunk/pysoy/src/_core/Screen-w32.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/_core/Screen-w32.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -28,7 +28,7 @@
An instance of this class for every useable screen is added to
soy.screens when PySoy is first imported.
- Screen objects may only be created and destroyed by soy.screens
+ Screen objects may only be created and destroyed by :mod:`soy.screens`
'''
def __cinit__(self, sId=-1) :
if type(sId) == int and sId == 0 or sId == -1 :
Modified: trunk/pysoy/src/_core/Screen-x11.pym
===================================================================
--- trunk/pysoy/src/_core/Screen-x11.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/_core/Screen-x11.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -31,7 +31,7 @@
An instance of this class for every useable screen is added to
soy.screens when PySoy is first imported.
- Screen objects may only be created and destroyed by soy.screens
+ Screen objects may only be created and destroyed by :mod:`soy.screens`
'''
def __cinit__(self, _sId=-1) :
cdef int _i, _modeNum
Modified: trunk/pysoy/src/_core/Window-w32.pym
===================================================================
--- trunk/pysoy/src/_core/Window-w32.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/_core/Window-w32.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -29,7 +29,7 @@
DEF _POSITION = 4
cdef class Window :
- '''Window Class
+ '''soy.Window
Each instance of this class is a separate window.
'''
@@ -287,7 +287,7 @@
Behind every widget is a background color the window is "cleared" to
before rendering each frame.
- This is an instance of soy.colors.Color which is either created for you
+ This is an instance of :class:`soy.colors.Color` which is either created
for you
(default is black) or passed with background= during a window's creation.
'''
def __get__(self) :
Modified: trunk/pysoy/src/_core/Window-x11.pym
===================================================================
--- trunk/pysoy/src/_core/Window-x11.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/_core/Window-x11.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -356,7 +356,7 @@
Behind every widget is a background color the window is "cleared" to
before rendering each frame.
- This is an instance of soy.colors.Color which is either created for you
+ This is an instance of :class:`soy.colors.Color` which is either created
for you
(default is black) or passed with background= during a window's creation.
'''
def __get__(self) :
Modified: trunk/pysoy/src/_core/soy._core.pyx
===================================================================
--- trunk/pysoy/src/_core/soy._core.pyx 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/_core/soy._core.pyx 2008-11-11 05:45:21 UTC (rev 1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's _core
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/_datatypes/AudioDeviceTuple.pym
===================================================================
--- trunk/pysoy/src/_datatypes/AudioDeviceTuple.pym 2008-11-06 05:59:37 UTC
(rev 1374)
+++ trunk/pysoy/src/_datatypes/AudioDeviceTuple.pym 2008-11-11 05:45:21 UTC
(rev 1375)
@@ -51,9 +51,9 @@
>>> mics_col1
('ALSA Capture on NVidia nForce2',)
- soy.audio.outputs and soy.audio.inputs are standard instances of this
- class. You may only create your own instances of this class by creating a
- slice of one of those two classes.
+ :class:`soy.audio.outputs` and :class:`soy.audio.inputs` are standard
+ instances of this class. You may only create your own instances of
+ this class by creating a slice of one of those two classes.
'''
############################################################################
Modified: trunk/pysoy/src/_datatypes/FaceList.pym
===================================================================
--- trunk/pysoy/src/_datatypes/FaceList.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/_datatypes/FaceList.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -20,7 +20,7 @@
cdef class FaceList (Datatype) :
'''soy._datatypes.FaceList
- This is a list-like container class for the faces of a soy.bodies.Mesh
+ This is a list-like container class for the faces of a
:class:`soy.bodies.Mesh`
'''
############################################################################
Modified: trunk/pysoy/src/_datatypes/MaterialList.pym
===================================================================
--- trunk/pysoy/src/_datatypes/MaterialList.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/_datatypes/MaterialList.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -24,7 +24,7 @@
cdef class MaterialList (Datatype) :
'''soy._datatypes.MaterialList
- This is a list-like container class for materials used by a mesh
+ This is a list-like container class for materials used by a
:class:`soy.meshes.Mesh`
'''
############################################################################
Modified: trunk/pysoy/src/_datatypes/soy._datatypes.pyx
===================================================================
--- trunk/pysoy/src/_datatypes/soy._datatypes.pyx 2008-11-06 05:59:37 UTC
(rev 1374)
+++ trunk/pysoy/src/_datatypes/soy._datatypes.pyx 2008-11-11 05:45:21 UTC
(rev 1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's Datatypes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/_internals/soy._internals.pyx
===================================================================
--- trunk/pysoy/src/_internals/soy._internals.pyx 2008-11-06 05:59:37 UTC
(rev 1374)
+++ trunk/pysoy/src/_internals/soy._internals.pyx 2008-11-11 05:45:21 UTC
(rev 1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's internal classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/actions/Action.pym
===================================================================
--- trunk/pysoy/src/actions/Action.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/actions/Action.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Action :
'''soy.actions.Action
- This is the base Action class which all L{actions<soy.actions>} inherit.
+ This is the base Action class which all :mod:`~soy.actions` inherit.
'''
############################################################################
Modified: trunk/pysoy/src/actions/Callback.pym
===================================================================
--- trunk/pysoy/src/actions/Callback.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/actions/Callback.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -20,7 +20,7 @@
cdef class Callback (Action) :
'''soy.actions.Callback
- This L{action<soy.action.Action>} calls a Python function when performed.
+ This :class:`~soy.action.Action` calls a Python function when performed.
@type callback : function
@param callback : Python function to be called when action is performed
Modified: trunk/pysoy/src/actions/Force.pym
===================================================================
--- trunk/pysoy/src/actions/Force.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/actions/Force.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,8 +20,8 @@
cdef class Force (Action) :
'''soy.actions.Force
- This L{action<soy.action.Action>} adds a force L{vector<soy.atoms.Vector>}
- to a target L{body<soy.bodies.Body>} when performed.
+ This :class:`~soy.action.Action` adds a force :class:`~soy.atoms.Vector`
+ to a target :class:`~soy.bodies.Body` when performed.
@type target : soy.bodies.Body
@param target : Body which force will be applied to
Modified: trunk/pysoy/src/actions/Print.pym
===================================================================
--- trunk/pysoy/src/actions/Print.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/actions/Print.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Print (Action) :
'''soy.actions.Print
- This L{actions class<soy.actions>} prints the specified text on
+ This :class:`~soy.actions.Action` 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
Modified: trunk/pysoy/src/actions/Quit.pym
===================================================================
--- trunk/pysoy/src/actions/Quit.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/actions/Quit.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Quit (Action) :
'''soy.actions.Quit
- This L{action<soy.action.Action>} terminates Python when performed.
+ This :class:`~soy.action.Action` terminates Python when performed.
'''
############################################################################
Modified: trunk/pysoy/src/actions/Torque.pym
===================================================================
--- trunk/pysoy/src/actions/Torque.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/actions/Torque.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,10 +20,10 @@
cdef class Torque (Action) :
'''soy.actions.Torque
- This L{action<soy.action.Action>} adds a torque L{axis<soy.atoms.Axis>}
- to a target L{body<soy.bodies.Body>} when performed.
+ This :class:`~soy.action.Action` adds a torque :class:`~soy.atoms.Axis`
+ to a target :class:`~soy.bodies.Body` when performed.
- U{Right hand rule<http://en.wikipedia.org/wiki/Right_hand_rule>};
+ `Right hand rule <http://en.wikipedia.org/wiki/Right_hand_rule>`_
When you hold your right fist with your thumb out in the direction of
the L{axis<soy.atoms.Axis>}, the applied torque will follow the direction
of your curled fingers from palm to tip. See wikipedia entry for more.
Modified: trunk/pysoy/src/actions/__init__.pym
===================================================================
--- trunk/pysoy/src/actions/__init__.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/actions/__init__.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,6 +1,6 @@
'''PySoy Actions
- These are classes of actions which can be triggered by controllers.
+ These are classes of actions which can be triggered by
:mod:`~soy.controllers`.
'''
__credits__ = '''Copyright (C) 2006,2007,2008 PySoy Group
Modified: trunk/pysoy/src/actions/soy.actions.pyx
===================================================================
--- trunk/pysoy/src/actions/soy.actions.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/actions/soy.actions.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's action classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/atoms/Axis.pym
===================================================================
--- trunk/pysoy/src/atoms/Axis.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/atoms/Axis.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -21,5 +21,5 @@
cdef class Axis (Vector) :
'''soy.atoms.Axis
- This is a rotational L{vector<soy.atoms.Vector>}.
+ This is a rotational :class:`~soy.atoms.Vector`.
'''
Modified: trunk/pysoy/src/atoms/Face.pym
===================================================================
--- trunk/pysoy/src/atoms/Face.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/atoms/Face.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -18,7 +18,7 @@
# $Id$
cdef class Face :
- '''PySoy Face
+ '''soy.atoms.Face
An element of FaceList with .verts property
'''
Modified: trunk/pysoy/src/atoms/Vertex.pym
===================================================================
--- trunk/pysoy/src/atoms/Vertex.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/atoms/Vertex.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -18,7 +18,7 @@
# $Id$
cdef class Vertex :
- '''PySoy Vertex
+ '''soy.atoms.Vertex
An element of VertexList with .position .normal and .texcoord properties
'''
Modified: trunk/pysoy/src/atoms/soy.atoms.pyx
===================================================================
--- trunk/pysoy/src/atoms/soy.atoms.pyx 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/atoms/soy.atoms.pyx 2008-11-11 05:45:21 UTC (rev 1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's atom classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/bodies/Body.pym
===================================================================
--- trunk/pysoy/src/bodies/Body.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/bodies/Body.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -110,8 +110,8 @@
property scene :
'''Body's Scene
- This is the Scene that the body is in. When changed the body's position,
- orientation, velocity, and rotation are all reset to (0,0,0).
+ This is the :class:`~soy.scenes.Scene` that the body is in. When changed
the
+ body's position, orientation, velocity, and rotation are all reset to
(0,0,0).
'''
def __get__(self) :
return self._scene
@@ -173,7 +173,7 @@
property mass :
'''Body's mass
- This is the mass of the body in the scene. Effects physics.
+ This is the mass of the body in the scene. Affects physics.
'''
def __get__(self) :
@@ -268,7 +268,7 @@
property model :
'''Body's model
- If an instance of soy.models.Model it will be rendered as this Body.
+ If an instance of :class:`soy.models.Model` it will be rendered as this
Body.
Defaults to None.
'''
def __get__(self) :
Modified: trunk/pysoy/src/bodies/Camera.pym
===================================================================
--- trunk/pysoy/src/bodies/Camera.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/bodies/Camera.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -21,7 +21,7 @@
'''soy.bodies.Camera
A camera is an invisible object in 3d space through which the scene can
- be rendered through. It must be attached to a soy.widgets.Projector or
+ be rendered through. It must be attached to a
:class:`soy.widgets.Projector` or
other rendering class to be activated.
'''
Modified: trunk/pysoy/src/bodies/__init__.pym
===================================================================
--- trunk/pysoy/src/bodies/__init__.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/bodies/__init__.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -1,15 +1,15 @@
'''Body Classes
This is a collection of classes that exist in 3d space. Each body exists
-within a soy.scenes.Scene. Every body has mass, velocity, and rotational
velocity.
+within a :class:`soy.scenes.Scene`. Every body has mass, velocity, and
rotational velocity.
-Rendering of a Body is done by setting the .mesh property to a soy.mesh
+Rendering of a Body is done by setting the .mesh property to a
:mod:`soy.meshes`
object.
Similarly, collision and other contact behaviour is governed by
-the .shape property, which can be set to a soy.shape.
+the .shape property, which can be set to a :mod:`soy.shapes`.
-Bodies' motions can be limited and guided by using soy.joints.
+Bodies' motions can be limited and guided by using :mod:`soy.joints`.
'''
__credits__ = '''Copyright (C) 2006,2007,2008 PySoy Group
Modified: trunk/pysoy/src/controllers/Window.pym
===================================================================
--- trunk/pysoy/src/controllers/Window.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/controllers/Window.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -20,12 +20,12 @@
cdef class Window (Controller) :
'''PySoy controllers.Window
- This controller responds to various soy.Window events (move, close, etc).
+ This controller responds to various :class:`soy.Window` events (move,
close, etc).
Programmable keys are currently:
'close'
- See soy.controllers.Controller for how to program controllers.
+ See :class:`soy.controllers.Controller` for how to program controllers.
'''
############################################################################
Modified: trunk/pysoy/src/controllers/soy.controllers.pyx
===================================================================
--- trunk/pysoy/src/controllers/soy.controllers.pyx 2008-11-06 05:59:37 UTC
(rev 1374)
+++ trunk/pysoy/src/controllers/soy.controllers.pyx 2008-11-11 05:45:21 UTC
(rev 1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's controllers classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/fields/Buoyancy.pym
===================================================================
--- trunk/pysoy/src/fields/Buoyancy.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/fields/Buoyancy.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Buoyancy (Field) :
'''soy.fields.Buoyancy
- Adjusts the mass Monopole works based on
+ Adjusts the mass :class:`~soy.field.Monopole` works based on
'''
############################################################################
Modified: trunk/pysoy/src/fields/soy.fields.pyx
===================================================================
--- trunk/pysoy/src/fields/soy.fields.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/fields/soy.fields.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's field classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/joints/Ball.pym
===================================================================
--- trunk/pysoy/src/joints/Ball.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/joints/Ball.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Ball (Joint) :
'''PySoy Ball Joint
- a "ball and socket" joint
+ a "ball and socket" :class:`~soy.joints.Joint`
'''
############################################################################
Modified: trunk/pysoy/src/joints/Fixed.pym
===================================================================
--- trunk/pysoy/src/joints/Fixed.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/joints/Fixed.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Fixed (Joint):
'''PySoy Fixed Joint
- This is a fixed joint
+ This is a fixed :class:`~soy.joints.Joint`
'''
############################################################################
Modified: trunk/pysoy/src/joints/Hinge.pym
===================================================================
--- trunk/pysoy/src/joints/Hinge.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/joints/Hinge.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Hinge (Joint) :
'''PySoy Hinge Joint
- a hinge joint
+ a hinge :class:`~soy.joints.Joint`
'''
############################################################################
Modified: trunk/pysoy/src/joints/Hinge2.pym
===================================================================
--- trunk/pysoy/src/joints/Hinge2.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/joints/Hinge2.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Hinge2 (Joint) :
'''PySoy Hinge2 Joint
- a double hinge joint
+ a double hinge :class:`~soy.joints.Joint`
'''
############################################################################
Modified: trunk/pysoy/src/joints/Slider.pym
===================================================================
--- trunk/pysoy/src/joints/Slider.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/joints/Slider.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Slider (Joint) :
'''PySoy Slider Joint
- a slider joint
+ a slider :class:`~soy.joints.Joint`
'''
############################################################################
Modified: trunk/pysoy/src/joints/Universal.pym
===================================================================
--- trunk/pysoy/src/joints/Universal.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/joints/Universal.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -20,7 +20,7 @@
cdef class Universal (Joint) :
'''PySoy Universal Joint
- a universal joint
+ a universal :class:`~soy.joints.Joint`
'''
############################################################################
Modified: trunk/pysoy/src/joints/soy.joints.pyx
===================================================================
--- trunk/pysoy/src/joints/soy.joints.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/joints/soy.joints.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's joint classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/masses/Box.pym
===================================================================
--- trunk/pysoy/src/masses/Box.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/masses/Box.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Box (Mass) :
'''PySoy Sphere
- A spherical shape class.
+ A cubical mass class.
'''
def Create(self,float density = 1, float lx=1 , float ly=1 , float lz=1 ) :
Modified: trunk/pysoy/src/masses/Capsule.pym
===================================================================
--- trunk/pysoy/src/masses/Capsule.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/masses/Capsule.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Capsule (Mass) :
'''PySoy Sphere
- A spherical shape class.
+ A capped-cylinder mass class.
'''
def Create(self,float density = 1, int direction=1, float radius=1,float
length=1 ) :
Modified: trunk/pysoy/src/masses/Cylinder.pym
===================================================================
--- trunk/pysoy/src/masses/Cylinder.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/masses/Cylinder.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Cylinder (Mass) :
'''PySoy Sphere
- A spherical shape class.
+ A cylinder mass class.
'''
def Create(self,float density = 1, int direction=1, float radius=1,float
length=1 ) :
Modified: trunk/pysoy/src/masses/soy.masses.pyx
===================================================================
--- trunk/pysoy/src/masses/soy.masses.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/masses/soy.masses.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's mass classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/models/Axis.pym
===================================================================
--- trunk/pysoy/src/models/Axis.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/models/Axis.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Axis (Model) :
'''soy.models.Axis
- This L{models class<soy.models>} renders a "XYZ axis" oriented to each
+ This :class:`~soy.model.Model` renders a "XYZ axis" oriented to each
body it's attached to. This is useful for debugging.
'''
@@ -32,7 +32,8 @@
cdef void _render(self, soy.bodies.Body _body) :
cdef VertPC _vert[2] # contains vertex position and color data
cdef Line _elmt[1] # contains indices to verts to render lines
- cdef gl.GLfloat _mtx[16]
+ cdef gl.GLfloat _mtx[16]
+ cdef int a
#
######################################
#
@@ -59,8 +60,8 @@
#
# save Camera matix before transforming to the Axis' matrix
#
- gl.glPushMatrix()
- gl.glMultMatrixf(_mtx)
+ #gl.glPushMatrix()
+ #gl.glMultMatrixf(_mtx)
#
######################################
#
@@ -91,7 +92,10 @@
_vert[1].pz = 0.00 # /
_vert[1].cr = 1.00 # \
_vert[1].cg = 0.00 # } Red
- _vert[1].cb = 0.00 # /___________________________
+ _vert[1].cb = 0.00 # /___________________________
+
+ for a from 0 <= a <= 1 :
+ stdio.printf("Index: %d, px %f py %f pz %f cr %f cg %f cb
%f\n",a,_vert[a].px,_vert[a].py,_vert[a].pz,_vert[a].cr,_vert[a].cg,_vert[a].cb)
#
# Next populate _elmt
#
@@ -119,8 +123,8 @@
# Unlike Mesh and most other models, Axis doesn't use normals or textures
# so we need to turn these off while rendering an Axis
#
- gl.glDisableClientState(gl.GL_NORMAL_ARRAY) # No Normals
- gl.glDisableClientState(gl.GL_TEXTURE_COORD_ARRAY) # No Texture Coords
+ #gl.glDisableClientState(gl.GL_NORMAL_ARRAY) # No Normals
+ #gl.glDisableClientState(gl.GL_TEXTURE_COORD_ARRAY) # No Texture Coords
#
######################################
#
@@ -132,7 +136,9 @@
gl.glEnableClientState(gl.GL_COLOR_ARRAY) # We need to render with color
arrays
#
gl.glVertexPointer(3, gl.GL_FLOAT, 0, <gl.GLvoid *> 0)
- gl.glColorPointer (3, gl.GL_FLOAT, 12, <gl.GLvoid *> 0)
+ gl.glNormalPointer ( gl.GL_FLOAT, 0,<gl.GLvoid *> 0) # nx ny nz
+ gl.glTexCoordPointer(3, gl.GL_FLOAT, 0, <gl.GLvoid *> 0) # tx ty tz
+ gl.glColorPointer (3, gl.GL_FLOAT, 0, <gl.GLvoid *> 0)
gl.glDisable(gl.GL_CULL_FACE)
gl.glDisable(gl.GL_DEPTH_TEST)
gl.glDisable(gl.GL_LIGHTING)
@@ -141,14 +147,14 @@
gl.glEnable(gl.GL_DEPTH_TEST)
gl.glEnable(gl.GL_CULL_FACE)
gl.glDisableClientState(gl.GL_COLOR_ARRAY)
- gl.glEnableClientState(gl.GL_TEXTURE_COORD_ARRAY)
- gl.glEnableClientState(gl.GL_NORMAL_ARRAY)
+ #gl.glEnableClientState(gl.GL_TEXTURE_COORD_ARRAY)
+ #gl.glEnableClientState(gl.GL_NORMAL_ARRAY)
#
######################################
#
# return to camera matrix
#
- gl.glPopMatrix()
+ #gl.glPopMatrix()
#
######################################
Modified: trunk/pysoy/src/models/Billboard.pym
===================================================================
--- trunk/pysoy/src/models/Billboard.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/models/Billboard.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -20,8 +20,8 @@
cdef class Billboard (Model) :
'''soy.models.Billboard
- This L{models class<soy.models>} renders a L{material<soy.materials>}
- which always faces the L{camera<soy.bodies.Camera>} viewing it.
+ This :class:`~soy.model.Model` renders a :class:`~soy.materials.Material`
+ which always faces the :class:`~soy.bodies.Camera` viewing it.
@type material : soy.materials.Material
@param material : Material to be used
Modified: trunk/pysoy/src/models/Liquid.pym
===================================================================
--- trunk/pysoy/src/models/Liquid.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/models/Liquid.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Liquid (Model) :
'''soy.models.Liquid
- This models class renders a liquid with volumetric fog
+ This :class:`~soy.model.Model` renders a liquid with volumetric fog
'''
############################################################################
Modified: trunk/pysoy/src/models/Mesh.pym
===================================================================
--- trunk/pysoy/src/models/Mesh.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/models/Mesh.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -23,7 +23,7 @@
This is a collection of verticies and faces we call a "mesh".
Faces and verticies are added to a Mesh by passing the Mesh instance to
- a new soy.atoms.Vertex or soy.atoms.Face object.
+ a new :class:`soy.atoms.Vertex` or :class:`soy.atoms.Face` object.
Materials are added to a Mesh by using it in one of its faces and is
automatically removed from a Mesh when no longer used by any Face.
@@ -40,8 +40,8 @@
}}}
Mesh objects have three main properties, .faces .verts and .materials.
- These are instances of soy._datatypes.FaceList, soy._datatypes.VertexList,
- and soy._datatypes.MaterialList respectively. Each of these emulate a
+ These are instances of :class:`soy._datatypes.FaceList`,
:class:`soy._datatypes.VertexList`,
+ and :class:`soy._datatypes.MaterialList` respectively. Each of these
emulate a
Python list plus some additional functionality, see the help() on each
for more information.
'''
Modified: trunk/pysoy/src/models/Shape.pym
===================================================================
--- trunk/pysoy/src/models/Shape.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/models/Shape.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Shape (Model) :
'''soy.models.Shape
- This mesh renders the shape of the body it belongs to.
+ This :class:`~soy.models.Model` renders the shape of the body it belongs
to.
'''
############################################################################
Modified: trunk/pysoy/src/models/Sun.pym
===================================================================
--- trunk/pysoy/src/models/Sun.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/models/Sun.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Sun (Model) :
'''soy.models.Sun
- This models class renders a sun.
+ This :class:`~soy.model.Model` renders a sun.
'''
############################################################################
Modified: trunk/pysoy/src/models/soy.models.pyx
===================================================================
--- trunk/pysoy/src/models/soy.models.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/models/soy.models.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's model classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/scenes/Landscape.pym
===================================================================
--- trunk/pysoy/src/scenes/Landscape.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/scenes/Landscape.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -20,7 +20,7 @@
cdef class Landscape (Scene) :
''' Landscape Scene
- This is a scene based on a heightmap.
+ This is a :class:`~soy.scenes.Scene` based on a heightmap.
Accepts a heightmap with the detail of it, the width, depth, and height,
and
the position in the form of a dict (x, y, z)
'''
Modified: trunk/pysoy/src/scenes/Planar.pym
===================================================================
--- trunk/pysoy/src/scenes/Planar.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/scenes/Planar.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -27,7 +27,7 @@
cdef class Planar (Scene) :
''' Planar Scene
- This is a scene based on a collision plane of infinite size facing up in
+ This is a :class:`~soy.scenes.Scene` based on a collision plane of
infinite size facing up in
the direction of gravity.
'''
Modified: trunk/pysoy/src/scenes/Scene.pym
===================================================================
--- trunk/pysoy/src/scenes/Scene.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/scenes/Scene.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -24,9 +24,10 @@
cdef class Scene (soy._internals.Loopable) :
'''PySoy Scene
- Scenes are containers in physics space for bodies, joints, and shapes.
- Objects in different worlds cannot interact, for example, bodies in two
- different worlds cannot collide. Worlds also apply gravity to bodies.
+ Scenes are containers in physics space for :mod:`~soy.bodies`,
+ :mod:`~soy.joints`, and :mod:`~soy.shapes`. Objects in different worlds
+ cannot interact, for example, bodies in two different worlds cannot
collide.
+ Worlds also apply gravity to bodies.
'''
############################################################################
@@ -363,7 +364,7 @@
This is the ambient light for the scene. When no light is used this is
the only light available in the scene - use it well.
- Defaults to soy.colors.gray
+ Defaults to :const:`soy.colors.gray`
'''
def __get__(self) :
return self._ambient
Modified: trunk/pysoy/src/scenes/soy.scenes.pyx
===================================================================
--- trunk/pysoy/src/scenes/soy.scenes.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/scenes/soy.scenes.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's scene classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/shapes/Box.pym
===================================================================
--- trunk/pysoy/src/shapes/Box.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/shapes/Box.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Box (Shape) :
'''PySoy Box
- A rectangular prism shape.
+ A rectangular prism :class:`~soy.shape.Shape`.
Takes the x, y, and z side dimensions as floats.
'''
Modified: trunk/pysoy/src/shapes/Capsule.pym
===================================================================
--- trunk/pysoy/src/shapes/Capsule.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/shapes/Capsule.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Capsule (Shape) :
'''PySoy Capsule
- A capped cylinder shape.
+ A capped cylinder :class:`~soy.shape.Shape`.
Takes the radies and length of the capsule as floats.
'''
Modified: trunk/pysoy/src/shapes/Sphere.pym
===================================================================
--- trunk/pysoy/src/shapes/Sphere.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/shapes/Sphere.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,7 +20,7 @@
cdef class Sphere (Shape) :
'''PySoy Sphere
- A spherical shape class.
+ A spherical :class:`~soy.shape.Shape` class.
Takes the circles radius as a float.
'''
Modified: trunk/pysoy/src/shapes/__init__.pym
===================================================================
--- trunk/pysoy/src/shapes/__init__.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/shapes/__init__.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -1,6 +1,6 @@
'''soy.shapes Classes
-soy.shapes is the PySoy module that contains geometrical classes.
+:mod:`soy.shapes` is the PySoy module that contains geometrical classes.
Each geometrical class represents a basic mathematical shape in 3d
space. Shapes govern the behaviour of collision and field application
in the case of shaped fields.
Modified: trunk/pysoy/src/shapes/soy.shapes.pyx
===================================================================
--- trunk/pysoy/src/shapes/soy.shapes.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/shapes/soy.shapes.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's shape classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/textures/Image.pym
===================================================================
--- trunk/pysoy/src/textures/Image.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/textures/Image.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,10 +20,10 @@
cdef class Image (Texture) :
'''soy.textures.Image
- This class loads an image (from PIL) as a 1D or 2D texture.
+ This class loads an image as a 1D or 2D texture.
- As it loads one-shot, is usually slower, and has lacks many features
- the .soy Texture format is recommended when media is included in a game.
+ As it loads one-shot, is usually slower, and has lacks many features.
+ The .soy Texture format is recommended when media is included in a game.
'''
############################################################################
Modified: trunk/pysoy/src/textures/soy.textures.pyx
===================================================================
--- trunk/pysoy/src/textures/soy.textures.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/textures/soy.textures.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's texture classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/transports/soy.transports.pyx
===================================================================
--- trunk/pysoy/src/transports/soy.transports.pyx 2008-11-06 05:59:37 UTC
(rev 1374)
+++ trunk/pysoy/src/transports/soy.transports.pyx 2008-11-11 05:45:21 UTC
(rev 1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's transport classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/widgets/Canvas.pym
===================================================================
--- trunk/pysoy/src/widgets/Canvas.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/widgets/Canvas.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -19,21 +19,21 @@
cdef class Canvas (Widget) :
"""
- Renders a L{Texture}.
+ Renders a :class:`~soy.textures.Texture`.
- Since L{Texture}s can be any sort of bitmap, including text, images,
- and video, adding a L{Canvas} to a L{Window} containing a video or
- image before adding a L{Projector} will create a background. The
- L{Canvas} will be rendered, then the L{Projector} will render the
- scene, overwriting the L{Canvas} where scene elements overlap.
+ Since :class:`~soy.textures.Texture`s can be any sort of bitmap, including
text, images,
+ and video, adding a :class:`~soy.widgets.Canvas` to a :class:`~soy.Window`
containing a video or
+ image before adding a :class:`~soy.widgets.Projector` will create a
background. The
+ :class:`~soy.widgets.Canvas` will be rendered, then the
:class:`~soy.widgets.Projector` will render the
+ scene, overwriting the :class:`~soy.widgets.Canvas` where scene elements
overlap.
- Adding a L{Canvas} after a L{Projector} with a L{Print} can also be
- used to create a heads-up display. The L{Projector} renders the
- scene, then the L{Canvas} renders the L{Print} texture on top of the
- L{Scene}, overwriting the overlapping scene regions.
+ Adding a :class:`~soy.widgets.Canvas` after a
:class:`~soy.widgets.Projector` with a :class:`~soy.textures.Print` can also be
+ used to create a heads-up display. The :class:`~soy.widgets.Projector`
renders the
+ scene, then the :class:`~soy.widgets.Canvas` renders the
:class:`~soy.widgets.Print` texture on top of the
+ :class:`~soy.scenes.Scene`, overwriting the overlapping scene regions.
- Even more effects can be created by combining L{Canvas}es with the
- different L{Container} subclasses.
+ Even more effects can be created by combining :class:`~soy.widgets.Canvas`es
with the
+ different :class:`~soy.widgets.Container` subclasses.
"""
############################################################################
@@ -170,9 +170,9 @@
property texture :
"""
- L{Texture} rendered by this L{Canvas}. Setting to None or
+ :class:`~soy.textures.Texture` rendered by this
:class:`~soy.widgets.Canvas`. Setting to None or
deleting it disables this Canvas. This can be changed at any time
- to change the L{Texture} this L{Canvas} renders.
+ to change the :class:`~soy.textures.Texture` this
:class:`~soy.widgets.Canvas` renders.
"""
def __get__(self) :
Modified: trunk/pysoy/src/widgets/Container.pym
===================================================================
--- trunk/pysoy/src/widgets/Container.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/widgets/Container.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -19,14 +19,14 @@
cdef class Container (Widget) :
"""
- L{Widget} class providing the base L{Container}. L{Widget}
- instances may be added to a L{Window} instance, or to a L{Container}
- subclass. L{Container} itself is an abstract class and can't be
+ :class:`~soy.widgets.Widget` class providing the base
:class:`~soy.widgets.Container`. :class:`~soy.widgets.Widget`
+ instances may be added to a :class:`~soy.Window` instance, or to a
:class:`~soy.widgets.Container`
+ subclass. :class:`~soy.widgets.Container` itself is an abstract class and
can't be
instantiated directly.
- L{Container} classes manage the positioning of the widgets they
- contain. They also propogate the C{_render} method calls to their
- contained L{Widgets}.
+ :class:`~soy.widgets.Container` classes manage the positioning of the
widgets they
+ contain. They also propogate the _render method calls to their
+ contained :class:`~soy.widgets.Widget`.
"""
############################################################################
Modified: trunk/pysoy/src/widgets/Projector.pym
===================================================================
--- trunk/pysoy/src/widgets/Projector.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/widgets/Projector.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -19,8 +19,8 @@
cdef class Projector (Widget) :
"""
- Displays the output of a L{soy.bodies.Camera}. This uses its
- position and size to set up the GL Viewport and the L{Camera}
+ Displays the output of a :class:`soy.bodies.Camera`. This uses its
+ position and size to set up the GL Viewport and the
:class:`soy.bodies.Camera`
parameters to set the gluPerspective parameters.
"""
@@ -62,10 +62,10 @@
property camera :
"""
- The L{soy.bodies.Camera} attached to this L{Projector}. This can
+ The :class:`soy.bodies.Camera` attached to this
:class:`soy.widgets.Projector`. This can
be changed to different cameras which have different perspective
- parameters. This L{Projector} can also be disabled by setting
- this to C{None} or deleting it.
+ parameters. This :class:`soy.widgets.Projector` can also be disabled by
setting
+ this to None or deleting it.
"""
def __get__(self) :
return self._camera
Modified: trunk/pysoy/src/widgets/StackX.pym
===================================================================
--- trunk/pysoy/src/widgets/StackX.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/widgets/StackX.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -19,9 +19,9 @@
cdef class StackX (Container) :
"""
- Provides horizontal packing for L{Widget}s. Children are packed
+ Provides horizontal packing for :class:`~soy.widgets.Widget`s. Children are
packed
from left to right. Each child is given equal horizontal space and
- the full vertical space of the L{StackX}.
+ the full vertical space of the :class:`~soy.widgets.StackX`.
"""
############################################################################
Modified: trunk/pysoy/src/widgets/StackY.pym
===================================================================
--- trunk/pysoy/src/widgets/StackY.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/widgets/StackY.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -19,9 +19,9 @@
cdef class StackY (Container) :
"""
- Provides vertical packing for L{Widget}s. Children are packed from
+ Provides vertical packing for :class:`~soy.widgets.Widget`s. Children are
packed from
top to bottom. Each child is given equal vertical space and the
- full horizontal space of the L{StackX}.
+ full horizontal space of the :class:`soy.widgets.StackY`.
"""
############################################################################
Modified: trunk/pysoy/src/widgets/StackZ.pym
===================================================================
--- trunk/pysoy/src/widgets/StackZ.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/widgets/StackZ.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -19,8 +19,8 @@
cdef class StackZ (Container) :
"""
- Provides stacking of L{Widget} from front to back as layers. This
- is identical to the way L{Window} stacks top-level L{Widget}s.
+ Provides stacking of :class:`~soy.widgets.Widget` from front to back as
layers. This
+ is identical to the way :class:`~soy.Window` stacks top-level
:class:`~soy.widgets.Widget`s.
Fundamentally this is an implicit Z-order stack from first added to
last. Clipping and masking are not handled explicitly, rather,
closer children are drawn after farther children.
Modified: trunk/pysoy/src/widgets/Widget.pym
===================================================================
--- trunk/pysoy/src/widgets/Widget.pym 2008-11-06 05:59:37 UTC (rev 1374)
+++ trunk/pysoy/src/widgets/Widget.pym 2008-11-11 05:45:21 UTC (rev 1375)
@@ -20,30 +20,30 @@
cdef class Widget :
"""
Widgets are two-dimensional surfaces contained in a
- L{soy.window.Window} or in a L{Container}. The size of each
- L{Widget} is calculated from the size of its parent using the #
- L{margin}, and if not M{aspect > 0} the L{aspect}.
+ :class:`~soy.Window` or in a :class:`~soy.widgets.Container`. The size of
each
+ :class:`~soy.widgets.Widget` is calculated from the size of its parent using
the
+ *margin*, and if not M{aspect > 0} the *aspect*.
Optional properties available on constructor:
- @type parent : L{soy.window.Window} or L{Container}
- @param parent : If None: this L{widget} is inactive
+ @type parent : :class:`~soy.Window` or :class:`~soy.widgets.Container`
+ @param parent : If None: this :class:`~soy.widget.Widget` is inactive
If not None: The two-dimensial surface
- containing this L{Widget}.
+ containing this :class:`~soy.widget.Widget`.
@type margin : tuple(int, int, int, int)
@param margin : The amount of space to leave inside
- the bounding edges of L{parent} for
- the bounding edges of this L{Widget}.
+ the bounding edges of parent for
+ the bounding edges of this :class:`~soy.widgets.Widget`.
In order, the numbers are the margins
for the top, right, bottom, and left
from the corresponding edges of
- L{parent}.
+ parent.
@type aspect : float
@param aspect : If <= 0: not used
If > 0: the ratio of wdith and height
- constraining this L{Widget}.
+ constraining this :class:`~soy.widgets.Widget`.
Widget Sizing
=============
@@ -51,76 +51,76 @@
Margin and Aspect
-----------------
- The L{Widget} is first constrained to the margin inside the
- parent's borders. Then, L{aspect} calculations are applied to
+ The :class:`~soy.widgets.Widget` is first constrained to the margin
inside the
+ parent's borders. Then, *aspect* calculations are applied to
reduce the dimension that is longer than the aspect ratio would
allow.
Units and Origin
----------------
- L{Widget} coordinates are physical pixels from the L{Window}
+ :class:`~soy.widgets.Widget` coordinates are physical pixels from the
:class:`~soy.Window`
origin in the GL coordinate space. The origin is located at the
- bottom left corner of the L{Window}, and increase up and to the
+ bottom left corner of the :class:`~soy.Window`, and increase up and to
the
right.
Parents
=======
- Behavior of L{Widget} sizing is slightly different depending on
- whether the parent is a L{soy.window.Window} or a L{Container}.
- L{__cinit__} will initialize the L{Widget} differently. The
+ Behavior of :class:`~soy.widgets.Widget` sizing is slightly different
depending on
+ whether the parent is a :class:`~soy.Window` or a
:class:`~soy.widgets.Container`.
+ __cinit__ will initialize the :class:`~soy.widgets.Widget` differently.
The
Parent cannot be changed after initialization.
Top-Level Widgets
-----------------
- L{Widget} instances placed directly into a L{soy.window.Window}
- are X{Top Level} L{Widget}s. The size of these is managed by
- the containing L{Window}. All L{Widget}s contained in a
- L{Window} are added to the _widgets list of the L{Window}, even
- L{Widgets} not directly parenting that L{Window}. When the
- L{Window} changes size, however, it only resizes the Top Level
- L{Widget}s directly. Other L{Widget}s are managed by their
- L{Container}s.
+ :class:`~soy.widgets.Widget` instances placed directly into a
:class:`~soy.Window`
+ are X{Top Level} :class:`~soy.widgets.Widget`s. The size of these is
managed by
+ the containing :class:`~soy.Window`. All :class:`~soy.widgets.Widget`s
contained in a
+ :class:`~soy.Window` are added to the _widgets list of the
:class:`~soy.Window`, even
+ :class:`~soy.widgets.Widgets` not directly parenting that
:class:`~soy.Window`. When the
+ :class:`~soy.Window` changes size, however, it only resizes the Top Level
+ :class:`~soy.widgets.Widget`s directly. Other
:class:`~soy.widgets.Widget`s are managed by their
+ :class:`~soy.widgets.Container`s.
Type Methods
============
- The methods of the extension type L{Widget} manage the size and
- aspect ratio constraints inside the L{parent} surface.
+ The methods of the extension type :class:`~soy.widgets.Widget` manage the
size and
+ aspect ratio constraints inside the parent surface.
__cinit__
---------
- This initializes the C C{struct} of L{Widget}. If L{parent} is
- None, this just initializes the L{margin} and L{aspect}.
+ This initializes the C C{struct} of :class:`~soy.widgets.Widget`. If
parent is
+ None, this just initializes the *margin* and *aspect*.
- If L{parent} is specified, this will also add a reference to the
- new L{Widget} to the L{Widget} list of the L{soy.window.Window}
- of L{parent}. This new L{Widget} is then sized using the
+ If parent is specified, this will also add a reference to the
+ new :class:`Widget} to the :class:`~soy.widgets.Widget` list of the
:class:`~soy.Window`
+ of parent. This new :class:`~soy.widgets.Widget` is then sized using the
_resize method.
__dealloc__
-----------
- If this L{Widget} has a L{Window}, this is removed from the
- L{Window}'s L{Widget} list.
+ If this :class:`~soy.widgets.Widget` has a :class:`~soy.Window`, this is
removed from the
+ :class:`~soy.Window`'s :class:`~soy.widgets.Widget` list.
- If this L{Widget} has a parent, it is removed from the parent's
+ If this :class:`~soy.widgets.Widget` has a parent, it is removed from
the parent's
_widgets.
_setMargin
----------
- This handles interpreting the L{margin} property. If the margin
+ This handles interpreting the *margin* property. If the margin
was set, this returns 1. Otherwise, it returns 0.
_render
-------
This is called by the parent when this widget should render its
- appearance. In L{Widget} itself, this does nothing. Subclasses
+ appearance. In :class:`~soy.widgets.Widget` itself, this does nothing.
Subclasses
should implement this.
_resize
@@ -359,13 +359,13 @@
property aspect :
"""
- Aspect ratio of L{Widget} constraining the size within the
- L{margin}. If not M{aspect > 0.0}, this will be used by
- L{_resize} to set the size of this widget within the L{margin} so
- that M{width / height = aspect}. If M{aspect = 0}, the L{Widget}
- is sized to fill L{margin} completely.
+ Aspect ratio of :class:`~soy.widgets.Widget` constraining the size within
the
+ *margin*. If not M{aspect > 0.0}, this will be used by
+ _resize to set the size of this widget within the *margin* so
+ that M{width / height = aspect}. If M{aspect = 0}, the
:class:`~soy.widgets.Widget`
+ is sized to fill *margin* completely.
- Defaults to M{aspect = 0.0}, filling the L{margin} completely.
+ Defaults to M{aspect = 0.0}, filling the *margin* completely.
"""
def __get__(self) :
@@ -380,9 +380,9 @@
property position :
"""
- The position of the L{Widget} relative to its L{Window}. This is
- calculated internally in L{_resize} by using the L{margin} and
- L{aspect} properties. This is a C{tuple(int, int)}.
+ The position of the :class:`~soy.widgets.Widget` relative to its
:class:`~soy.widgets.Window`. This is
+ calculated internally in _resize by using the *margin* and
+ *aspect* properties. This is a C{tuple(int, int)}.
"""
def __get__(self) :
@@ -398,8 +398,8 @@
property size :
"""
- Dimensions of L{Widget} in pixels. This is calculated internally
- in L{_resize} by using the L{margin} and L{aspect} properties. It
+ Dimensions of :class:`~soy.widgets.Widget` in pixels. This is calculated
internally
+ in _resize by using the *margin* and *aspect* properties. It
is a C{tuple(int, int)}.
"""
Modified: trunk/pysoy/src/widgets/__init__.pym
===================================================================
--- trunk/pysoy/src/widgets/__init__.pym 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/widgets/__init__.pym 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,7 +1,7 @@
'''PySoy Widgets
Widgets are 2d rendered sections of a window. If you can see it, and it
-doesn't exist in 3d space, it should be inheriting from soy.widgets.Widget.
+doesn't exist in 3d space, it should be inheriting from
:class:`soy.widgets.Widget`.
'''
__credits__ = '''Copyright (C) 2006,2007,2008 PySoy Group
Modified: trunk/pysoy/src/widgets/soy.widgets.pyx
===================================================================
--- trunk/pysoy/src/widgets/soy.widgets.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/widgets/soy.widgets.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.Stub
+# PySoy's widget classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
Modified: trunk/pysoy/src/windows/soy.windows.pyx
===================================================================
--- trunk/pysoy/src/windows/soy.windows.pyx 2008-11-06 05:59:37 UTC (rev
1374)
+++ trunk/pysoy/src/windows/soy.windows.pyx 2008-11-11 05:45:21 UTC (rev
1375)
@@ -1,4 +1,4 @@
-# PySoy's stubs.windows
+# PySoy's window classes
#
# Copyright (C) 2006,2007,2008 PySoy Group
#
_______________________________________________
PySoy-SVN mailing list
PySoy-SVN@pysoy.org
http://www.pysoy.org/mailman/listinfo/pysoy-svn
