@luma.gl/engine 8.5.8 → 8.6.0-alpha.2

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,35 @@
+// CORE
+export type {AnimationLoopProps, AnimationProps} from './lib/animation-loop';
+export {default as AnimationLoop} from './lib/animation-loop';
+export {RenderLoop} from './lib/render-loop';
+
+export type {ModelProps} from './lib/model';
+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 type {ConeGeometryProps} from './geometries/cone-geometry';
+export {ConeGeometry} from './geometries/cone-geometry';
+export type {CubeGeometryProps} from './geometries/cube-geometry';
+export {CubeGeometry} from './geometries/cube-geometry';
+export type {CylinderGeometryProps} from './geometries/cylinder-geometry';
+export {CylinderGeometry} from './geometries/cylinder-geometry';
+export type {IcoSphereGeometryProps} from './geometries/ico-sphere-geometry';
+export {IcoSphereGeometry} from './geometries/ico-sphere-geometry';
+export type {PlaneGeometryProps} from './geometries/plane-geometry';
+export {PlaneGeometry} from './geometries/plane-geometry';
+export type {SphereGeometryProps} from './geometries/sphere-geometry';
+export {SphereGeometry} from './geometries/sphere-geometry';
+export type {TruncatedConeGeometryProps} from './geometries/truncated-cone-geometry';
+export {TruncatedConeGeometry} 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';