@luma.gl/engine 8.5.7 → 8.6.0-alpha.1

package/src/animation/{key-frames.js → key-frames.ts}

@@ -1,18 +1,20 @@
-/** @type {import('@luma.gl/engine').KeyFrames} */
+// keyframes
+export type KeyFrame<T> = [number, T];
 
-export class KeyFrames {
-  constructor(keyFrames) {
-    this._lastTime = -1;
-    this.startIndex = -1;
-    this.endIndex = -1;
-    this.factor = 0;
-    this.times = [];
-    this.values = [];
+export class KeyFrames<T = number> {
+  startIndex: number = -1;
+  endIndex: number = -1;
+  factor: number = 0;
+  times: number[] = [];
+  values: T[] = [];
+  private _lastTime = -1;
+
+  constructor(keyFrames: KeyFrame<T>[]) {
     this.setKeyFrames(keyFrames);
     this.setTime(0);
   }
 
-  setKeyFrames(keyFrames) {
+  setKeyFrames(keyFrames: KeyFrame<T>[]): void {
     const numKeys = keyFrames.length;
     this.times.length = numKeys;
     this.values.length = numKeys;
@@ -25,7 +27,7 @@ export class KeyFrames {
     this._calculateKeys(this._lastTime);
   }
 
-  setTime(time) {
+  setTime(time: number): void {
     time = Math.max(0, time);
 
     if (time !== this._lastTime) {
@@ -34,23 +36,23 @@ export class KeyFrames {
     }
   }
 
-  getStartTime() {
+  getStartTime(): number {
     return this.times[this.startIndex];
   }
 
-  getEndTime() {
+  getEndTime(): number {
     return this.times[this.endIndex];
   }
 
-  getStartData() {
+  getStartData(): T {
     return this.values[this.startIndex];
   }
 
-  getEndData() {
+  getEndData(): T {
     return this.values[this.endIndex];
   }
 
-  _calculateKeys(time) {
+  _calculateKeys(time: number): void {
     let index = 0;
     const numKeys = this.times.length;
 

package/src/animation/{timeline.js → timeline.ts}

@@ -1,20 +1,56 @@
+// luma.gl, MIT license
+
+/**
+ * Timeline channel properties
+ * @param delay = 0;
+ * @param duration = Number.POSITIVE_INFINITY;
+ * @param rate = 1
+ * @param repeat = 1
+ */
+ export type ChannelOptions = {
+  delay?: number
+  duration?: number
+  rate?: number
+  repeat?: number
+}
+
+export type AnimationOptions = {
+  setTime: (time: number) => void
+}
+
+ type Channel = {
+  time: number
+  delay: number
+  duration: number
+  rate: number
+  repeat: number
+}
+
+type Animation = {
+  channel: number;
+  animation: {
+    setTime: (time: number) => void
+  }
+}
+
 let channelHandles = 1;
 let animationHandles = 1;
 
 export class Timeline {
+  time: number = 0;
+  channels = new Map<number, Channel>();
+  animations = new Map<number, Animation>();
+  playing: boolean = false;
+  lastEngineTime: number = -1;
+
   constructor() {
-    this.time = 0;
-    this.channels = new Map();
-    this.animations = new Map();
-    this.playing = false;
-    this.lastEngineTime = -1;
   }
 
-  addChannel(props) {
+  addChannel(props: ChannelOptions): number {
     const {delay = 0, duration = Number.POSITIVE_INFINITY, rate = 1, repeat = 1} = props;
 
     const handle = channelHandles++;
-    const channel = {
+    const channel: Channel = {
       time: 0,
       delay,
       duration,
@@ -27,7 +63,7 @@ export class Timeline {
     return handle;
   }
 
-  removeChannel(handle) {
+  removeChannel(handle: number): void {
     this.channels.delete(handle);
 
     for (const [animationHandle, animation] of this.animations) {
@@ -37,7 +73,7 @@ export class Timeline {
     }
   }
 
-  isFinished(handle) {
+  isFinished(handle: number): boolean {
     const channel = this.channels.get(handle);
     if (channel === undefined) {
       return false;
@@ -46,7 +82,7 @@ export class Timeline {
     return this.time >= channel.delay + channel.duration * channel.repeat;
   }
 
-  getTime(handle) {
+  getTime(handle?: number): number {
     if (handle === undefined) {
       return this.time;
     }
@@ -60,7 +96,7 @@ export class Timeline {
     return channel.time;
   }
 
-  setTime(time) {
+  setTime(time: number): void {
     this.time = Math.max(0, time);
 
     const channels = this.channels.values();
@@ -75,20 +111,20 @@ export class Timeline {
     }
   }
 
-  play() {
+  play(): void {
     this.playing = true;
   }
 
-  pause() {
+  pause(): void {
     this.playing = false;
     this.lastEngineTime = -1;
   }
 
-  reset() {
+  reset(): void {
     this.setTime(0);
   }
 
-  attachAnimation(animation, channelHandle) {
+  attachAnimation(animation: AnimationOptions, channelHandle: number): number {
     const animationHandle = animationHandles++;
 
     this.animations.set(animationHandle, {
@@ -101,11 +137,11 @@ export class Timeline {
     return animationHandle;
   }
 
-  detachAnimation(handle) {
+  detachAnimation(handle: number): void {
     this.animations.delete(handle);
   }
 
-  update(engineTime) {
+  update(engineTime: number): void {
     if (this.playing) {
       if (this.lastEngineTime === -1) {
         this.lastEngineTime = engineTime;
@@ -115,7 +151,7 @@ export class Timeline {
     }
   }
 
-  _setChannelTime(channel, time) {
+  _setChannelTime(channel: Channel, time: number): void {
     const offsetTime = time - channel.delay;
     const totalDuration = channel.duration * channel.repeat;
     // Note(Tarek): Don't loop on final repeat.

package/src/bundle.ts

@@ -0,0 +1,4 @@
+// @ts-nocheck
+const moduleExports = require('./index');
+globalThis.luma = globalThis.luma || {};
+module.exports = Object.assign(globalThis.luma, moduleExports);

package/src/geometries/{cone-geometry.js → cone-geometry.ts}

@@ -1,8 +1,14 @@
-import TruncatedConeGeometry from './truncated-cone-geometry';
+import {TruncatedConeGeometry} from './truncated-cone-geometry';
 import {uid} from '@luma.gl/webgl';
 
-export default class ConeGeometry extends TruncatedConeGeometry {
-  constructor(props = {}) {
+export type ConeGeometryProps = {
+  id?: string;
+  radius?: number;
+  cap?: boolean;
+};
+
+export class ConeGeometry extends TruncatedConeGeometry {
+  constructor(props: ConeGeometryProps = {}) {
     const {id = uid('cone-geometry'), radius = 1, cap = true} = props;
     super({
       ...props,

package/src/geometries/{cube-geometry.js → cube-geometry.ts}

@@ -1,6 +1,23 @@
 import Geometry from '../geometry/geometry';
 import {uid} from '@luma.gl/webgl';
 
+export type CubeGeometryProps = {
+  id?: string;
+  attributes?
+};
+
+export class CubeGeometry extends Geometry {
+  constructor(props: CubeGeometryProps = {}) {
+    const {id = uid('cube-geometry')} = props;
+    super({
+      ...props,
+      id,
+      indices: {size: 1, value: new Uint16Array(CUBE_INDICES)},
+      attributes: {...ATTRIBUTES, ...props.attributes}
+    });
+  }
+}
+
 // prettier-ignore
 const CUBE_INDICES = new Uint16Array([
   0, 1, 2, 0, 2, 3, 4, 5, 6, 4, 6, 7, 8, 9, 10, 8, 10, 11, 12, 13,
@@ -55,15 +72,3 @@ const ATTRIBUTES = {
   NORMAL: {size: 3, value: new Float32Array(CUBE_NORMALS)},
   TEXCOORD_0: {size: 2, value: new Float32Array(CUBE_TEX_COORDS)}
 };
-
-export default class CubeGeometry extends Geometry {
-  constructor(props = {}) {
-    const {id = uid('cube-geometry')} = props;
-    super({
-      ...props,
-      id,
-      indices: {size: 1, value: new Uint16Array(CUBE_INDICES)},
-      attributes: {...ATTRIBUTES, ...props.attributes}
-    });
-  }
-}

package/src/geometries/cylinder-geometry.ts

@@ -0,0 +1,20 @@
+import {TruncatedConeGeometry} from './truncated-cone-geometry';
+import {uid} from '@luma.gl/webgl';
+
+export type CylinderGeometryProps = {
+  id?: string;
+  radius?: number;
+  attributes?
+};
+
+export class CylinderGeometry extends TruncatedConeGeometry {
+  constructor(props: CylinderGeometryProps = {}) {
+    const {id = uid('cylinder-geometry'), radius = 1} = props;
+    super({
+      ...props,
+      id,
+      bottomRadius: radius,
+      topRadius: radius
+    });
+  }
+}

package/src/geometries/{ico-sphere-geometry.js → ico-sphere-geometry.ts}

@@ -7,8 +7,15 @@ import {uid} from '@luma.gl/webgl';
 const ICO_POSITIONS = [-1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 1, 0, -1, 0, 1, 0, 0];
 const ICO_INDICES = [3, 4, 5, 3, 5, 1, 3, 1, 0, 3, 0, 4, 4, 0, 2, 4, 2, 5, 2, 0, 1, 5, 2, 1];
 
-export default class IcoSphereGeometry extends Geometry {
-  constructor(props = {}) {
+export type IcoSphereGeometryProps = {
+  id?: string;
+  radius?: number;
+  iterations?: number;
+  attributes?
+};
+
+export class IcoSphereGeometry extends Geometry {
+  constructor(props: IcoSphereGeometryProps = {}) {
     const {id = uid('ico-sphere-geometry')} = props;
     const {indices, attributes} = tesselateIcosaHedron(props);
     super({
@@ -20,7 +27,7 @@ export default class IcoSphereGeometry extends Geometry {
   }
 }
 
-function tesselateIcosaHedron(props) {
+function tesselateIcosaHedron(props: IcoSphereGeometryProps) {
   const {iterations = 0} = props;
 
   const PI = Math.PI;

package/src/geometries/{plane-geometry.js → plane-geometry.ts}

@@ -2,8 +2,17 @@ import Geometry from '../geometry/geometry';
 import {unpackIndexedGeometry} from '../geometry/geometry-utils';
 import {uid} from '@luma.gl/webgl';
 
-export default class PlaneGeometry extends Geometry {
-  constructor(props = {}) {
+export type PlaneGeometryProps = {
+  id?: string;
+  radius?: number;
+  attributes?
+};
+
+// Primitives inspired by TDL http://code.google.com/p/webglsamples/,
+// copyright 2011 Google Inc. new BSD License
+// (http://www.opensource.org/licenses/bsd-license.php).
+export class PlaneGeometry extends Geometry {
+  constructor(props: PlaneGeometryProps = {}) {
     const {id = uid('plane-geometry')} = props;
 
     const {indices, attributes} = tesselatePlane(props);
@@ -16,10 +25,6 @@ export default class PlaneGeometry extends Geometry {
   }
 }
 
-// Primitives inspired by TDL http://code.google.com/p/webglsamples/,
-// copyright 2011 Google Inc. new BSD License
-// (http://www.opensource.org/licenses/bsd-license.php).
-/* eslint-disable max-statements, complexity */
 /* eslint-disable complexity, max-statements */
 function tesselatePlane(props) {
   const {type = 'x,y', offset = 0, flipCull = false, unpack = false} = props;

package/src/geometries/{sphere-geometry.js → sphere-geometry.ts}

@@ -1,8 +1,19 @@
 import Geometry from '../geometry/geometry';
 import {uid} from '@luma.gl/webgl';
 
-export default class SphereGeometry extends Geometry {
-  constructor(props = {}) {
+export type SphereGeometryProps = {
+  id?: string;
+  radius?: number;
+  nlat?: number;
+  nlong?: number;
+  attributes?
+};
+
+// Primitives inspired by TDL http://code.google.com/p/webglsamples/,
+// copyright 2011 Google Inc. new BSD License
+// (http://www.opensource.org/licenses/bsd-license.php).
+export class SphereGeometry extends Geometry {
+  constructor(props: SphereGeometryProps = {}) {
     const {id = uid('sphere-geometry')} = props;
     const {indices, attributes} = tesselateSphere(props);
     super({
@@ -14,13 +25,9 @@ export default class SphereGeometry extends Geometry {
   }
 }
 
-// Primitives inspired by TDL http://code.google.com/p/webglsamples/,
-// copyright 2011 Google Inc. new BSD License
-// (http://www.opensource.org/licenses/bsd-license.php).
 /* eslint-disable max-statements, complexity */
-function tesselateSphere(props) {
+function tesselateSphere(props: SphereGeometryProps) {
   const {nlat = 10, nlong = 10} = props;
-  let {radius = 1} = props;
 
   const startLat = 0;
   const endLat = Math.PI;
@@ -30,10 +37,7 @@ function tesselateSphere(props) {
   const longRange = endLong - startLong;
   const numVertices = (nlat + 1) * (nlong + 1);
 
-  if (typeof radius === 'number') {
-    const value = radius;
-    radius = (n1, n2, n3, u, v) => value;
-  }
+  const radius = (n1, n2, n3, u, v) => props.radius || 1;
 
   const positions = new Float32Array(numVertices * 3);
   const normals = new Float32Array(numVertices * 3);

package/src/geometries/{truncated-cone-geometry.js → truncated-cone-geometry.ts}

@@ -7,8 +7,20 @@ const INDEX_OFFSETS = {
   z: [1, 2, 0]
 };
 
-export default class TruncatedConeGeometry extends Geometry {
-  constructor(props = {}) {
+export type TruncatedConeGeometryProps = {
+  id?: string;
+  topRadius?: number;
+  bottomRadius?: number;
+  topCap?: boolean;
+  bottomCap?: boolean;
+  attributes?
+};
+
+// Primitives inspired by TDL http://code.google.com/p/webglsamples/,
+// copyright 2011 Google Inc. new BSD License
+// (http://www.opensource.org/licenses/bsd-license.php).
+export class TruncatedConeGeometry extends Geometry {
+  constructor(props: TruncatedConeGeometryProps = {}) {
     const {id = uid('truncated-code-geometry')} = props;
     const {indices, attributes} = tesselateTruncatedCone(props);
     super({
@@ -20,9 +32,6 @@ export default class TruncatedConeGeometry extends Geometry {
   }
 }
 
-// Primitives inspired by TDL http://code.google.com/p/webglsamples/,
-// copyright 2011 Google Inc. new BSD License
-// (http://www.opensource.org/licenses/bsd-license.php).
 /* eslint-disable max-statements, complexity */
 function tesselateTruncatedCone(props) {
   const {

package/src/geometry/{geometry-utils.js → geometry-utils.ts}

@@ -1,3 +1,5 @@
+import type Geometry from './geometry';
+
 export function unpackIndexedGeometry(geometry) {
   const {indices, attributes} = geometry;
   if (!indices) {

package/src/geometry/{geometry.js → geometry.ts}

@@ -1,57 +1,70 @@
+// luma.gl, MIT license
+import GL from '@luma.gl/constants';
 import {uid, assert} from '@luma.gl/webgl';
 
-// Rendering primitives - specify how to extract primitives from vertices.
-// NOTE: These are numerically identical to the corresponding WebGL/OpenGL constants
-export const DRAW_MODE = {
-  POINTS: 0x0000, // draw single points.
-  LINES: 0x0001, // draw lines. Each vertex connects to the one after it.
-  LINE_LOOP: 0x0002, // draw lines. Each set of two vertices is treated as a separate line segment.
-  LINE_STRIP: 0x0003, // draw a connected group of line segments from the first vertex to the last
-  TRIANGLES: 0x0004, // draw triangles. Each set of three vertices creates a separate triangle.
-  TRIANGLE_STRIP: 0x0005, // draw a connected group of triangles.
-  TRIANGLE_FAN: 0x0006 // draw a connected group of triangles.
-  // Each vertex connects to the previous and the first vertex in the fan.
+/**
+ * Rendering primitives - "opology" specifies how to extract primitives from vertices.
+ */
+export type Topology =
+  GL.POINTS |  // draw single points.
+  GL.LINES |  // draw lines. Each vertex connects to the one after it.
+  GL.LINE_LOOP |  // draw lines. Each set of two vertices is treated as a separate line segment.
+  GL.LINE_STRIP |  // draw a connected group of line segments from the first vertex to the last
+  GL.TRIANGLES |  // draw triangles. Each set of three vertices creates a separate triangle.
+  GL.TRIANGLE_STRIP |  // draw a connected group of triangles.
+  GL.TRIANGLE_FAN // draw a connected group of triangles.
+  ;
+
+export type GeometryProps = {
+  id?: string;
+  drawMode?: Topology,
+  attributes?: {},
+  indices?;
+  vertexCount?: number
 };
 
 export default class Geometry {
-  static get DRAW_MODE() {
-    return DRAW_MODE;
-  }
-
-  constructor(props = {}) {
+  /** @deprecated */
+  static DRAW_MODE = {
+    POINTS: GL.POINTS,  // draw single points.
+    LINES: GL.LINES,  // draw lines. Each vertex connects to the one after it.
+    LINE_LOOP: GL.LINE_LOOP,  // draw lines. Each set of two vertices is treated as a separate line segment.
+    LINE_STRIP: GL.LINE_STRIP,  // draw a connected group of line segments from the first vertex to the last
+    TRIANGLES: GL.TRIANGLES,  // draw triangles. Each set of three vertices creates a separate triangle.
+    TRIANGLE_STRIP: GL.TRIANGLE_STRIP,  // draw a connected group of triangles.
+    TRIANGLE_FAN: GL.TRIANGLE_FAN // draw a connected group of triangles.
+  };
+
+  readonly id: string;
+  readonly drawMode: Topology = GL.TRIANGLES;
+
+  vertexCount: number;
+  attributes = {};
+  indices;
+  userData: Record<string, any> = {};
+
+  constructor(props: GeometryProps = {}) {
     const {
       id = uid('geometry'),
-      drawMode = DRAW_MODE.TRIANGLES,
+      drawMode = GL.TRIANGLES,
       attributes = {},
       indices = null,
       vertexCount = null
     } = props;
 
     this.id = id;
-    this.drawMode = drawMode | 0;
-    this.attributes = {};
-    this.userData = {};
+    this.drawMode = drawMode;
 
     this._setAttributes(attributes, indices);
 
     this.vertexCount = vertexCount || this._calculateVertexCount(this.attributes, this.indices);
-
-    // stubRemovedMethods(this, [
-    //   'setNeedsRedraw', 'needsRedraw', 'setAttributes'
-    // ], 'Immutable');
-
-    // stubRemovedMethods(this, [
-    //   'hasAttribute', 'getAttribute', 'getArray'
-    // ], 'Use geometry.attributes and geometry.indices');
-
-    // deprecateMethods(this, ['getAttributes'])
   }
 
   get mode() {
     return this.drawMode;
   }
 
-  getVertexCount() {
+  getVertexCount(): number {
     return this.vertexCount;
   }
 
@@ -62,7 +75,7 @@ export default class Geometry {
 
   // PRIVATE
 
-  _print(attributeName) {
+  _print(attributeName): string {
     return `Geometry ${this.id} attribute ${attributeName}`;
   }
 
@@ -71,7 +84,7 @@ export default class Geometry {
   // type: indices, vertices, uvs
   // size: elements per vertex
   // target: WebGL buffer type (string or constant)
-  _setAttributes(attributes, indices) {
+  _setAttributes(attributes, indices): this {
     if (indices) {
       this.indices = ArrayBuffer.isView(indices) ? {value: indices, size: 1} : indices;
     }
@@ -108,7 +121,7 @@ export default class Geometry {
     return this;
   }
 
-  _calculateVertexCount(attributes, indices) {
+  _calculateVertexCount(attributes, indices): number {
     if (indices) {
       return indices.value.length;
     }

package/src/index.ts

@@ -0,0 +1,30 @@
+// CORE
+export {default as AnimationLoop} from './lib/animation-loop';
+export {default as Model} from './lib/model';
+export {default as ProgramManager} from './lib/program-manager';
+export {default as Transform} from './transform/transform';
+
+// Geometries
+export {default as Geometry} from './geometry/geometry';
+
+// Primitives
+export {ConeGeometry, ConeGeometryProps} from './geometries/cone-geometry';
+export {CubeGeometry, CubeGeometryProps} from './geometries/cube-geometry';
+export {CylinderGeometry, CylinderGeometryProps} from './geometries/cylinder-geometry';
+export {
+  IcoSphereGeometry,
+  IcoSphereGeometryProps
+} from './geometries/ico-sphere-geometry';
+export {PlaneGeometry, PlaneGeometryProps} from './geometries/plane-geometry';
+export {SphereGeometry, SphereGeometryProps} from './geometries/sphere-geometry';
+export {
+  TruncatedConeGeometry,
+  TruncatedConeGeometryProps
+} from './geometries/truncated-cone-geometry';
+
+// Animation
+export {Timeline} from './animation/timeline';
+export {KeyFrames} from './animation/key-frames';
+
+// Utils
+export {default as ClipSpace} from './utils/clip-space';