I am starting out with Bullet now and have gotten the basics to work. However, I find it difficult to find documentation. I found the API online, but it seems to miss tons of functions. For example, if I look at a RigidBody in the API, I do not see a lot of functions that I do see in Visual Studio, like for example the function getFriction(). I can call these functions, but the API does not show them:
http://bulletphysics.com/Bullet/BulletF ... dBody.html
The user manual PDF contains explanation on a number of topics, but also skips lots of topics. So I am wondering: is there more documentation somewhere that I am missing? Or should I just randomly experiment until I find out what things do? For example, what do setDamping() and setHitFraction() do?
Is there more documentation?
-
- Posts: 25
- Joined: Thu Apr 10, 2008 11:19 am
- Location: Utrecht, Netherlands
-
- Site Admin
- Posts: 4221
- Joined: Sun Jun 26, 2005 6:43 pm
- Location: California, USA
Re: Is there more documentation?
btRigidBody is derived from btCollisionObject, so it inherits all its methods.
For now, doxygen, BulletUserManual.pdf and the Demos/sample code is all there is.
I'm writing a book on real-time rigid body dynamics, and I try to add more Bullet documentation in there.
If you have a list of topics that you want to see covered, can you please provide them?
We could also start the wiki again, to users can generate/add documentation.
Thanks,
Erwin
For now, doxygen, BulletUserManual.pdf and the Demos/sample code is all there is.
I'm writing a book on real-time rigid body dynamics, and I try to add more Bullet documentation in there.
If you have a list of topics that you want to see covered, can you please provide them?
We could also start the wiki again, to users can generate/add documentation.
Thanks,
Erwin
-
- Posts: 145
- Joined: Tue Oct 30, 2007 9:23 pm
Re: Is there more documentation?
I'd like to see thatWe could also start the wiki again, to users can generate/add documentation.
Gary (-;
-
- Posts: 66
- Joined: Fri Oct 12, 2007 6:28 pm
- Location: San Diego
Re: Is there more documentation?
I'd like to see/use a wiki, please!
-
- Posts: 25
- Joined: Thu Apr 10, 2008 11:19 am
- Location: Utrecht, Netherlands
Re: Is there more documentation?
Well, now here's the fun part: btCollisionObject is not even in the API and btRigidBody does not show it inherits from btCollisionObject. Did Doxygen just ignore these files?
-
- Posts: 145
- Joined: Tue Oct 30, 2007 9:23 pm
Re: Is there more documentation?
Use the source, Luke!
Not to diminish your main point which is the general lack of documentation [bring on a wiki! I'll add a bunch of articles myself!], but specifically:
"btCollisionObject is not even in the API and btRigidBody does not show it inherits from btCollisionObject" could be answered really easily, and really quickly, by checking the source
Gary (-;
Not to diminish your main point which is the general lack of documentation [bring on a wiki! I'll add a bunch of articles myself!], but specifically:
"btCollisionObject is not even in the API and btRigidBody does not show it inherits from btCollisionObject" could be answered really easily, and really quickly, by checking the source
Gary (-;
-
- Posts: 25
- Joined: Thu Apr 10, 2008 11:19 am
- Location: Utrecht, Netherlands
Re: Is there more documentation?
I agree that that could answer my question, but it is pretty sad if that is how it works. Unlike the source, Doxygen makes a nice list of all functions, including the inherited ones, and is much more readable. I guess some minor issue kept btCollisionObject from showing up in the Doxygen, so it seems like something that could easily be solved.
Anyway, am I right to conclude that I had found all the documentation there is and should resort to the source for more information on how things work? Then my question has been answered and I can stop searching for more.
Anyway, am I right to conclude that I had found all the documentation there is and should resort to the source for more information on how things work? Then my question has been answered and I can stop searching for more.
-
- Posts: 145
- Joined: Tue Oct 30, 2007 9:23 pm
Re: Is there more documentation?
I've been reading the doxygen docs. Look at #2 in the FAQ page. Probably the EXTRACT_ALL parameterI guess some minor issue kept btCollisionObject from showing up in the Doxygen, so it seems like something that could easily be solved.
Gary (-;