Update of /cvsroot/pyode/pyode/src
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4462
Modified Files:
geoms.pyx
Log Message:
Doc string updates
Index: geoms.pyx
===================================================================
RCS file: /cvsroot/pyode/pyode/src/geoms.pyx,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** geoms.pyx 28 Jul 2004 07:27:09 -0000 1.6
--- geoms.pyx 28 Jul 2004 16:03:09 -0000 1.7
***************
*** 185,190 ****
def getSpace(self):
! """Return the space that contains the geom.
!
Return the space that the given geometry is contained in,
or return None if it is not contained in any space."""
--- 185,190 ----
def getSpace(self):
! """getSpace() -> Space
!
Return the space that the given geometry is contained in,
or return None if it is not contained in any space."""
***************
*** 248,252 ****
# GeomSphere
cdef class GeomSphere(GeomObject):
! """Sphere object.
"""
--- 248,258 ----
# GeomSphere
cdef class GeomSphere(GeomObject):
! """Sphere geometry.
!
! This class represents a sphere centered at the origin.
!
! Constructor::
!
! GeomSphere(space=None, radius=1.0)
"""
***************
*** 311,315 ****
# GeomBox
cdef class GeomBox(GeomObject):
! """Box object.
"""
--- 317,327 ----
# GeomBox
cdef class GeomBox(GeomObject):
! """Box geometry.
!
! This class represents a box centered at the origin.
!
! Constructor::
!
! GeomBox(space=None, lengths=(1.0, 1.0, 1.0))
"""
***************
*** 364,371 ****
# GeomPlane
cdef class GeomPlane(GeomObject):
! """Plane object.
This object can't be attached to a body.
If you call getBody() on this object it always returns ode.environment.
"""
--- 376,391 ----
# GeomPlane
cdef class GeomPlane(GeomObject):
! """Plane geometry.
!
! This class represents an infinite plane. The plane equation is:
! n.x*x + n.y*y + n.z*z = dist
This object can't be attached to a body.
If you call getBody() on this object it always returns ode.environment.
+
+ Constructor::
+
+ GeomPlane(space=None, normal=(0,0,1), dist=0)
+
"""
***************
*** 418,422 ****
# GeomCCylinder
cdef class GeomCCylinder(GeomObject):
! """Capped cylinder object.
"""
--- 438,451 ----
# GeomCCylinder
cdef class GeomCCylinder(GeomObject):
! """Capped cylinder geometry.
!
! This class represents a capped cylinder aligned along the local Z axis
! and centered at the origin.
!
! Constructor::
!
! GeomCCylinder(space=None, radius=0.5, length=1.0)
!
! The length parameter does not include the caps.
"""
***************
*** 472,475 ****
--- 501,514 ----
cdef class GeomRay(GeomObject):
"""Ray object.
+
+ A ray is different from all the other geom classes in that it does
+ not represent a solid object. It is an infinitely thin line that
+ starts from the geom's position and extends in the direction of
+ the geom's local Z-axis.
+
+ Constructor::
+
+ GeomRay(space=None, rlen=1.0)
+
"""
***************
*** 521,524 ****
--- 560,567 ----
"E", allowing E to be positioned and rotated arbitrarily with
respect to its point of reference.
+
+ Constructor::
+
+ GeomTransform(space=None)
"""
***************
*** 631,634 ****
--- 674,681 ----
stores the actual mesh. This object has to be passed as first
argument to the constructor.
+
+ Constructor::
+
+ GeomTriMesh(data, space=None)
"""
|
