ohzi-core 12.2.0 → 12.2.1

package/src/components/MultiLinePath.js

@@ -1,18 +1,22 @@
-import { Line } from '../Line';
+// @ts-check
+import { Line } from './Line';
 
-import { Object3D } from 'three';
+import { Object3D, Vector3 } from 'three'; // eslint-disable-line no-unused-vars
 
 class MultiLinePath extends Object3D
 {
-  constructor(paths, webgl)
+  /**
+   * @param {Array<Vector3[]>} paths
+   */
+  constructor(paths)
   {
     super();
 
     this.paths = [];
     for (let i = 0; i < paths.length; i++)
     {
-      const line = new Line(paths[i], webgl);
-      this.paths.push = line;
+      const line = new Line(paths[i]);
+      this.paths.push(line);
       this.add(line);
     }
   }

package/src/components/MultiLineText2D.js

@@ -1,3 +1,4 @@
+// @ts-check
 import { Text2D } from './Text2D';
 
 import { Object3D } from 'three';
@@ -5,7 +6,14 @@ import { Vector2 } from 'three';
 
 class MultiLineText2D extends Object3D
 {
-  constructor(text_array, font, color, pivot, is_static)
+  /**
+   * @param {string[]} text_array
+   * @param {string} [font]
+   * @param {string | number} [color]
+   * @param {Vector2} [pivot]
+   * @param {boolean} [is_static]
+   */
+  constructor(text_array, font, color, pivot, is_static) // eslint-disable-line no-unused-vars
   {
     super();
 
@@ -45,11 +53,14 @@ class MultiLineText2D extends Object3D
   {
     for (let i = 0; i < this.text_array.length; i++)
     {
-      this.text_array[i].size = value;
+      this.text_array[i].size.set(value, value, value);
     }
     this.update_text_positions();
   }
 
+  /**
+   * @returns {string[]}
+   */
   get texts()
   {
     return [];

package/src/components/ObjectAxis.js

@@ -1,3 +1,4 @@
+// @ts-check
 import { Arrow } from '../primitives/Arrow';
 
 import { Object3D } from 'three';
@@ -5,6 +6,10 @@ import { Vector3 } from 'three';
 
 class ObjectAxis extends Object3D
 {
+  /**
+   * @param {Object3D} obj
+   * @param {number} [size]
+   */
   constructor(obj, size)
   {
     super();

package/src/components/ObjectOrientedBoundingBox.js

@@ -1,9 +1,12 @@
-
+// @ts-check
 import { Vector3 } from 'three';
 import { Quaternion } from 'three';
 
 class ObjectOrientedBoundingBox
 {
+  /**
+   * @param {Vector3[]} points
+   */
   constructor(points)
   {
     let degrees = 0;
@@ -104,6 +107,9 @@ class ObjectOrientedBoundingBox
     //   Debug.draw_line(center.clone().add(deep_left),center.clone().add(deep_right));
   }
 
+  /**
+   * @param {Vector3[]} points
+   */
   get_center(points)
   {
     const v = new Vector3();
@@ -115,6 +121,10 @@ class ObjectOrientedBoundingBox
     return v;
   }
 
+  /**
+   * @param {Vector3} min
+   * @param {Vector3} max
+   */
   box_volume(min, max)
   {
     const difference = max.clone().sub(min);
@@ -126,6 +136,9 @@ class ObjectOrientedBoundingBox
     return this.max.clone().sub(this.min);
   }
 
+  /**
+   * @param {Vector3} point
+   */
   is_inside_XZ(point)
   {
     const pos = point.clone();
@@ -144,6 +157,9 @@ class ObjectOrientedBoundingBox
     }
   }
 
+  /**
+   * @param {Vector3} reference_point
+   */
   closest_point_on_bounds(reference_point)
   {
     const force = new Vector3();
@@ -167,6 +183,9 @@ class ObjectOrientedBoundingBox
     return this.local_to_world_dir(force);
   }
 
+  /**
+   * @param {Vector3} point
+   */
   world_to_local(point)
   {
     const pos = point.clone().sub(this.center);
@@ -174,6 +193,9 @@ class ObjectOrientedBoundingBox
     return pos;
   }
 
+  /**
+   * @param {Vector3} point
+   */
   local_to_world(point)
   {
     const pos = point.clone();
@@ -182,6 +204,9 @@ class ObjectOrientedBoundingBox
     return pos;
   }
 
+  /**
+   * @param {Vector3} direction
+   */
   local_to_world_dir(direction)
   {
     const dir = direction.clone();

package/src/components/PlaneHelper.js

@@ -1,4 +1,4 @@
-
+// @ts-check
 import { Object3D } from 'three';
 import { MeshBasicMaterial } from 'three';
 import { PlaneGeometry } from 'three';

package/src/components/Shape2D.js

@@ -1,16 +1,21 @@
+// @ts-check
 import { GeometryEdgeVisualizer } from './GeometryEdgeVisualizer';
 
-import { Mesh } from 'three';
+import { Mesh, Vector2 } from 'three'; // eslint-disable-line no-unused-vars
 import { Shape } from 'three';
-import { ShapeBufferGeometry } from 'three';
+import { ShapeGeometry } from 'three';
 import { MeshBasicMaterial } from 'three';
 
 class Shape2D extends Mesh
 {
+  /**
+   * @param {Vector2[]} points_2D
+   * @param {boolean} show_edges
+   */
   constructor(points_2D, show_edges)
   {
     const shape = new Shape(points_2D);
-    const geometry = new ShapeBufferGeometry(shape);
+    const geometry = new ShapeGeometry(shape);
     geometry.rotateX(3.14 / 2);
 
     const material = new MeshBasicMaterial({ color: 0xff0000 });
@@ -26,6 +31,9 @@ class Shape2D extends Mesh
     }
   }
 
+  /**
+   * @param {ShapeGeometry} geometry
+   */
   invert_normals(geometry)
   {
     const indices = geometry.index.array;

package/src/components/Shape3D.js

@@ -1,12 +1,18 @@
+// @ts-check
 import { GeometryEdgeVisualizer } from './GeometryEdgeVisualizer';
 
-import { Mesh } from 'three';
+import { Mesh, Vector2 } from 'three'; // eslint-disable-line no-unused-vars
 import { Shape } from 'three';
-import { ExtrudeBufferGeometry } from 'three';
+import { ExtrudeGeometry } from 'three';
 import { MeshNormalMaterial } from 'three';
 
 class Shape3D extends Mesh
 {
+  /**
+   * @param {Vector2[]} points_2D
+   * @param {boolean} show_edges
+   * @param {number} [height]
+   */
   constructor(points_2D, show_edges, height)
   {
     const shape = new Shape(points_2D);
@@ -21,11 +27,11 @@ class Shape3D extends Mesh
       bevelSegments: 1
     };
 
-    const geometry = new ExtrudeBufferGeometry(shape, extrudeSettings);
+    const geometry = new ExtrudeGeometry(shape, extrudeSettings);
     geometry.rotateX(3.14 / 2);
     geometry.translate(0, height, 0);
 
-    const material = new MeshNormalMaterial({ color: 0xff0000 });
+    const material = new MeshNormalMaterial();
     super(geometry, material);
 
     if (show_edges)

package/src/components/Text2D.js

@@ -1,14 +1,22 @@
+// @ts-check
 import { WorldImage } from './WorldImage';
 import { SimpleTextDrawer } from '../canvas_drawer/SimpleTextDrawer';
 
-import { LinearMipMapLinearFilter } from 'three';
+import { LinearMipMapLinearFilter, Vector2 } from 'three'; // eslint-disable-line no-unused-vars
 import { LinearFilter } from 'three';
 
 class Text2D extends WorldImage
 {
-  constructor(text, font, color, pivot, is_static)
+  /**
+   * @param {string} text
+   * @param {string} font
+   * @param {string | Number} color
+   * @param {Vector2} pivot
+   * @param {boolean} [is_static]
+   */
+  constructor(text, font, color, pivot, is_static) // eslint-disable-line no-unused-vars
   {
-    const simple_text_drawer = new SimpleTextDrawer(is_static);
+    const simple_text_drawer = new SimpleTextDrawer();
 
     const draw_settings = {
       font: font,

package/src/components/UIElement.js

@@ -1,4 +1,4 @@
-
+// @ts-check
 import { OScreen } from '../OScreen';
 
 import { UIElementMaterial } from '../materials/UIElementMaterial';
@@ -11,21 +11,29 @@ import { OnMouseEnter } from '../ui/ui_element_state/OnMouseEnter';
 import { OnMouseExit } from '../ui/ui_element_state/OnMouseExit';
 import { OnMouseHover } from '../ui/ui_element_state/OnMouseHover';
 
-import { Mesh } from 'three';
+import { Mesh, Texture } from 'three'; // eslint-disable-line no-unused-vars
 import { PlaneGeometry } from 'three';
 import { Vector2 } from 'three';
 import { Vector3 } from 'three';
 import { NearestFilter } from 'three';
 import { Box2 } from 'three';
+import { UIElementState } from '../ui/ui_element_state/UIElementState'; // eslint-disable-line no-unused-vars
 
 class UIElement extends Mesh
 {
-  constructor(vert, frag)
+  /**
+   * @param {string} [vert]
+   * @param {string} [frag]
+   */
+  constructor(vert, frag) // eslint-disable-line no-unused-vars
   {
-    super(new PlaneGeometry(1, 1), new UIElementMaterial());
+    const material = new UIElementMaterial();
+    super(new PlaneGeometry(1, 1), material);
+    this.material = material;
 
     this.is_clickable = false;
 
+    /** @type {WorldSpacePosition | ScreenSpacePosition} */
     this.position_strategy = new WorldSpacePosition();
     this.current_state = new OnIdle();
 
@@ -54,6 +62,9 @@ class UIElement extends Mesh
     this.pixel_offset = new Vector2();
   }
 
+  /**
+   * @param {number} value
+   */
   set_render_order(value)
   {
     this.renderOrder = value;
@@ -64,12 +75,18 @@ class UIElement extends Mesh
     return this.material.uniforms._PivotPoint.value;
   }
 
+  /**
+   * @param {Vector2} offset
+   */
   set_pixel_offset(offset)
   {
     this.pixel_offset.copy(offset);
     this.material.uniforms._PixelOffset.value.copy(offset);
   }
 
+  /**
+   *@param {UIElementState} new_state
+   */
   set_state(new_state)
   {
     this.current_state.on_exit(this);
@@ -77,6 +94,7 @@ class UIElement extends Mesh
     this.current_state.on_enter(this);
   }
 
+  // @ts-ignore
   get position()
   {
     return this._position;
@@ -117,6 +135,9 @@ class UIElement extends Mesh
     this.position_strategy = new ScreenSpacePosition();
   }
 
+  /**
+   * @param {Texture} texture
+   */
   set_texture(texture)
   {
     texture.minFilter = NearestFilter;
@@ -130,6 +151,9 @@ class UIElement extends Mesh
     this.visible = true;
   }
 
+  /**
+   * @param {Vector2} normalized_mouse_pos
+   */
   update_state(normalized_mouse_pos)
   {
     this.material.uniforms._ScreenSize.value.set(OScreen.width, OScreen.height);
@@ -140,6 +164,9 @@ class UIElement extends Mesh
     this.current_state.update(this, normalized_mouse_pos);
   }
 
+  /**
+   * @param {Vector2} normalized_mouse_pos
+   */
   is_mouse_over(normalized_mouse_pos)
   {
     this.screen_pos_tmp.copy(this.cached_NDC_position);
@@ -155,6 +182,9 @@ class UIElement extends Mesh
     return rect.containsPoint(this.mouse_pos_tmp);
   }
 
+  /**
+   * @param {Vector2} projected_pos
+   */
   to_screen_position(projected_pos)
   {
     projected_pos.x = (projected_pos.x * 0.5 + 0.5) * OScreen.width  + this.pixel_offset.x;
@@ -168,6 +198,9 @@ class UIElement extends Mesh
     return pos;
   }
 
+  /**
+   * @param {Vector2} screen_pos
+   */
   set_screen_space_position(screen_pos)
   {
     this.position.x = (screen_pos.x / OScreen.width) * 2 - 1;
@@ -185,6 +218,9 @@ class UIElement extends Mesh
     this.material.dispose();
   }
 
+  /**
+   * @param {Vector2} [vector2]
+   */
   get_size(vector2)
   {
     if (vector2)

package/src/components/UpdatableMaterialMesh.js

@@ -1,16 +1,24 @@
-import { Mesh } from 'three';
+// @ts-check
+import { BufferGeometry, Material, Mesh } from 'three'; // eslint-disable-line no-unused-vars
 
 class UpdatableMaterialMesh extends Mesh
 {
+  /**
+   * @param {BufferGeometry} geometry
+   * @param {Material} material
+   */
   constructor(geometry, material)
   {
     super(geometry, material);
-
+    this.material = material;
     const self = this;
 
     this.onBeforeRender = () =>
     {
-      self.material.update();
+      if ('update' in self.material && typeof self.material.update === 'function')
+      {
+        self.material.update();
+      }
     };
   }
 }

package/src/components/WorldImage.js

@@ -1,7 +1,10 @@
+// @ts-check
+// @ts-ignore
 import basic_texture_vert from '../shaders/basic_texture/basic_texture.vert';
+// @ts-ignore
 import basic_texture_frag from '../shaders/basic_texture/basic_texture.frag';
 
-import { Mesh } from 'three';
+import { Mesh, Texture } from 'three'; // eslint-disable-line no-unused-vars
 import { Vector2 } from 'three';
 import { ShaderMaterial } from 'three';
 import { DoubleSide } from 'three';
@@ -10,6 +13,10 @@ import { Vector3 } from 'three';
 
 class WorldImage extends Mesh
 {
+  /**
+   * @param {Texture} texture
+   * @param {Vector2} [pivot]
+   */
   constructor(texture, pivot)
   {
     pivot = pivot || new Vector2(0, 0);
@@ -36,6 +43,7 @@ class WorldImage extends Mesh
 
     this.tmp_bb_size = new Vector3();
     this.geometry.boundingBox.getSize(this.tmp_bb_size);
+    this.material = material;
   }
 
   update_texture()
@@ -57,7 +65,7 @@ class WorldImage extends Mesh
 
   set size(value)
   {
-    this.scale.set(value, value, value);
+    this.scale.copy(value);
     this.material.uniforms._Scale.value = value;
   }
 

package/src/index.js

@@ -1,3 +1,4 @@
+// @ts-check
 import { BaseApplication } from './BaseApplication';
 import { AddMaterial } from './materials/AddMaterial';
 import { BaseShaderMaterial } from './materials/BaseShaderMaterial';
@@ -33,6 +34,7 @@ import { UnrealBloomRender } from './render_mode/UnrealBloomRender';
 import { VRRender } from './render_mode/VRRender';
 import { RenderLoop } from './RenderLoop';
 import { SceneManager } from './SceneManager';
+import { Screen } from './Screen';
 import { Time } from './Time';
 import { UI } from './UI';
 import { DrawIOAnimationSheet } from './view_components/transition/DrawIOAnimationSheet';
@@ -127,6 +129,6 @@ export {
   ModelUtilities, NormalAORender,
   NormalRender, NumberInterpolator, ObjectUtilities, OBJLoader, OMath, OrthographicCamera, OrthographicFrustumPointFitter, OS, OScreen, ParticleAttribute,
   ParticlePositionAttribute, PerspectiveCamera, PerspectiveFrustumPointFitter, PointArrayLoader, RegularLoadingState, RenderLoop, ResourceBatch,
-  ResourceContainer, RGBETextureLoader, SceneManager, SDFTextBatch, SimpleTextDrawer, Sphere, StringUtilities, Text2D, TextLoader, TextureLoader, Time, TimeUtilities, TransitionManager, TransitionTable, UI, UIElement, UnrealBloomComposeMaterial, UnrealBloomRender, UpdatableMaterialMesh, Validation, VectorInterpolator, VerticalPlane, VideoLoader, ViewComponent,
+  ResourceContainer, RGBETextureLoader, SceneManager, Screen, SDFTextBatch, SimpleTextDrawer, Sphere, StringUtilities, Text2D, TextLoader, TextureLoader, Time, TimeUtilities, TransitionManager, TransitionTable, UI, UIElement, UnrealBloomComposeMaterial, UnrealBloomRender, UpdatableMaterialMesh, Validation, VectorInterpolator, VerticalPlane, VideoLoader, ViewComponent,
   ViewComponentManager, ViewManager, VRRender, WorldImage
 };

package/src/loaders/AsyncAbstractLoader.js

@@ -1,7 +1,13 @@
+// @ts-check
 import { ResourceContainer } from '../ResourceContainer';
 
 class AsyncAbstractLoader
 {
+  /**
+   * @param {string} name
+   * @param {any[]} assets
+   * @param {Worker} worker
+   */
   constructor(name, assets, worker)
   {
     this.resource_container = ResourceContainer;
@@ -106,6 +112,9 @@ class AsyncAbstractLoader
     this.worker.postMessage({ type: 'assets', loader_name: this.name, data: this.assets });
   }
 
+  /**
+   * @param {MessageEvent} e
+   */
   on_message(e)
   {
     const message = e.data;
@@ -118,6 +127,9 @@ class AsyncAbstractLoader
     }
   }
 
+  /**
+   * @param {any} resources
+   */
   __on_assets_loaded(resources)
   {
     this.worker.removeEventListener('message', this.bound_on_message);
@@ -135,9 +147,13 @@ class AsyncAbstractLoader
     }
   }
 
+  /**
+   * @returns {any[]}
+   */
   __setup_loaders()
   {
     console.warn('Not implemented');
+    return [];
   }
 }
 

package/src/loaders/AsyncObjectsLoader.js

@@ -1,3 +1,4 @@
+// @ts-check
 import { GLTFDRACOLoader } from '../resource_loader/GLTFDRACOLoader';
 import { GLTFLoader } from '../resource_loader/GLTFLoader';
 import { ResourceContainer } from '../ResourceContainer';
@@ -5,6 +6,11 @@ import { AsyncAbstractLoader } from './AsyncAbstractLoader';
 
 class AsyncObjectsLoader extends AsyncAbstractLoader
 {
+  /**
+   * @param {string} scene_name
+   * @param {any[]} assets
+   * @param {Worker} worker
+   */
   constructor(scene_name, assets, worker)
   {
     super(scene_name, assets, worker);

package/src/primitives/Arrow.js

@@ -1,9 +1,15 @@
+// @ts-check
 import { ConeGeometry, CylinderGeometry, Mesh, MeshBasicMaterial, Vector3 } from 'three';
 
 import * as BufferGeometryUtils from 'three/examples/jsm/utils/BufferGeometryUtils.js';
 
 class Arrow extends Mesh
 {
+  /**
+   * @param {string | number} [color]
+   * @param {number} [length]
+   * @param {Vector3} [dir]
+   */
   constructor(color, length, dir)
   {
     color = color || '#FF0000';

package/src/primitives/Cube.js

@@ -1,10 +1,15 @@
-
+// @ts-check
 import { Vector3, Mesh } from 'three';
 import { BoxGeometry } from 'three';
 import { MeshBasicMaterial } from 'three';
 
 class Cube extends Mesh
 {
+  /**
+   * @param {Vector3} [size]
+   * @param {Vector3} [segments]
+   * @param {number | string} [color]
+   */
   constructor(size, segments, color)
   {
     size     = size || new Vector3(1, 1, 1);

package/src/primitives/HorizontalPlane.js

@@ -1,9 +1,16 @@
-import { Mesh } from 'three';
+// @ts-check
+import { Material, Mesh } from 'three'; // eslint-disable-line no-unused-vars
 import { MeshBasicMaterial } from 'three';
 import { PlaneGeometry } from 'three';
 
 class HorizontalPlane extends Mesh
 {
+  /**
+   * @param {number} [width]
+   * @param {number} [height]
+   * @param {number | string} [color]
+   * @param {Material} [material]
+   */
   constructor(width, height, color, material)
   {
     width = width || 1;

package/src/primitives/Sphere.js

@@ -2,6 +2,10 @@ import { Mesh, MeshBasicMaterial, SphereGeometry } from 'three';
 
 class Sphere extends Mesh
 {
+  /**
+   * @param {number} radius
+   * @param {number | string} color
+   */
   constructor(radius, color)
   {
     color = color || '#FF0000';
@@ -9,6 +13,9 @@ class Sphere extends Mesh
     const geometry = new SphereGeometry(radius, 64, 64);
     const material = new MeshBasicMaterial({ color: color });
     super(geometry, material);
+    this.radius = radius;
+    this.color = color;
+    this.center = this.position;
   }
 }
 

package/src/primitives/VerticalPlane.js

@@ -1,9 +1,16 @@
-import { Mesh } from 'three';
+// @ts-check
+import { Material, Mesh } from 'three'; // eslint-disable-line no-unused-vars
 import { PlaneGeometry } from 'three';
 import { MeshBasicMaterial } from 'three';
 
 class VerticalPlane extends Mesh
 {
+  /**
+   * @param {number} [width]
+   * @param {number} [height]
+   * @param {number | string} [color]
+   * @param {Material} [material]
+   */
   constructor(width, height, color, material)
   {
     width = width || 1;

package/src/ui/ui_element_state/OnIdle.js

@@ -1,3 +1,4 @@
+import { UIElement } from '../../components/UIElement'; // eslint-disable-line no-unused-vars
 import { UIElementState } from './UIElementState';
 
 class OnIdle extends UIElementState
@@ -7,6 +8,10 @@ class OnIdle extends UIElementState
     super();
   }
 
+  /**
+   * @param {UIElement} ui_element
+   * @param {Vector2} normalized_mouse_position
+   */
   update(ui_element, normalized_mouse_position)
   {
     if (ui_element.is_mouse_over(normalized_mouse_position))