Convert Material, ContactMaterial to TS

Author: codynova

readme.md

@@ -12,5 +12,6 @@ import { World } from 'cannon-es'
 
 - Finish TS conversion
 - Revisit math/Transform.ts types
+- Revisit material/ContactMaterial.ts constructor assertions
 - Correct & standardize JSDoc comments
-- Test possible performance improvements by converting matrices to Maps (instead of Arrays)
+- Test possible performance improvements by converting matrices to Maps (instead of Arrays)

src/collision/Broadphase.ts

@@ -185,7 +185,7 @@ const Broadphase_collisionPairs_relpos = new Vec3()
  * @param {Array} pairs1
  * @param {Array} pairs2
  */
-const Broadphase_makePairsUnique_temp: { [key: string]: any } = { keys: [] }
+const Broadphase_makePairsUnique_temp: Record<string, any> = { keys: [] }
 
 const Broadphase_makePairsUnique_p1: Body[] = []
 const Broadphase_makePairsUnique_p2: Body[] = []

src/collision/ObjectCollisionMatrix.ts

@@ -6,7 +6,7 @@ import { Body } from '../objects/Body'
  * @constructor
  */
 export class ObjectCollisionMatrix {
-  matrix: { [key: string]: boolean } // The matrix storage.
+  matrix: Record<string, boolean> // The matrix storage.
 
   constructor() {
     this.matrix = {}

src/material/ContactMaterial.js src/material/ContactMaterial.tssrc/material/ContactMaterial.js renamed to src/material/ContactMaterial.ts

@@ -1,5 +1,15 @@
+import { Material } from '../material/Material'
 import { Utils } from '../utils/Utils'
 
+type ContactMaterialOptions = {
+  friction?: number
+  restitution?: number
+  contactEquationStiffness?: number
+  contactEquationRelaxation?: number
+  frictionEquationStiffness?: number
+  frictionEquationRelaxation?: number
+}
+
 /**
  * Defines what happens when two materials meet.
  * @class ContactMaterial
@@ -15,7 +25,18 @@ import { Utils } from '../utils/Utils'
  * @param {Number} [options.frictionEquationRelaxation=3]
  */
 export class ContactMaterial {
-  constructor(m1, m2, options) {
+  id: number // Identifier of this material.
+  materials: [Material, Material] // Participating materials.
+  friction: number // Friction coefficient.
+  restitution: number // Restitution coefficient.
+  contactEquationStiffness: number // Stiffness of the produced contact equations.
+  contactEquationRelaxation: number // Relaxation time of the produced contact equations.
+  frictionEquationStiffness: number // Stiffness of the produced friction equations.
+  frictionEquationRelaxation: number // Relaxation time of the produced friction equations
+
+  static idCounter: number;
+
+  constructor(m1: Material, m2: Material, options: ContactMaterialOptions) {
     options = Utils.defaults(options, {
       friction: 0.3,
       restitution: 0.3,
@@ -25,54 +46,14 @@ export class ContactMaterial {
       frictionEquationRelaxation: 3,
     })
 
-    /**
-     * Identifier of this material
-     * @property {Number} id
-     */
     this.id = ContactMaterial.idCounter++
-
-    /**
-     * Participating materials
-     * @property {Array} materials
-     * @todo  Should be .materialA and .materialB instead
-     */
     this.materials = [m1, m2]
-
-    /**
-     * Friction coefficient
-     * @property {Number} friction
-     */
-    this.friction = options.friction
-
-    /**
-     * Restitution coefficient
-     * @property {Number} restitution
-     */
-    this.restitution = options.restitution
-
-    /**
-     * Stiffness of the produced contact equations
-     * @property {Number} contactEquationStiffness
-     */
-    this.contactEquationStiffness = options.contactEquationStiffness
-
-    /**
-     * Relaxation time of the produced contact equations
-     * @property {Number} contactEquationRelaxation
-     */
-    this.contactEquationRelaxation = options.contactEquationRelaxation
-
-    /**
-     * Stiffness of the produced friction equations
-     * @property {Number} frictionEquationStiffness
-     */
-    this.frictionEquationStiffness = options.frictionEquationStiffness
-
-    /**
-     * Relaxation time of the produced friction equations
-     * @property {Number} frictionEquationRelaxation
-     */
-    this.frictionEquationRelaxation = options.frictionEquationRelaxation
+    this.friction = options.friction!
+    this.restitution = options.restitution!
+    this.contactEquationStiffness = options.contactEquationStiffness!
+    this.contactEquationRelaxation = options.contactEquationRelaxation!
+    this.frictionEquationStiffness = options.frictionEquationStiffness!
+    this.frictionEquationRelaxation = options.frictionEquationRelaxation!
   }
 }
 

src/material/Material.js

@@ -0,0 +1,37 @@
+type MaterialOptions = {
+  friction?: number
+  restitution?: number
+}
+
+/**
+ * Defines a physics material.
+ * @class Material
+ * @constructor
+ * @param {object} [options]
+ * @author schteppe
+ */
+export class Material {
+  name: string // Material name.
+  id: number // Material id.
+  friction: number // Friction for this material. If non-negative, it will be used instead of the friction given by ContactMaterials. If there's no matching ContactMaterial, the value from .defaultContactMaterial in the World will be used.
+  restitution: number // Restitution for this material. If non-negative, it will be used instead of the restitution given by ContactMaterials. If there's no matching ContactMaterial, the value from .defaultContactMaterial in the World will be used.
+
+  static idCounter: number
+
+  constructor(options: MaterialOptions | string = {}) {
+    let name = ''
+
+    // Backwards compatibility fix
+    if (typeof options === 'string') {
+      name = options
+      options = {}
+    }
+
+    this.name = name
+    this.id = Material.idCounter++
+    this.friction = typeof options.friction !== 'undefined' ? options.friction : -1
+    this.restitution = typeof options.restitution !== 'undefined' ? options.restitution : -1
+  }
+}
+
+Material.idCounter = 0

src/material/Material.ts

@@ -40,7 +40,7 @@ export class Shape {
   collisionResponse: boolean // Whether to produce contact forces when in contact with other bodies. Note that contacts will be generated, but they will be disabled.
   collisionFilterGroup: number
   collisionFilterMask: number
-  material: Material
+  material: Material | null
   body: Body | null
 
   static idCounter: number

src/shapes/Shape.ts

@@ -4,7 +4,7 @@
  * @constructor
  */
 export class EventTarget {
-  private _listeners: { [key: string]: Function[] } | undefined
+  private _listeners: Record<string, Function[]> | undefined
 
   constructor() {}
 

src/utils/EventTarget.ts

@@ -199,7 +199,7 @@ export class Octree extends OctreeNode {
 
   constructor(aabb: AABB, options: { maxDepth?: number } = {}) {
     super({ root: null, aabb })
-    this.maxDepth = options.maxDepth || 8
+    this.maxDepth = typeof options.maxDepth !== 'undefined' ? options.maxDepth : 8
   }
 }
 

src/utils/Octree.ts

@@ -8,7 +8,7 @@ export function Utils() {}
  * @param  {object} defaults An object containing default values.
  * @return {object} The modified options object.
  */
-Utils.defaults = (options: any = {}, defaults: { [key: string]: any }): { [key: string]: any } => {
+Utils.defaults = (options: Record<string, any> = {}, defaults: Record<string, any>): Record<string, any> => {
   for (let key in defaults) {
     if (!(key in options)) {
       options[key] = defaults[key]