Browse Source

Gizmo Meshes - Linting Fixes

Dave Gould 4 years ago
parent
commit
2d6326b752

+ 3 - 0
src/Gizmos/gizmo.ts

@@ -298,6 +298,9 @@ export class Gizmo implements IDisposable {
 
     /**
      * Subscribes to pointer up, down, and hover events. Used for responsive gizmos.
+     * @param gizmoLayer The utility layer the gizmo will be added to
+     * @param gizmoAxisCache Gizmo axis definition used for reactive gizmo UI
+     * @returns {Observer<PointerInfo>} pointerObserver
      */
     public static GizmoAxisPointerObserver(gizmoLayer: UtilityLayerRenderer, gizmoAxisCache: Map<Mesh, GizmoAxisCache>): Observer<PointerInfo> {
 

+ 10 - 8
src/Gizmos/gizmoManager.ts

@@ -5,7 +5,6 @@ import { Scene, IDisposable } from "../scene";
 import { Node } from "../node";
 import { AbstractMesh } from "../Meshes/abstractMesh";
 import { Mesh } from '../Meshes/mesh';
-import { LinesMesh } from '../Meshes/linesMesh';
 import { UtilityLayerRenderer } from "../Rendering/utilityLayerRenderer";
 import { Color3 } from '../Maths/math.color';
 import { SixDofDragBehavior } from "../Behaviors/Meshes/sixDofDragBehavior";
@@ -103,9 +102,13 @@ export class GizmoManager implements IDisposable {
 
         const attachToMeshPointerObserver = this._attachToMeshPointerObserver(scene);
         const gizmoAxisPointerObserver = Gizmo.GizmoAxisPointerObserver(this._defaultUtilityLayer, this._gizmoAxisCache);
-        this._pointerObservers = [attachToMeshPointerObserver, gizmoAxisPointerObserver]
+        this._pointerObservers = [attachToMeshPointerObserver, gizmoAxisPointerObserver];
     }
 
+    /**
+     * Subscribes to pointer down events, for attaching and detaching mesh
+     * @param scene The sceme layer the observer will be added to
+     */
     private _attachToMeshPointerObserver(scene: Scene): Observer<PointerInfo> {
         // Instatiate/dispose gizmos based on pointer actions
         const pointerObserver = scene.onPointerObservable.add((pointerInfo) => {
@@ -298,14 +301,13 @@ export class GizmoManager implements IDisposable {
 
     /**
      * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
-     * @param mesh Axis gizmo mesh
-      @param cache display gizmo axis thickness
-    */
+     * @param gizmoAxisCache Gizmo axis definition used for reactive gizmo UI
+     */
     public addToAxisCache(gizmoAxisCache: Map<Mesh, GizmoAxisCache>) {
         if (gizmoAxisCache.size > 0) {
             gizmoAxisCache.forEach((v, k) => {
                 this._gizmoAxisCache.set(k, v);
-            })
+            });
         }
     }
 
@@ -313,8 +315,8 @@ export class GizmoManager implements IDisposable {
      * Disposes of the gizmo manager
      */
     public dispose() {
-        
-        this._pointerObservers.forEach(observer => {
+
+        this._pointerObservers.forEach((observer) => {
             this.scene.onPointerObservable.remove(observer);
         });
         for (var key in this.gizmos) {

+ 2 - 5
src/Gizmos/positionGizmo.ts

@@ -10,8 +10,7 @@ import { Gizmo, GizmoAxisCache } from "./gizmo";
 import { AxisDragGizmo } from "./axisDragGizmo";
 import { PlaneDragGizmo } from "./planeDragGizmo";
 import { UtilityLayerRenderer } from "../Rendering/utilityLayerRenderer";
-import { PointerEventTypes, PointerInfo } from "../Events/pointerEvents";
-import { LinesMesh } from "../Meshes/linesMesh";
+import { PointerInfo } from "../Events/pointerEvents";
 import { GizmoManager } from './gizmoManager';
 /**
  * Gizmo that enables dragging a mesh along 3 axis
@@ -50,8 +49,6 @@ export class PositionGizmo extends Gizmo {
     private _snapDistance: number;
     private _observables: Observer<PointerInfo>[] = [];
 
-    /** Gizmo state variables used for UI behavior */
-    private _dragging = false;
     /** Node Caching for quick lookup */
     private _gizmoAxisCache: Map<Mesh, GizmoAxisCache> = new Map();
 
@@ -211,7 +208,7 @@ export class PositionGizmo extends Gizmo {
     /**
      * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
      * @param mesh Axis gizmo mesh
-      @param cache display gizmo axis thickness
+     * @param cache Gizmo axis definition used for reactive gizmo UI
      */
     public addToAxisCache(mesh: Mesh, cache: GizmoAxisCache) {
         this._gizmoAxisCache.set(mesh, cache);

+ 3 - 5
src/Gizmos/rotationGizmo.ts

@@ -9,8 +9,7 @@ import { Gizmo, GizmoAxisCache } from "./gizmo";
 import { PlaneRotationGizmo } from "./planeRotationGizmo";
 import { UtilityLayerRenderer } from "../Rendering/utilityLayerRenderer";
 import { Node } from "../node";
-import { PointerEventTypes, PointerInfo } from "../Events/pointerEvents";
-import { LinesMesh } from "../Meshes/linesMesh";
+import { PointerInfo } from "../Events/pointerEvents";
 import { TransformNode } from "../Meshes/transformNode";
 import { GizmoManager } from './gizmoManager';
 /**
@@ -39,8 +38,6 @@ export class RotationGizmo extends Gizmo {
     private _nodeAttached: Nullable<Node>;
     private _observables: Observer<PointerInfo>[] = [];
 
-    /** Gizmo state variables used for UI behavior */
-    private _dragging = false;
     /** Node Caching for quick lookup */
     private _gizmoAxisCache: Map<Mesh, GizmoAxisCache> = new Map();
 
@@ -167,10 +164,11 @@ export class RotationGizmo extends Gizmo {
     public get scaleRatio() {
         return this.xGizmo.scaleRatio;
     }
+
     /**
      * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
      * @param mesh Axis gizmo mesh
-      @param cache display gizmo axis thickness
+     * @param cache Gizmo axis definition used for reactive gizmo UI
      */
     public addToAxisCache(mesh: Mesh, cache: GizmoAxisCache) {
         this._gizmoAxisCache.set(mesh, cache);

+ 2 - 5
src/Gizmos/scaleGizmo.ts

@@ -10,8 +10,7 @@ import { AxisScaleGizmo } from "./axisScaleGizmo";
 import { UtilityLayerRenderer } from "../Rendering/utilityLayerRenderer";
 import { Mesh } from "../Meshes/mesh";
 import { Node } from "../node";
-import { PointerEventTypes, PointerInfo } from "../Events/pointerEvents";
-import { LinesMesh } from "../Meshes/linesMesh";
+import { PointerInfo } from "../Events/pointerEvents";
 import { StandardMaterial } from "../Materials/standardMaterial";
 import { GizmoManager } from './gizmoManager';
 /**
@@ -47,8 +46,6 @@ export class ScaleGizmo extends Gizmo {
     private _disableMaterial: StandardMaterial;
     private _observables: Observer<PointerInfo>[] = [];
 
-    /** Gizmo state variables used for UI behavior */
-    private _dragging = false;
     /** Node Caching for quick lookup */
     private _gizmoAxisCache: Map<Mesh, GizmoAxisCache> = new Map();
 
@@ -237,7 +234,7 @@ export class ScaleGizmo extends Gizmo {
     /**
      * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
      * @param mesh Axis gizmo mesh
-      @param cache display gizmo axis thickness
+     * @param cache Gizmo axis definition used for reactive gizmo UI
      */
     public addToAxisCache(mesh: Mesh, cache: GizmoAxisCache) {
         this._gizmoAxisCache.set(mesh, cache);