ohzi-core 12.2.0 → 12.3.0

package/src/KeyboardInput.js

@@ -1,11 +1,19 @@
+// @ts-check
 class KeyboardInput
 {
+  /**
+   * @param {HTMLElement} container
+   */
   init(container)
   {
     this.ctrlz_pressed = false;
     this.ctrlz_fired = false;
 
+    /**
+     * @type {{[key:string]:{key_name: string, pressed: boolean, down: boolean, fired: boolean, released: boolean}}}
+     */
     this.keys = {};
+    /** @type {string[]} */
     this.keys_keys = [];
     this.container = container;
 
@@ -13,6 +21,9 @@ class KeyboardInput
     this.container.addEventListener('keyup', this.on_key_up.bind(this), false);
   }
 
+  /**
+   * @param {KeyboardEvent} e
+   */
   on_key_down(e)
   {
     if (e.keyCode === 90 && e.ctrlKey && !this.ctrlz_fired)
@@ -27,6 +38,9 @@ class KeyboardInput
     }
   }
 
+  /**
+   * @param {KeyboardEvent} e
+   */
   on_key_up(e)
   {
     this.release_key(e.code);
@@ -43,6 +57,9 @@ class KeyboardInput
     }
   }
 
+  /**
+   * @param {string} key_name
+   */
   release_key(key_name)
   {
     const key = this.keys[key_name];
@@ -65,6 +82,9 @@ class KeyboardInput
     }
   }
 
+  /**
+   * @param {string} key_name
+   */
   press_key(key_name)
   {
     const key = this.keys[key_name];
@@ -79,6 +99,10 @@ class KeyboardInput
     }
   }
 
+  /**
+   * @param {string} key_name
+   * @returns {boolean}
+   */
   is_key_pressed(key_name)
   {
     const key = this.keys[key_name];
@@ -89,6 +113,10 @@ class KeyboardInput
     return false;
   }
 
+  /**
+   * @param {string} key_name
+   * @returns {boolean}
+   */
   is_key_down(key_name)
   {
     const key = this.keys[key_name];
@@ -99,6 +127,10 @@ class KeyboardInput
     return false;
   }
 
+  /**
+   * @param {string} key_name
+   * @returns {boolean}
+   */
   is_key_released(key_name)
   {
     const key = this.keys[key_name];
@@ -110,6 +142,9 @@ class KeyboardInput
     return false;
   }
 
+  /**
+   * @param {string} key
+   */
   register_key(key)
   {
     this.keys[key] =
@@ -117,12 +152,16 @@ class KeyboardInput
         key_name: key,
         pressed: false,
         down: false,
-        fired: false
+        fired: false,
+        released: false
       };
 
     this.keys_keys = Object.keys(this.keys);
   }
 
