Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference cheat-sheet #386

Open
anonimo82 opened this issue Dec 29, 2021 · 9 comments
Open

Reference cheat-sheet #386

anonimo82 opened this issue Dec 29, 2021 · 9 comments

Comments

@anonimo82
Copy link

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
Copy link
Contributor

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
Copy link
Author

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
Copy link
Contributor

willeastcott commented Dec 30, 2021

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
Copy link
Author

anonimo82 commented Dec 30, 2021

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
Copy link
Author

@willeastcott help

@lovepsone
Copy link

lovepsone commented Jan 3, 2022

Yes, I have.
Everything standard is in the api

@anonimo82
Copy link
Author

Thanks so much.

@anonimo82
Copy link
Author

anonimo82 commented Sep 20, 2022

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 anonimo82 reopened this Sep 20, 2022
@anonimo82
Copy link
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants