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", "COM", "DOF", "ID", "LRA", "TV", and "WV" are treated as single words. Thus:

  • AABox becomes AaBox

  • SetPositionCOM() becomes setPositionCom()

  • SixDOFConstraint becomes SixDofConstraint

  • BodyID becomes BodyId

  • ELRAType becomes ELraType

  • WheelTV becomes WheelTv

  • WheelWV becomes WheelWv

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.

Corresponding types

Jolt-Physics class or struct Jolt-JNI classes and interfaces

JPH::AABox

AaBox ConstAaBox

JPH::Body

Body ConstBody

JPH::BodyCreationSettings

BodyCreationSettings ConstBodyCreationSettings

JPH::BodyFilter

BodyFilter

JPH::BodyInterface

BodyInterface

JPH::BodyLockInterface

BodyLockInterface

JPH::BodyLockInterfaceLocking

BodyLockInterfaceLocking

JPH::BodyLockInterfaceNoLock

BodyLockInterfaceNoLock

JPH::BodyLockRead

BodyLockRead

JPH::BodyLockWrite

BodyLockWrite

JPH::BodyManager

BodyManager

JPH::BoxShape

BoxShape

JPH::BoxShapeSettings

BoxShapeSettings

JPH::BroadPhase

BroadPhase

JPH::BroadPhaseBruteForce

BroadPhaseBruteForce

JPH::BroadPhaseCastResult

BroadPhaseCastResult

JPH::BroadPhaseLayerFilter

BroadPhaseLayerFilter

JPH::BroadPhaseLayerInterface

BroadPhaseLayerInterface ConstBroadPhaseLayerInterface

JPH::BroadPhaseLayerInterfaceTable

BroadPhaseLayerInterfaceTable

JPH::BroadPhaseQuadTree

BroadPhaseQuadTree

JPH::BroadPhaseQuery

BroadPhaseQuery

JPH::CapsuleShape

CapsuleShape

JPH::CapsuleShapeSettings

CapsuleShapeSettings

JPH::Character

Character ConstCharacter CharacterRef CharacterRefC

JPH::CharacterBase

CharacterBase ConstCharacterBase

JPH::CharacterBaseSettings

CharacterBaseSettings ConstCharacterBaseSettings

JPH::CharacterContactListener

CharacterContactListener

JPH::CharacterContactSettings

CharacterContactSettings

JPH::CharacterSettings

CharacterSettings ConstCharacterSettings CharacterSettingsRef

JPH::CharacterVirtual

CharacterVirtual ConstCharacterVirtual CharacterVirtualRef CharacterVirtualRefC

JPH::CharacterVirtualSettings

CharacterVirtualSettings ConstCharacterVirtualSettings CharacterVirtualSettingsRef

JPH::CharacterVsCharacterCollision

CharacterVsCharacterCollision

JPH::CharacterVsCharacterCollisionSimple

CharacterVsCharacterCollisionSimple

JPH::CollidePointResult

CollidePointResult

JPH::CollideSettingsBase

CollideSettingsBase

JPH::CollideShapeResult

CollideShapeResult

JPH::CollideShapeSettings

CollideShapeSettings

JPH::CollisionDispatch

CollisionDispatch

JPH::CollisionGroup

CollisionGroup ConstCollisionGroup

JPH::Color

Color ConstColor

JPH::CompoundShape

CompoundShape

JPH::CompoundShapeSettings

CompoundShapeSettings

JPH::ConeConstraint

ConeConstraint

JPH::ConeConstraintSettings

ConeConstraintSettings

JPH::Constraint

Constraint ConstConstraint ConstraintRef

JPH::ConstraintSettings

ConstraintSettings ConstConstraintSettings ConstraintSettingsRef

JPH::ContactListener

ContactListener

JPH::ContactManifold

ContactManifold ConstContactManifold

JPH::ContactSettings

ContactSettings ConstContactSettings

JPH::ConvexHullBuilder

ConvexHullBuilder

JPH::ConvexHullShape

ConvexHullShape

