search

schteppe / p2.js

JavaScript 2D physics library
Other
2.64k stars 330 forks source link

Unclear documenation #188

Closed trsh closed 8 years ago

trsh commented 8 years ago

boxShape = new p2.Box({ width: 2, height: 1 });

I can find a place in docs, where is written what stands for "width: 2, height: 1". What are the units?

Quadra-Kill commented 8 years ago

Core concepts from wiki： “Units A unit is a way of measuring quantities such as length and time. In p2.js, we use meters-kilogram-second (MKS) units, and radians are used for angles. Do not use pixels for units.”

schteppe commented 8 years ago

Thanks @Quadra-Kill !

Writing the units for each documentation entry is tedious. That's why it's left out in most places.