Ticket #890 (new task)

Opened 5 years ago

Last modified 5 years ago

Write soy.bodies documentation

Reported by: ArcRiley Owned by: ArcRiley
Priority: High Milestone: beta3
Component: soy.bodies Version: Trunk
Keywords: Cc:

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.

Change History

comment:1 Changed 5 years ago by ArcRiley

  • Owner ArcRiley deleted

comment:2 in reply to: ↑ description Changed 5 years ago by EricStein

  • Owner set to EricStein

Replying to ArcRiley:

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
    joints
    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.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.

comment:3 Changed 5 years ago by ArcRiley

  • Milestone changed from beta2 to beta3

comment:4 Changed 5 years ago by JonNeal

  • Description modified (diff)

comment:5 Changed 5 years ago by AlexMeyer

  • Description modified (diff)

comment:6 Changed 5 years ago by ArcRiley

  • Owner changed from EricStein to ArcRiley
Note: See TracTickets for help on using tickets.