box2d.ts icon indicating copy to clipboard operation
box2d.ts copied to clipboard

Do you have a plane to Change the name of API ?

Open finscn opened this issue 7 years ago • 4 comments

@flyover , Hi , Do you have a plane to Change the name of API , then provide a JavaScript-friendly API ?

example: box2d.b2BodyDef --> Box2d.bodyDef world.CreateBody --> world.createBody b2BodyType.b2_dynamicBody --> bodyType.dynamicBody ...

the things https://github.com/shakiba/planck.js do :

  • b2 prefix is dropped from class names, for example b2World is now available as planck.World.
  • Method names are converted from UpperCamelCase to lowerCamelCase.
  • Definition classes/objects (BodyDef, FixtureDef, etc.) are replaced by inline JavaScript objects ({}).
  • Shapes are made immutable and are not cloned when used to create fixtures.
  • World#on(eventName, listenerFn) and World#off(eventName, listenerFn) are added to add and remove event listeners. Currently supported events are:
    • 'begin-contact'
    • 'end-contact'
    • 'pre-solve'
    • 'post-solve'
    • 'joint-removed'
    • 'fixture-removed'
    • `'body-removed'

finscn avatar Apr 28 '18 10:04 finscn

This lib is looking awesome and it's performance is very good.

👍 I would also like to see the naming conventions more along the lines of ECMAScript standards.

Nick-Riggs avatar May 06 '18 17:05 Nick-Riggs

Why?

On my side, I'm in favor of using Box2D standards. To improve code portability.

Nek- avatar May 21 '18 20:05 Nek-

I also don't like the Box2D API naming BUT to benefit Box2D manual and tuts on internet, changing API may not be a good idea. Instead I have some wrapper classes on my project to use Box2D easily. Btw thanks @flyover ! for preparing this ts version, so that I can find my way using autocompletions.

alpertuna avatar Jul 04 '18 19:07 alpertuna

Yeah, I think I'm going to leave it as close to the original API as possible. Perhaps a wrapper that added some of these JS features would be nice, especially if the underlying physics engine could be swapped out.

flyover avatar Nov 25 '19 21:11 flyover