Lexicon of type names
When reading documentation for Jolt Physics, it may help to understand the differences between Jolt-Physics names and Jolt-JNI names.
Naming conventions
Jolt JNI follows many of the naming conventions of Jolt Physics:
-
Most names are in camel case, with word boundaries indicated by an uppercase letter.
-
Names of classes start with an uppercase letter.
-
Names of constants start with "c".
-
Names of enumerated types start with "E".
-
Names of static member functions start with "s".
-
Names that end with "Arg" are "const" typedefs.
-
Names that end with "Ref" are "Ref<>" typedefs.
-
Names that end with "RefC" are "RefConst<>" typedefs.
Non-static member functions in Jolt Physics
have names that start with an uppercase letter.
The corresponding methods in Jolt JNI
have names that start with a lowercase letter.
Thus IsRigidBody() becomes isRigidBody().
Attributes and member data in Jolt Physics
have names that start with "m".
In Jolt JNI, the corresponding accessor methods
have names that replace the initial "m" with "get" or "set".
Thus mShape member data
are accessed using getShape() and setShape() methods.
Jolt JNI has a different notion of camel case than Jolt Physics does: abbreviations such as "AA", "BCS", "COM", "DOF", "ID", "LRA", "TV", and "WV" are treated as single words. Thus:
-
AABoxbecomesAaBox -
SetPositionCOM()becomessetPositionCom() -
SixDOFConstraintbecomesSixDofConstraint -
BodyIDbecomesBodyId -
ELRATypebecomesELraType -
WheelTVbecomesWheelTv -
WheelWVbecomesWheelWv
Furthermore, Jolt JNI imposes a couple naming conventions of its own:
-
Names that start with "Const" are (also) "const" interfaces.
-
Names that end in "Va" refer to virtual addresses.