Ticket #890 (new task)
Write soy.bodies documentation
|Reported by:||ArcRiley||Owned by:||ArcRiley|
Description (last modified by AlexMeyer) (diff)
NAME soy.bodies - Body Classes FILE /usr/lib/python2.5/site-packages/soy/bodies/__init__.py DESCRIPTION This is a collection of classes that exist in 3d space. PACKAGE CONTENTS _bodies fields lights
That is all we currently show for help(soy.bodies), for one of the most complicated class families.
Someone needs to write easy to read docs which explain that bodies exist inside a soy.scenes.Scene, that they are mass with orientation and velocity, that they may have a shape to collide, mesh to render something, and be connected to joints.
The properties, especially of soy.bodies.Body (those generic to all bodies), need to be explained in greater detail and within the soy.bodies docs a reference to "See soy.bodies.Body for more" or something similar.
soy.bodies.Body.distance, soy.bodies.Body.floor, soy.bodies.Camera.fps, soy.bodies.Camera.wireframe, soy.bodies.Bouyancy, soy.bodies.Generic, soy.bodies.Shockwave.activate, soy.bodies.Light.ambient, soy.bodies.Light.diffuse, soy.bodies.Light.specular all missing docs.