Bullet documentation

Post Reply
gnovosel
Posts: 5
Joined: Wed Oct 28, 2009 9:58 am

Bullet documentation

Post by gnovosel »

Hi.

This is my first post, so I hope I put it in adequate part of forum.

For few days I have played a little with JBullet.
I'm planing on using Bullet for providing environment and simulation purpose in reinforcement learning task.

I'm slowly getting hung of Bullet, but I'm having problems with finding documentation for it.
I've downloaded "bullet-2.73-reference.zip", but it isn't useful, it only links to implementation, without further explanation what some method or class does.

So, is there some good documentation for Bullet?

Thank you in advance,
Goran.
User avatar
Erwin Coumans
Site Admin
Posts: 4221
Joined: Sun Jun 26, 2005 6:43 pm
Location: California, USA
Contact:

Re: Bullet documentation

Post by Erwin Coumans »

Have you checked the Bullet User Manual?
http://bulletphysics.org/mediawiki-1.5. ... umentation

What specific part of documentation is missing?
Thanks,
Erwin
gnovosel
Posts: 5
Joined: Wed Oct 28, 2009 9:58 am

Re: Bullet documentation

Post by gnovosel »

I have read user manual (http://bulletphysics.com/Bullet/BulletPhysics2.74_2.htm).
It's good overview (40 pages), but it's somewhat short to replace need for reference.

I'm trying to find information for specific classes and methods, e.g. RigidBody.setSleepingThresholds().
If I'm interested in some method (because of it's name), I often can't guess what are some arguments supposed to do and what is their scaling factor (e.g. is time in ms or s, and such).

I was hoping there is some more detailed reference then http://www.continuousphysics.com/Bullet ... index.html.
Something more in style of javadoc, or sgi stl reference or python reference or... Something with few lines of explanation of each method and class. Something with little more information then
----------------
void btRigidBody::setSleepingThresholds ( btScalar linear,
btScalar angular
) [inline]

Definition at line 265 of file btRigidBody.h.
----------------

So I was just wondering if there is some more detailed documentation. I'll manage even if there is no such thing, but I'd feel stupid to waste time guessing and trying what something does if there exists better documentation.

Thank you,
Goran.
gnovosel
Posts: 5
Joined: Wed Oct 28, 2009 9:58 am

Re: Bullet documentation

Post by gnovosel »

Anyone?

Thank you in advance.
sparkprime
Posts: 508
Joined: Fri May 30, 2008 2:51 am
Location: Ossining, New York
Contact:

Re: Bullet documentation

Post by sparkprime »

The documentation is pretty weak. Your best option is to read the source code and study the examples to see how to use certain features. Sometimes you just have to ask specific questions on the forum or IRC.
Post Reply