Documentation

[LutherCymru]

Hi,
I've recently switched from ODE to Bullet in my 3D modeller and I'm impressed by the relative speed and cleanliness of the API. The one area I would improve is the documentation. I've been trying to find decent documentation for constraints but without a lot of luck. In trying to add a simple ball-socket constraint to my program but had to guess what space the pivot points were in (correct me if I'm wrong but they both seem to be in the local space for the first rigid body - at least that's what seems to work for me).

I know it's boring and I hate writing docs myself but is anybody actively working on this or have I missed a fantastic pdf that covers everything? (if so, it could do with a clearer link unless I'm man-looking). I'd offer to help but as I'm only learning the SDK, I'd probably make it worse by putting incorrect information in there.

Aside from all that, my thanks to all who've contributed to this SDK.

Luther.

[robagar]

It's a known problem - see the sticky above and issue #42. There are plenty of people willing to write some docs (myself included, for the basic stuff), but it needs someone with SVN commit access to really make it happen.

In the mean time, you're best off reading the source code. It's well written, and there are some non-doxygen formatted comments which don't get picked up when the API docs are generated.

[LutherCymru]

In that case, has anybody done any unofficial documentation regarding the constraints. Some diagrams explaining the relationship between pivots and bodies would be helpful. Last night I got the bullet debug drawing interface working in my application - hopefully that will give me enough information. If it does and I get all this working reliably, I'll post it here.

Luther.