JPH::ConvexHullShapeSettings

ConvexHullShapeSettings

JPH::ConvexShape

ConvexShape

JPH::ConvexShapeSettings

ConvexShapeSettings ConstConvexShapeSettings

JPH::CylinderShape

CylinderShape

JPH::CylinderShapeSettings

CylinderShapeSettings

JPH::DebugRenderer

DebugRenderer

JPH::DebugRendererRecorder

DebugRendererRecorder

JPH::DecoratedShape

DecoratedShape

JPH::DecoratedShapeSettings

DecoratedShapeSettings

JPH::DefaultBroadPhaseLayerFilter

DefaultBroadPhaseLayerFilter

JPH::DefaultBroadPhaseLayerFilter

DefaultBroadPhaseLayerFilter

JPH::DefaultObjectLayerFilter

DefaultObjectLayerFilter

JPH::DistanceConstraint

DistanceConstraint

JPH::DistanceConstraintSettings

DistanceConstraintSettings

JPH::EmptyShape

EmptyShape

JPH::EmptyShapeSettings

EmptyShapeSettings

JPH::FixedConstraint

FixedConstraint

JPH::FixedConstraintSettings

FixedConstraintSettings

JPH::Float2

Float2

JPH::Float3

Float3

JPH::GearConstraint

GearConstraint

JPH::GearConstraintSettings

GearConstraintSettings

JPH::GroupFilter

GroupFilter ConstGroupFilter GroupFilterRef

JPH::GroupFilterTable

GroupFilterTable GroupFilterTableRef

JPH::HeightFieldShape

HeightFieldShape

JPH::HeightFieldShapeSettings

HeightFieldShapeSettings

JPH::HingeConstraint

HingeConstraint

JPH::HingeConstraintSettings

HingeConstraintSettings

JPH::IgnoreMultipleBodiesFilter

IgnoreMultipleBodiesFilter

JPH::IndexedTriangle

IndexedTriangle

JPH::IndexedTriangleNoMaterial

IndexedTriangleNoMaterial

JPH::JobSystem

JobSystem

JPH::JobSystemSingleThreaded

JobSystemSingleThreaded

JPH::JobSystemThreadPool

JobSystemThreadPool

JPH::JobSystemWithBarrier

JobSystemWithBarrier

JPH::Joint

Joint ConstJoint

JPH::MassProperties

MassProperties ConstMassProperties

JPH::Mat44

Mat44 Mat44Arg

JPH::MeshShape

MeshShape

JPH::MeshShapeSettings

MeshShapeSettings

JPH::MotionProperties

MotionProperties ConstMotionProperties

JPH::MotorSettings

MotorSettings

JPH::MotorcycleController

MotorcycleController

JPH::MotorcycleControllerSettings

MotorcycleControllerSettings

JPH::MutableCompoundShape

MutableCompoundShape

JPH::MutableCompoundShapeSettings

MutableCompoundShapeSettings

JPH::Mutex

Mutex

JPH::NarrowPhaseQuery

NarrowPhaseQuery

JPH::NonCopyable

NonCopyable

JPH::ObjectLayerFilter

ObjectLayerFilter

JPH::ObjectLayerPairFilter

ObjectLayerPairFilter ConstObjectLayerPairFilter

JPH::ObjectLayerPairFilterTable

ObjectLayerPairFilterTable

JPH::ObjectStreamIn

ObjectStreamIn

JPH::ObjectStreamOut

ObjectStreamOut

JPH::ObjectVsBroadPhaseLayerFilter

ObjectVsBroadPhaseLayerFilter ConstObjectVsBroadPhaseLayerFilter

JPH::ObjectVsBroadPhaseLayerFilterTable

ObjectVsBroadPhaseLayerFilterTable

JPH::OffsetCenterOfMassShape

OffsetCenterOfMassShape

JPH::OffsetCenterOfMassShapeSettings

OffsetCenterOfMassShapeSettings

JPH::OrientedBox

OrientedBox ConstOrientedBox