+  /**
+   * @param {string} key_name
+   */
   unregister_key(key_name)
   {
     delete this.keys[key_name];

package/src/OS.js

@@ -1,4 +1,4 @@
-
+// @ts-check
 class OS
 {
   init()

package/src/OScreen.js

@@ -1,22 +1,27 @@
+// @ts-check
 import { Vector2 } from 'three';
 
 class OScreen
 {
   init()
   {
-    this.width = window.innerWidth;
-    this.height = window.innerHeight;
+    this.width = 1;
+    this.height = 1;
 
     this.position = new Vector2();
 
-    this.render_width = window.innerWidth;
-    this.render_height = window.innerHeight;
+    this.render_width = 1;
+    this.render_height = 1;
     this.width_height = new Vector2(this.width, this.height);
 
     this.dpr = 1;
     this.pixel_size = new Vector2(1 / this.width, 1 / this.height);
   }
 
+  /**
+   * @param {number} x
+   * @param {number} y
+   */
   update_position(x, y)
   {
     this.position.set(x, y);
@@ -27,6 +32,10 @@ class OScreen
     this.size_changed = false;
   }
 
+  /**
+   * @param {number} width
+   * @param {number} height
+   */
   update_size(width, height)
   {
     this.width = width;
@@ -43,6 +52,9 @@ class OScreen
     this.size_changed = true;
   }
 
+  /**
+   * @param {Vector2} vector2
+   */
   apply_pixel_density_v2(vector2)
   {
     vector2.multiplyScalar(1 / this.dpr);
@@ -50,6 +62,9 @@ class OScreen
     return vector2;
   }
 
+  /**
+   * @param {number} value
+   */
   apply_pixel_density(value)
   {
     return value * (1 / this.dpr);

package/src/OrthographicCamera.js

@@ -1,8 +1,17 @@
+// @ts-check
 import { Color } from 'three';
 import { OrthographicCamera as TOrthographicCamera } from 'three';
 
 class OrthographicCamera extends TOrthographicCamera
 {
+  /**
+   * @param {number} left
+   * @param {number} right
+   * @param {number} top
+   * @param {number} bottom
+   * @param {number} near
+   * @param {number} far
+   */
   constructor(left, right, top, bottom, near, far)
   {
     super(left, right, top, bottom, near, far);
@@ -11,6 +20,10 @@ class OrthographicCamera extends TOrthographicCamera
     this.clear_alpha = 1;
   }
 
+  /**
+   * @param {OrthographicCamera} camera
+   * @returns {this}
+   */
   copy(camera)
   {
     super.copy(camera);

package/src/PerspectiveCamera.js

@@ -1,8 +1,15 @@
+// @ts-check
 import { Color } from 'three';
 import { PerspectiveCamera as TPerspectiveCamera } from 'three';
 
 class PerspectiveCamera extends TPerspectiveCamera
 {
+  /**
+   * @param {number} fov
+   * @param {number} aspect
+   * @param {number} near
+   * @param {number} far
+   */
   constructor(fov, aspect, near, far)
   {
     super(fov, aspect, near, far);
@@ -11,6 +18,10 @@ class PerspectiveCamera extends TPerspectiveCamera
     this.clear_alpha = 1;
   }
 
+  /**
+   * @param {PerspectiveCamera} camera
+   * @returns {this}
+   */
   copy(camera)
   {
     super.copy(camera);

package/src/ReflectionPlaneContext.js

@@ -1,4 +1,5 @@
-import { Vector3 } from 'three';
+// @ts-check
+import { BufferGeometry, Vector3 } from 'three'; // eslint-disable-line
 
 class ReflectionPlaneContext
 {
@@ -8,6 +9,9 @@ class ReflectionPlaneContext
     this.target_position = new Vector3();
   }
 
+  /**
+   * @param {BufferGeometry} geometry
+   */
   set_target_geometry(geometry)
   {
     this.target_geometry = geometry;

package/src/RenderLayers.js

@@ -1,4 +1,4 @@
-
+// @ts-check
 class RenderLayers
 {
   constructor()

package/src/RenderLoop.js

@@ -1,12 +1,18 @@
+// @ts-check
 import { BaseApplication } from './BaseApplication';
 import { Debug } from './Debug';
 import { Time } from './Time';
 import { TransitionManager } from './view_components/TransitionManager';
 import { ViewComponentManager } from './view_components/ViewComponentManager';
 import { ViewManager } from './view_components/ViewManager';
+import { Graphics, KeyboardInput } from './index'; // eslint-disable-line no-unused-vars
 
 class RenderLoop
 {
+  /**
+   * @param {BaseApplication} target_application
+   * @param {Graphics} graphics
+   */
   constructor(target_application, graphics, input)
   {
     target_application = target_application || new BaseApplication();
@@ -96,6 +102,9 @@ class RenderLoop
     this.graphics._renderer.setAnimationLoop(null);
   }
 
+  /**
+   * @param {BaseApplication} new_state
+   */
   set_state(new_state)
   {
     this.target_application.on_exit(this);

package/src/RenderOrder.js

@@ -1,4 +1,4 @@
-
+// @ts-check
 class RenderOrder
 {
   constructor()

package/src/ResourceContainer.js

@@ -1,11 +1,26 @@
+// @ts-check
+import { Object3D, Texture, } from 'three'; // eslint-disable-line
+
+/**
+ * @typedef {Object3D | Texture} Resource
+ */
+
 class ResourceContainer
 {
   init()
   {
+    /** @type {Record<string, Resource>} */
     this.resources = {};
+
+    /** @type {Record<string, any>} */
     this.resources_by_url = {};
   }
 
+  /**
+   * @param {string} name
+   * @param {string} url
+   * @param {Resource} resource
+   */
   set_resource(name, url, resource)
   {
     const urls = Object.keys(this.resources_by_url);
@@ -21,11 +36,17 @@ class ResourceContainer
     }
   }
 
+  /**
+   * @param {string} name
+   */
   get_resource(name)
   {
     return this.resources[name];
   }
 
+  /**
+   * @param {string} name
+   */
   get(name)
   {
     return this.resources[name];

package/src/SceneManager.js

@@ -1,4 +1,5 @@
-import { Scene } from 'three';
+// @ts-check
+import { Scene, Mesh } from 'three'; // eslint-disable-line no-unused-vars
 
 class SceneManager
 {
@@ -8,11 +9,15 @@ class SceneManager
     this._current.name = 'default_scene';
   }
 
-  add_scene(name)
+  /**
+   * @param {string} name
+   */
+  add_scene(name) // eslint-disable-line no-unused-vars
   {
 
   }
 
+  /** @type {Scene} */
   get current()
   {
     return this._current;
@@ -25,12 +30,17 @@ class SceneManager
 
   dispose()
   {
-    this.current.traverse(child =>
+    this.current.traverse((/** @type {Mesh} */ child) =>
     {
       if (child.geometry)
       {
         child.geometry.dispose();
-        child.material.dispose();
+        const mat = child.material;
+        if ('disppose' in mat && typeof (mat.disppose) === 'function')
+        {
+          // @ts-ignore
+          mat.dispose();
+        }
       }
     });
 

package/src/Screen.js

@@ -0,0 +1,71 @@
+// @ts-check
+import { Vector2 } from 'three'; // eslint-disable-line
+import { OScreen } from './OScreen';
+
+class Screen
+{
+  init()
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    OScreen.init();
+  }
+
+  /**
+   * @param {number} x
+   * @param {number} y
+   */
+  update_position(x, y)
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    OScreen.update_position(x, y);
+  }
+
+  update()
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    OScreen.update();
+  }
+
+  /**
+   * @param {number} width
+   * @param {number} height
+   */
+  update_size(width, height)
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    OScreen.update_size(width, height);
+  }
+
+  /**
+   * @param {Vector2} vector2
+   */
+  apply_pixel_density_v2(vector2)
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    return OScreen.apply_pixel_density_v2(vector2);
+  }
+
+  /**
+   * @param {number} value
+   */
+  apply_pixel_density(value)
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    return OScreen.apply_pixel_density(value);
+  }
+
+  get_pixel_size()
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    return OScreen.get_pixel_size();
+  }
+
+  get aspect_ratio()
+  {
+    console.warn('Screen Singleton is deprecated. Please use OScreen.');
+    return OScreen.aspect_ratio;
+  }
+}
+
+const screen = new Screen();
+export { screen as Screen };

package/src/Time.js

@@ -1,3 +1,4 @@
+// @ts-check
 import { Vector2 } from 'three';
 import { Clock } from 'three';
 
@@ -61,6 +62,9 @@ class Time
     return this.smooth_delta_time;
   }
 
+  /**
+   * @param {number} value
+   */
   __set_frame_interpolation(value)
   {
     this.__frame_interpolation_t = value;

package/src/UI.js

@@ -1,15 +1,18 @@
+// @ts-check
 import { CameraManager } from './CameraManager';
 import { Graphics } from './Graphics';
 
 import { Vector2 } from 'three';
 import { Scene } from 'three';
-import { OrthographicCamera } from 'three';
+import { OrthographicCamera } from './OrthographicCamera';
+import { UIElement } from './components/UIElement'; // eslint-disable-line
 
 class UI
 {
   init(input)
   {
     this.input = input;
+    /** @type {UIElement[]} */
     this.ui_elements = [];
     this._tmp_normalized_pos = new Vector2();
     this.ss_scene = new Scene();
@@ -23,6 +26,9 @@ class UI
     this.ss_camera = new OrthographicCamera(-1, 1, 1, -1, -100, 100);
   }
 
+  /**
+   * @param {UIElement} elem
+   */
   delete_element(elem)
   {
     const index = this.ui_elements.indexOf(elem);
@@ -37,6 +43,9 @@ class UI
     elem.dispose();
   }
 
+  /**
+   * @param {UIElement} elem
+   */
   add_screen_space_element(elem)
   {
     this.ui_elements.push(elem);
@@ -45,6 +54,9 @@ class UI
     elem.set_screen_space_coordinate_system();
   }
 
+  /**
+   * @param {UIElement} elem
+   */
   add_world_space_element(elem)
   {
     this.ui_elements.push(elem);
@@ -68,6 +80,9 @@ class UI
     }
   }
 
+  /**
+   * @param {Graphics} renderer
+   */
   render(renderer)
   {
     // renderer.render_ui(this.scene);

package/src/action_sequencer/ActionEvent.js

@@ -1,6 +1,11 @@
-
+// @ts-check
 class ActionEvent
 {
+  /**
+   * @param {string} name
+   * @param {string} method
+   * @param {string} args
+   */
   constructor(name, method, args)
   {
     this.name = name;

package/src/action_sequencer/ActionInterpolator.js

@@ -1,7 +1,12 @@
+// @ts-check
+import { Vector3 } from 'three'; // eslint-disable-line no-unused-vars
 import { EasingFunctions } from '../utilities/EasingFunctions';
 
 class ActionInterpolator
 {
+  /**
+   * @param {import('../utilities/EasingFunctions').EasingFunctionType | function} easing_function
+   */
   constructor(easing_function = 'linear')
   {
     this.easing_function = undefined;
@@ -14,11 +19,20 @@ class ActionInterpolator
     {
       this.easing_function = easing_function;
     }
+
+    this.attribute_name = '';
+    /** @type {number | Vector3} */
+    this.from = 0;
+    /** @type {number | Vector3} */
+    this.to = 1;
   }
 
-  update(context, t)
+  /**
+   * @param {any} context
+   * @param {number} t
+   */
+  update(context, t) // eslint-disable-line no-unused-vars
   {
-
   }
 }