Convert math structures to Typescript Native

Author: ahoenerBE

src/core/types/index.ts

@@ -0,0 +1,3 @@
+export type PartialNullable<T> = {
+    [P in keyof T]?: T[P] | null;
+};

src/math/Pose.js renamed to src/math/Pose.ts

@@ -2,36 +2,43 @@
  * @fileOverview
  * @author David Gossow - [email protected]
  */
+import Vector3, {type IVector3} from "./Vector3.js";
+import Quaternion, {type IQuaternion} from "./Quaternion.js";
+import {type ITransform} from "./Transform.js";
+import type {PartialNullable} from "../core/types/index.js";
 
-import Vector3 from './Vector3.js';
-import Quaternion from './Quaternion.js';
-import Transform from './Transform.js';
+export interface IPose {
+  /**
+   * The ROSLIB.Vector3 describing the position.
+   */
+  position: IVector3;
+  /**
+   * The ROSLIB.Quaternion describing the orientation.
+   */
+  orientation: IQuaternion;
+}
 
 /**
  * A Pose in 3D space. Values are copied into this object.
  */
-export default class Pose {
-  /**
-   * @param {Object} [options]
-   * @param {Vector3} [options.position] - The ROSLIB.Vector3 describing the position.
-   * @param {Quaternion} [options.orientation] - The ROSLIB.Quaternion describing the orientation.
-   */
-  constructor(options) {
-    options = options || {};
-    // copy the values into this object if they exist
-    options = options || {};
-    this.position = new Vector3(options.position);
-    this.orientation = new Quaternion(options.orientation);
+export default class Pose implements IPose {
+
+  position: Vector3;
+  orientation: Quaternion;
+
+  constructor(options?: PartialNullable<IPose>) {
+    this.position = new Vector3(options?.position);
+    this.orientation = new Quaternion(options?.orientation);
   }
   /**
    * Apply a transform against this pose.
    *
    * @param {Transform} tf - The transform to be applied.
    */
-  applyTransform(tf) {
+  applyTransform(tf: ITransform) {
     this.position.multiplyQuaternion(tf.rotation);
     this.position.add(tf.translation);
-    var tmp = tf.rotation.clone();
+    const tmp = new Quaternion(tf.rotation);
     tmp.multiply(this.orientation);
     this.orientation = tmp;
   }
@@ -40,16 +47,16 @@ export default class Pose {
    *
    * @returns {Pose} The cloned pose.
    */
-  clone() {
+  clone(): Pose {
     return new Pose(this);
   }
   /**
    * Multiply this pose with another pose without altering this pose.
    *
    * @returns {Pose} The result of the multiplication.
    */
-  multiply(pose) {
-    var p = pose.clone();
+  multiply(pose: Pose): Pose {
+    const p = pose.clone();
     p.applyTransform({
       rotation: this.orientation,
       translation: this.position
@@ -61,8 +68,8 @@ export default class Pose {
    *
    * @returns {Pose} The inverse of the pose.
    */
-  getInverse() {
-    var inverse = this.clone();
+  getInverse(): Pose {
+    const inverse = this.clone();
     inverse.orientation.invert();
     inverse.position.multiplyQuaternion(inverse.orientation);
     inverse.position.x *= -1;

src/math/Quaternion.js renamed to src/math/Quaternion.ts

@@ -2,46 +2,63 @@
  * @fileOverview
  * @author David Gossow - [email protected]
  */
+import type { PartialNullable } from "../core/types/index.js";
+
+export interface IQuaternion {
+  /**
+   * The x value.
+   */
+  x: number;
+  /**
+   * The y value.
+   */
+  y: number;
+  /**
+   * The z value.
+   */
+  z: number;
+  /**
+   * The w value.
+   */
+  w: number;
+}
 
 /**
  * A Quaternion.
  */
-export default class Quaternion {
-  /**
-   * @param {Object} [options]
-   * @param {number|null} [options.x=0] - The x value.
-   * @param {number|null} [options.y=0] - The y value.
-   * @param {number|null} [options.z=0] - The z value.
-   * @param {number|null} [options.w=1] - The w value.
-   */
-  constructor(options) {
-    options = options || {};
-    this.x = options.x || 0;
-    this.y = options.y || 0;
-    this.z = options.z || 0;
-    this.w = typeof options.w === 'number' ? options.w : 1;
+export default class Quaternion implements IQuaternion {
+  x: number;
+  y: number;
+  z: number;
+  w: number;
+
+  constructor(options?: PartialNullable<IQuaternion> | null) {
+    this.x = options?.x ?? 0;
+    this.y = options?.y ?? 0;
+    this.z = options?.z ?? 0;
+    this.w = typeof options?.w === 'number' ? options.w : 1;
   }
   /**
    * Perform a conjugation on this quaternion.
    */
-  conjugate() {
+  conjugate(): void {
     this.x *= -1;
     this.y *= -1;
     this.z *= -1;
   }
   /**
    * Return the norm of this quaternion.
    */
-  norm() {
+  norm(): number {
     return Math.sqrt(
       this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w
     );
   }
   /**
    * Perform a normalization on this quaternion.
    */
-  normalize() {
-    var l = Math.sqrt(
+  normalize(): void {
+    let l = Math.sqrt(
       this.x * this.x + this.y * this.y + this.z * this.z + this.w * this.w
     );
     if (l === 0) {
@@ -60,7 +77,7 @@ export default class Quaternion {
   /**
    * Convert this quaternion into its inverse.
    */
-  invert() {
+  invert(): void {
     this.conjugate();
     this.normalize();
   }
@@ -69,11 +86,11 @@ export default class Quaternion {
    *
    * @param {Quaternion} q - The quaternion to multiply with.
    */
-  multiply(q) {
-    var newX = this.x * q.w + this.y * q.z - this.z * q.y + this.w * q.x;
-    var newY = -this.x * q.z + this.y * q.w + this.z * q.x + this.w * q.y;
-    var newZ = this.x * q.y - this.y * q.x + this.z * q.w + this.w * q.z;
-    var newW = -this.x * q.x - this.y * q.y - this.z * q.z + this.w * q.w;
+  multiply(q: IQuaternion): void {
+    const newX = this.x * q.w + this.y * q.z - this.z * q.y + this.w * q.x;
+    const newY = -this.x * q.z + this.y * q.w + this.z * q.x + this.w * q.y;
+    const newZ = this.x * q.y - this.y * q.x + this.z * q.w + this.w * q.z;
+    const newW = -this.x * q.x - this.y * q.y - this.z * q.z + this.w * q.w;
     this.x = newX;
     this.y = newY;
     this.z = newZ;
@@ -84,7 +101,7 @@ export default class Quaternion {
    *
    * @returns {Quaternion} The cloned quaternion.
    */
-  clone() {
+  clone(): Quaternion {
     return new Quaternion(this);
   }
 }

src/math/Transform.js

@@ -0,0 +1,41 @@
+/**
+ * @fileOverview
+ * @author David Gossow - [email protected]
+ */
+
+import Vector3, { type IVector3 } from './Vector3.js';
+import Quaternion, { type IQuaternion } from './Quaternion.js';
+
+export interface ITransform {
+  /**
+   * The ROSLIB.Vector3 describing the translation.
+   */
+  translation: IVector3;
+  /**
+   * The ROSLIB.Quaternion describing the rotation.
+   */
+  rotation: IQuaternion;
+}
+
+/**
+ * A Transform in 3-space. Values are copied into this object.
+ */
+export default class Transform implements ITransform {
+
+  translation: Vector3;
+  rotation: Quaternion;
+
+  constructor(options: ITransform) {
+    // Copy the values into this object if they exist
+    this.translation = new Vector3(options.translation);
+    this.rotation = new Quaternion(options.rotation);
+  }
+  /**
+   * Clone a copy of this transform.
+   *
+   * @returns {Transform} The cloned transform.
+   */
+  clone(): Transform {
+    return new Transform(this);
+  }
+}

src/math/Transform.ts

@@ -2,31 +2,44 @@
  * @fileOverview
  * @author David Gossow - [email protected]
  */
+import { type IQuaternion} from "./Quaternion.js";
+import type { PartialNullable } from "../core/types/index.js";
 
-import Quaternion from './Quaternion.js';
+
+export interface IVector3 {
+  /**
+   * The x value.
+   */
+  x: number;
+  /**
+   * The y value.
+   */
+  y: number;
+  /**
+   * The z value.
+   */
+  z: number;
+}
 
 /**
  * A 3D vector.
  */
-export default class Vector3 {
-  /**
-   * @param {Object} [options]
-   * @param {number} [options.x=0] - The x value.
-   * @param {number} [options.y=0] - The y value.
-   * @param {number} [options.z=0] - The z value.
-   */
-  constructor(options) {
-    options = options || {};
-    this.x = options.x || 0;
-    this.y = options.y || 0;
-    this.z = options.z || 0;
+export default class Vector3 implements IVector3 {
+  x: number;
+  y: number;
+  z: number;
+
+  constructor(options?: PartialNullable<IVector3> | null) {
+    this.x = options?.x ?? 0;
+    this.y = options?.y ?? 0;
+    this.z = options?.z ?? 0;
   }
   /**
    * Set the values of this vector to the sum of itself and the given vector.
    *
    * @param {Vector3} v - The vector to add with.
    */
-  add(v) {
+  add(v: IVector3): void {
     this.x += v.x;
     this.y += v.y;
     this.z += v.z;
@@ -36,7 +49,7 @@ export default class Vector3 {
    *
    * @param {Vector3} v - The vector to subtract with.
    */
-  subtract(v) {
+  subtract(v: IVector3): void {
     this.x -= v.x;
     this.y -= v.y;
     this.z -= v.z;
@@ -46,11 +59,11 @@ export default class Vector3 {
    *
    * @param {Quaternion} q - The quaternion to multiply with.
    */
-  multiplyQuaternion(q) {
-    var ix = q.w * this.x + q.y * this.z - q.z * this.y;
-    var iy = q.w * this.y + q.z * this.x - q.x * this.z;
-    var iz = q.w * this.z + q.x * this.y - q.y * this.x;
-    var iw = -q.x * this.x - q.y * this.y - q.z * this.z;
+  multiplyQuaternion(q: IQuaternion) {
+    const ix = q.w * this.x + q.y * this.z - q.z * this.y;
+    const iy = q.w * this.y + q.z * this.x - q.x * this.z;
+    const iz = q.w * this.z + q.x * this.y - q.y * this.x;
+    const iw = -q.x * this.x - q.y * this.y - q.z * this.z;
     this.x = ix * q.w + iw * -q.x + iy * -q.z - iz * -q.y;
     this.y = iy * q.w + iw * -q.y + iz * -q.x - ix * -q.z;
     this.z = iz * q.w + iw * -q.z + ix * -q.y - iy * -q.x;
@@ -60,7 +73,7 @@ export default class Vector3 {
    *
    * @returns {Vector3} The cloned vector.
    */
-  clone() {
+  clone(): Vector3 {
     return new Vector3(this);
   }
 }