JPH::PathConstraint

PathConstraint

JPH::PathConstraintPath

PathConstraintPath PathConstraintPathRef

JPH::PathConstraintPathHermite

PathConstraintPathHermite

JPH::PathConstraintSettings

PathConstraintSettings

JPH::PhysicsMaterial

PhysicsMaterial ConstPhysicsMaterial PhysicsMaterialRef PhysicsMaterialRefC

JPH::PhysicsMaterialSimple

PhysicsMaterialSimple

JPH::PhysicsScene

PhysicsScene PhysicsSceneRef

JPH::PhysicsSettings

PhysicsSettings

JPH::PhysicsStepListener

PhysicsStepListener

JPH::PhysicsStepListenerContext

PhysicsStepListenerContext

JPH::PhysicsSystem

PhysicsSystem

JPH::Plane

Plane ConstPlane

JPH::PlaneShape

PlaneShape

JPH::PlaneShapeSettings

PlaneShapeSettings

JPH::PointConstraint

PointConstraint

JPH::PointConstraintSettings

PointConstraintSettings

JPH::PulleyConstraint

PulleyConstraint

JPH::PulleyConstraintSettings

PulleyConstraintSettings

JPH::Quat

Quat QuatArg

JPH::RackAndPinionConstraint

RackAndPinionConstraint

JPH::RackAndPinionConstraintSettings

RackAndPinionConstraintSettings

JPH::Ragdoll

Ragdoll RagdollRef

JPH::RagdollSettings

RagdollSettings RagdollSettingsRef

JPH::RayCast

RayCast

JPH::RayCastResult

RayCastResult

JPH::RayCastSettings

RayCastSettings

JPH::RotatedTranslatedShape

RotatedTranslatedShape

JPH::RotatedTranslatedShapeSettings

RotatedTranslatedShapeSettings

JPH::RRayCast

RRayCast

JPH::RShapeCast

RShapeCast

JPH::ScaledShape

ScaledShape

JPH::ScaledShapeSettings

ScaledShapeSettings

JPH::SerializableObject

SerializableObject

JPH::Shape

Shape ConstShape ShapeRef ShapeRefC

JPH::ShapeCastResult

ShapeCastResult

JPH::ShapeCastSettings

ShapeCastSettings

JPH::ShapeFilter

ShapeFilter

JPH::ShapeSettings

ShapeSettings ConstShapeSettings ShapeSettingsRef ShapeSettingsRefC

JPH::SharedMutex

SharedMutex

JPH::SixDOFConstraint

SixDofConstraint

JPH::SixDOFConstraintSettings

SixDofConstraintSettings

JPH::SkeletalAnimation

SkeletalAnimation SkeletalAnimationRef

JPH::Skeleton

Skeleton ConstSkeleton SkeletonRef

JPH::SkeletonMapper

SkeletonMapper SkeletonMapperRef

JPH::SkeletonPose

SkeletonPose

JPH::SliderConstraint

SliderConstraint

JPH::SliderConstraintSettings

SliderConstraintSettings

JPH::SoftBodyContactListener

SoftBodyContactListener

JPH::SoftBodyContactSettings

SoftBodyContactSettings ConstSoftBodyContactSettings

JPH::SoftBodyCreationSettings

SoftBodyCreationSettings ConstSoftBodyCreationSettings

JPH::SoftBodyManifold

SoftBodyManifold

JPH::SoftBodyMotionProperties

SoftBodyMotionProperties ConstSoftBodyMotionProperties

JPH::SoftBodyShape

SoftBodyShape

JPH::SoftBodySharedSettings

SoftBodySharedSettings ConstSoftBodySharedSettings SoftBodySharedSettingsRef

JPH::SoftBodyVertex

SoftBodyVertex ConstSoftBodyVertex

JPH::SpecifiedBroadPhaseLayerFilter

SpecifiedBroadPhaseLayerFilter

JPH::SpecifiedObjectLayerFilter

SpecifiedObjectLayerFilter

JPH::Sphere

Sphere

