search

kripken / ammo.js

Direct port of the Bullet physics engine to JavaScript using Emscripten
Other
4.19k stars 559 forks source link

Reference cheat-sheet #386

Open anonimo82 opened 2 years ago

anonimo82 commented 2 years ago

Hello everyone. Is it there any quick reference or cheat sheet for this API? Maybe a print friendly format?

Thanks in advance for any help.

willeastcott commented 2 years ago

I believe most people just refer to the IDL file:

https://github.com/kripken/ammo.js/blob/main/ammo.idl

And the Bullet User Manual is useful too:

https://github.com/kripken/ammo.js/blob/main/bullet/Bullet_User_Manual.pdf

Although that's certainly not intended as a cheat sheet.

anonimo82 commented 2 years ago

Thanks, the IDL file looks like what I was looking for. But, does it list the whole API? I'm afraid it's a bit too short (or maybe there are more than one?)

willeastcott commented 2 years ago

The IDL is a subset of the Bullet API that is included in the Ammo build. Without the IDL restricting what's included, Ammo would be far larger (and take longer to download). If there's something in Bullet that you need, but it's not included in the IDL you can:

a) Submit a PR that adds to the IDL (including a justification for why it's useful) and it's likely to be merged. b) Modify the IDL locally and build your own custom version of Ammo with the additional API you need.

anonimo82 commented 2 years ago

To be honest, I don't know how is Bullet organized, and I don't know if are there any parts I [don't] need. What's in the IDL? I'm gonna Google for more info, I'll post here again if I need further help.

Thanks =)

Edit: Looking at the Bullet PE documentation, I just need "core" modules, like rigid bodies, joints, soft bodies, etc. I guess those are already in the IDL, aren't them?

anonimo82 commented 2 years ago

@willeastcott help

lovepsone commented 2 years ago

Yes, I have. Everything standard is in the api

anonimo82 commented 2 years ago

Thanks so much.

anonimo82 commented 2 years ago

Excuse me for necro posting, but I had a look at the .idl yesterday, and I'm trying to figure out what to reference in the Bullet Doxygen documentation. In example, I see a bunch of "interface" elements, what do they mean? I'd like a quick used syntax reference, please. Thanks for any help.

Edit: To better explain, I'd like the document structure to be explained

anonimo82 commented 2 years ago

@willeastcott @lovepsone @kripken