JPH::SphereShape

SphereShape

JPH::SphereShapeSettings

SphereShapeSettings

JPH::SpringSettings

SpringSettings

JPH::StateRecorder

StateRecorder

JPH::StateRecorderFilter

StateRecorderFilter

JPH::StateRecorderImpl

StateRecorderImpl

JPH::StaticCompoundShape

StaticCompoundShape

JPH::StaticCompoundShapeSettings

StaticCompoundShapeSettings

JPH::StreamIn

StreamIn

JPH::StreamInWrapper

StreamInWrapper

JPH::StreamOut

StreamOut

JPH::StreamOutWrapper

StreamOutWrapper

JPH::SubShapeIDCreator

SubShapeIdCreator

JPH::SubShapeIDPair

SubShapeIdPair

JPH::SwingTwistConstraint

SwingTwistConstraint

JPH::SwingTwistConstraintSettings

SwingTwistConstraintSettings

JPH::TaperedCapsuleShape

TaperedCapsuleShape

JPH::TaperedCapsuleShapeSettings

TaperedCapsuleShapeSettings

JPH::TaperedCylinderShape

TaperedCylinderShape

JPH::TaperedCylinderShapeSettings

TaperedCylinderShapeSettings

JPH::TempAllocator

TempAllocator

JPH::TempAllocatorImpl

TempAllocatorImpl

JPH::TempAllocatorImplWithMallocFallback

TempAllocatorImplWithMallocFallback

JPH::TempAllocatorMalloc

TempAllocatorMalloc

JPH::TrackedVehicleController

TrackedVehicleController

JPH::TrackedVehicleControllerSettings

TrackedVehicleControllerSettings

JPH::TransformedShape

TransformedShape ConstTransformedShape

JPH::Triangle

Triangle

JPH::TriangleShape

TriangleShape

JPH::TriangleShapeSettings

TriangleShapeSettings

JPH::TwoBodyConstraint

TwoBodyConstraint TwoBodyConstraintRef ConstTwoBodyConstraint

JPH::TwoBodyConstraintSettings

TwoBodyConstraintSettings TwoBodyConstraintSettingsRef

JPH::UVec4

UVec4

JPH::Vec3

Vec3 Vec3Arg

JPH::Vec4

Vec4 Vec4Arg

JPH::VehicleAntiRollBar

VehicleAntiRollBar

JPH::VehicleCollisionTester

VehicleCollisionTester VehicleCollisionTesterRef

JPH::VehicleCollisionTesterCastCylinder

VehicleCollisionTesterCastCylinder VehicleCollisionTesterCastCylinderRef

JPH::VehicleCollisionTesterCastSphere

VehicleCollisionTesterCastSphere VehicleCollisionTesterCastSphereRef

JPH::VehicleCollisionTesterRay

VehicleCollisionTesterRay VehicleCollisionTesterRayRef

JPH::VehicleConstraint

VehicleConstraint VehicleConstraintRef

JPH::VehicleConstraintSettings

VehicleConstraintSettings

JPH::VehicleController

VehicleController

JPH::VehicleControllerSettings

VehicleControllerSettings VehicleControllerSettingsRef

JPH::VehicleDifferentialSettings

VehicleDifferentialSettings

JPH::VehicleEngine

VehicleEngine

JPH::VehicleEngineSettings

VehicleEngineSettings

JPH::VehicleTrackSettings

VehicleTrackSettings

JPH::VehicleTransmission

VehicleTransmission

JPH::VehicleTransmissionSettings

VehicleTransmissionSettings

JPH::Wheel

Wheel

JPH::WheelSettings

WheelSettings

JPH::WheelSettingsTV

WheelSettingsTv WheelSettingsTvRef

JPH::WheelSettingsWV

WheelSettingsWv WheelSettingsWvRef

JPH::WheelTV

WheelTv

JPH::WheelWV

WheelWv

JPH::WheeledVehicleController

WheeledVehicleController

JPH::WheeledVehicleControllerSettings

WheeledVehicleControllerSettings