Merge pull request #263 from Nodi3d/feature/frep-custom-node

Frep custom node feature

Author: mattatz

core/src/index.ts

@@ -20,10 +20,10 @@ export * from "./data/NumberTypes";
 export * from "./data/PathMask";
 export * from "./dom/IndicatorElement";
 export * from "./io/Connection";
-export * from "./io/IO";
-export * from "./io/IOManager";
 export * from "./io/Input";
 export * from "./io/InputManager";
+export * from "./io/IO";
+export * from "./io/IOManager";
 export * from "./io/Output";
 export * from "./io/OutputManager";
 export * from "./lib/verb/verb";
@@ -33,6 +33,8 @@ export * from "./math/NMathHelper";
 export * from "./math/frep/NFrep";
 export * from "./math/frep/NFrepBase";
 export * from "./math/frep/NFrepFilter";
+export * from "./math/frep/NFrepFunctionFilter";
+export * from "./math/frep/NFrepFunctionShape";
 export * from "./math/frep/NFrepMatrix";
 export * from "./math/frep/NFrepShape";
 export * from "./math/frep/blends/NFrepBlend";
@@ -42,6 +44,7 @@ export * from "./math/frep/blends/NFrepSmoothDifferenceBlend";
 export * from "./math/frep/blends/NFrepSmoothIntersectionBlend";
 export * from "./math/frep/blends/NFrepSmoothUnionBlend";
 export * from "./math/frep/blends/NFrepUnionBlend";
+export * from "./math/frep/misc/IFrepCustomFunction";
 export * from "./math/frep/misc/NFrepMarchingCubes";
 export * from "./math/frep/misc/NFrepTexture";
 export * from "./math/geometry/FilletCurveHelper";
@@ -80,8 +83,8 @@ export * from "./math/primitive/NDomain";
 export * from "./math/primitive/NGroup";
 export * from "./misc/Events";
 export * from "./misc/ICopyable";
-export * from "./misc/IDOMHolder";
 export * from "./misc/IDisposable";
+export * from "./misc/IDOMHolder";
 export * from "./misc/IElementable";
 export * from "./misc/INodeSync";
 export * from "./misc/ISelectable";
@@ -155,6 +158,9 @@ export * from "./nodes/frep/blend/FrepSmoothDifference";
 export * from "./nodes/frep/blend/FrepSmoothIntersection";
 export * from "./nodes/frep/blend/FrepSmoothUnion";
 export * from "./nodes/frep/blend/FrepUnion";
+export * from "./nodes/frep/plugins/FrepCustomBase";
+export * from "./nodes/frep/plugins/FrepCustomDistanceFunction";
+export * from "./nodes/frep/plugins/FrepCustomFilter";
 export * from "./nodes/frep/primitives/FBox";
 export * from "./nodes/frep/primitives/FCapsule";
 export * from "./nodes/frep/primitives/FCone";
@@ -165,6 +171,7 @@ export * from "./nodes/frep/tpms/TPMSFischerKochS";
 export * from "./nodes/frep/tpms/TPMSGyroid";
 export * from "./nodes/frep/tpms/TPMSLidinoid";
 export * from "./nodes/frep/tpms/TPMSSchwarzP";
+export * from "./nodes/frep/utils/FrepBoundingBox";
 export * from "./nodes/frep/utils/FrepRound";
 export * from "./nodes/frep/utils/MarchingCubes";
 export * from "./nodes/importer/CurveImporter";
@@ -301,6 +308,7 @@ export * from "./nodes/surface/freeform/Revolution";
 export * from "./nodes/surface/freeform/SurfaceFromPoints";
 export * from "./nodes/surface/freeform/Sweep";
 export * from "./nodes/surface/primitive/BoundingBox";
+export * from "./nodes/surface/primitive/ConstructBoundingBox";
 export * from "./nodes/surface/primitive/DeconstructBoundingBox";
 export * from "./nodes/surface/primitive/OrientedBoundingBox";
 export * from "./nodes/surface/primitive/PlaneSurface";
@@ -370,8 +378,8 @@ export * from "./preview/elements/NVFrep";
 export * from "./preview/elements/NVLine";
 export * from "./preview/elements/NVMesh";
 export * from "./preview/elements/NVPlane";
-export * from "./preview/elements/NVPointTransformControls";
 export * from "./preview/elements/NVPoints";
+export * from "./preview/elements/NVPointTransformControls";
 export * from "./preview/elements/NVTexcoordMesh";
 export * from "./preview/elements/NVTextSprite";
 export * from "./preview/geometries/Axes";

core/src/math/frep/NFrepBase.ts

@@ -11,6 +11,10 @@ export abstract class NFrepBase implements ITransformable {
     return this.compile('p');
   }
 
+  public toString (): string {
+    return 'FRep';
+  }
+
   public abstract applyMatrix (matrix: Matrix4): ITransformable;
   public abstract transform (f: TransformerType): ITransformable;
 }

core/src/math/frep/NFrepFunctionFilter.ts

@@ -0,0 +1,20 @@
+import { NBoundingBox } from '../geometry/NBoundingBox';
+import { NFrepBase } from './NFrepBase';
+import { NFrepFilter } from './NFrepFilter';
+import { IFrepCustomFunction } from './misc/IFrepCustomFunction';
+
+export class NFrepFunctionFilter extends NFrepFilter implements IFrepCustomFunction {
+  public fn(): string {
+    return this._fn;
+  }
+
+  protected _fn: string;
+
+  constructor (
+    code: (p: string) => string, frep: NFrepBase, boundingBox: NBoundingBox,
+    fun: string,
+  ) {
+    super(code, frep, boundingBox);
+    this._fn = fun;
+  }
+}

core/src/math/frep/NFrepFunctionShape.ts

@@ -0,0 +1,19 @@
+import { NBoundingBox } from '../geometry/NBoundingBox';
+import { NFrepShape } from './NFrepShape';
+import { IFrepCustomFunction } from './misc/IFrepCustomFunction';
+
+export class NFrepFunctionShape extends NFrepShape implements IFrepCustomFunction {
+  public fn(): string {
+    return this._fn;
+  }
+
+  protected _fn: string;
+
+  constructor (
+    code: (p: string) => string, boundingBox: NBoundingBox,
+    fun: string,
+  ) {
+    super(code, boundingBox);
+    this._fn = fun;
+  }
+}

core/src/math/frep/misc/IFrepCustomFunction.ts

@@ -0,0 +1,12 @@
+
+export interface IFrepCustomFunction {
+  fn(): string
+}
+
+const isFrepCustomFunction = function (arg: any): arg is IFrepCustomFunction {
+  return arg !== null && typeof arg === 'object' && typeof arg.fn === 'function';
+};
+
+export {
+  isFrepCustomFunction 
+};

core/src/math/frep/misc/NFrepTexture.ts

@@ -3,6 +3,7 @@ import { GPUComputationRenderer } from 'three/examples/jsm/misc/GPUComputationRe
 import { NFrepBase } from '../NFrepBase';
 import FrepCommon from '../../../shaders/FrepCommon.glsl';
 import FrepTextureFragment from '../shaders/FrepTexture.frag';
+import { isFrepCustomFunction } from './IFrepCustomFunction';
 
 export type FrepRenderProps = {
   frep: NFrepBase;
@@ -22,7 +23,9 @@ export class NFrepTexture {
 
   public render (props: FrepRenderProps): WebGLRenderTarget {
     const { frep, min, max, width, height, depth } = props;
+
     const code = frep.compile('p');
+    const custom = isFrepCustomFunction(frep) ? frep.fn() : '';
 
     const tw = width * height;
     const th = depth;
@@ -40,6 +43,9 @@ export class NFrepTexture {
       FrepTextureFragment.replace(
         '#include <frep_common>',
         FrepCommon
+      ).replace(
+        '#include <frep_custom_function>',
+        custom
       ),
       initialValueTexture
     );

core/src/math/frep/shaders/FrepTexture.frag

@@ -6,6 +6,9 @@ uniform float iU, iV;
 
 #include <frep_common>
 
+// replace to compiled custom function
+#include <frep_custom_function>
+
 float scene(vec3 p) {
   return SCENE_CODE;
 }

core/src/math/geometry/NBoundingBox.ts

@@ -161,7 +161,8 @@ export class NBoundingBox implements IBoundable, ITransformable {
   }
 
   public bounds (plane: NPlane): NBoundingBox {
-    throw new Error('Method not implemented.');
+    const points = this.projectPoints(plane);
+    return NBoundingBox.fromPoints(plane, points);
   }
 
   public projectPoints (plane: NPlane): NPoint[] {
@@ -238,6 +239,15 @@ export class NBoundingBox implements IBoundable, ITransformable {
     ];
   }
 
+  public clone (): NBoundingBox {
+    return new NBoundingBox(
+      this.plane.clone(),
+      this.dx.clone(),
+      this.dy.clone(),
+      this.dz.clone()
+    );
+  }
+
   public toString (): string {
     return `NBoundingBox (x:${this.dx.min}~${this.dx.max}, y:${this.dy.min}~${this.dy.max}, z:${this.dz.min}~${this.dz.max})`;
   }

core/src/nodes/NodeDictionary.ts

@@ -53,6 +53,8 @@ import { FrepSmoothDifference } from './frep/blend/FrepSmoothDifference';
 import { FrepSmoothIntersection } from './frep/blend/FrepSmoothIntersection';
 import { FrepSmoothUnion } from './frep/blend/FrepSmoothUnion';
 import { FrepUnion } from './frep/blend/FrepUnion';
+import { FrepCustomDistanceFunction } from './frep/plugins/FrepCustomDistanceFunction';
+import { FrepCustomFilter } from './frep/plugins/FrepCustomFilter';
 import { FBox } from './frep/primitives/FBox';
 import { FCapsule } from './frep/primitives/FCapsule';
 import { FCone } from './frep/primitives/FCone';
@@ -63,6 +65,7 @@ import { TPMSFischerKochS } from './frep/tpms/TPMSFischerKochS';
 import { TPMSGyroid } from './frep/tpms/TPMSGyroid';
 import { TPMSLidinoid } from './frep/tpms/TPMSLidinoid';
 import { TPMSSchwarzP } from './frep/tpms/TPMSSchwarzP';
+import { FrepBoundingBox } from './frep/utils/FrepBoundingBox';
 import { FrepRound } from './frep/utils/FrepRound';
 import { MarchingCubes } from './frep/utils/MarchingCubes';
 import { CurveImporter } from './importer/CurveImporter';
@@ -194,6 +197,7 @@ import { Revolution } from './surface/freeform/Revolution';
 import { SurfaceFromPoints } from './surface/freeform/SurfaceFromPoints';
 import { Sweep } from './surface/freeform/Sweep';
 import { BoundingBox } from './surface/primitive/BoundingBox';
+import { ConstructBoundingBox } from './surface/primitive/ConstructBoundingBox';
 import { DeconstructBoundingBox } from './surface/primitive/DeconstructBoundingBox';
 import { OrientedBoundingBox } from './surface/primitive/OrientedBoundingBox';
 import { PlaneSurface } from './surface/primitive/PlaneSurface';
@@ -307,6 +311,8 @@ const Nodes = {
   FrepSmoothIntersection,
   FrepSmoothUnion,
   FrepUnion,
+  FrepCustomDistanceFunction,
+  FrepCustomFilter,
   FBox,
   FCapsule,
   FCone,
@@ -317,6 +323,7 @@ const Nodes = {
   TPMSGyroid,
   TPMSLidinoid,
   TPMSSchwarzP,
+  FrepBoundingBox,
   FrepRound,
   MarchingCubes,
   CurveImporter,
@@ -448,6 +455,7 @@ const Nodes = {
   SurfaceFromPoints,
   Sweep,
   BoundingBox,
+  ConstructBoundingBox,
   DeconstructBoundingBox,
   OrientedBoundingBox,
   PlaneSurface,
@@ -563,6 +571,8 @@ const NodeDictionary: { [index: string]: { name:string; entity: NodeConstructorT
   'frep/blend/FrepSmoothIntersection': { name: 'FrepSmoothIntersection', entity: FrepSmoothIntersection },
   'frep/blend/FrepSmoothUnion': { name: 'FrepSmoothUnion', entity: FrepSmoothUnion },
   'frep/blend/FrepUnion': { name: 'FrepUnion', entity: FrepUnion },
+  'frep/plugins/FrepCustomDistanceFunction': { name: 'FrepCustomDistanceFunction', entity: FrepCustomDistanceFunction },
+  'frep/plugins/FrepCustomFilter': { name: 'FrepCustomFilter', entity: FrepCustomFilter },
   'frep/primitives/FBox': { name: 'FBox', entity: FBox },
   'frep/primitives/FCapsule': { name: 'FCapsule', entity: FCapsule },
   'frep/primitives/FCone': { name: 'FCone', entity: FCone },
@@ -573,6 +583,7 @@ const NodeDictionary: { [index: string]: { name:string; entity: NodeConstructorT
   'frep/tpms/TPMSGyroid': { name: 'TPMSGyroid', entity: TPMSGyroid },
   'frep/tpms/TPMSLidinoid': { name: 'TPMSLidinoid', entity: TPMSLidinoid },
   'frep/tpms/TPMSSchwarzP': { name: 'TPMSSchwarzP', entity: TPMSSchwarzP },
+  'frep/utils/FrepBoundingBox': { name: 'FrepBoundingBox', entity: FrepBoundingBox },
   'frep/utils/FrepRound': { name: 'FrepRound', entity: FrepRound },
   'frep/utils/MarchingCubes': { name: 'MarchingCubes', entity: MarchingCubes },
   'importer/CurveImporter': { name: 'CurveImporter', entity: CurveImporter },
@@ -704,6 +715,7 @@ const NodeDictionary: { [index: string]: { name:string; entity: NodeConstructorT
   'surface/freeform/SurfaceFromPoints': { name: 'SurfaceFromPoints', entity: SurfaceFromPoints },
   'surface/freeform/Sweep': { name: 'Sweep', entity: Sweep },
   'surface/primitive/BoundingBox': { name: 'BoundingBox', entity: BoundingBox },
+  'surface/primitive/ConstructBoundingBox': { name: 'ConstructBoundingBox', entity: ConstructBoundingBox },
   'surface/primitive/DeconstructBoundingBox': { name: 'DeconstructBoundingBox', entity: DeconstructBoundingBox },
   'surface/primitive/OrientedBoundingBox': { name: 'OrientedBoundingBox', entity: OrientedBoundingBox },
   'surface/primitive/PlaneSurface': { name: 'PlaneSurface', entity: PlaneSurface },

core/src/nodes/frep/plugins/FrepCustomBase.ts

@@ -0,0 +1,77 @@
+import { NFrepFunctionFilter } from '~/src/math/frep/NFrepFunctionFilter';
+import { AccessTypes } from '../../../data/AccessTypes';
+import { DataAccess } from '../../../data/DataAccess';
+import { DataTree } from '../../../data/DataTree';
+import { DataTypes } from '../../../data/DataTypes';
+import { InputManager } from '../../../io/InputManager';
+import { OutputManager } from '../../../io/OutputManager';
+import { NFrepBase } from '../../../math/frep/NFrepBase';
+import { NFrepFilter } from '../../../math/frep/NFrepFilter';
+import { NBoundingBox } from '../../../math/geometry/NBoundingBox';
+import { NDomain } from '../../../math/primitive/NDomain';
+import { NodeJSONType } from '../../NodeBase';
+import { CustomPayloadType } from '../../plugins/Custom';
+import { FrepNodeBase } from '../FrepNodeBase';
+
+export type FrepCustomJSONType = NodeJSONType & Partial<CustomPayloadType>;
+
+export abstract class FrepCustomBase extends FrepNodeBase {
+  public get customName (): string {
+    return this._customName;
+  }
+
+  public get customProgram (): string {
+    return this._customProgram;
+  }
+
+  protected abstract _customName: string;
+  protected abstract _customProgram: string;
+
+  public get displayName (): string {
+    return this._customName;
+  }
+
+  public setupViewElement (container: HTMLDivElement): void {
+    const span = document.createElement('span');
+
+    this.onStateChanged.on(() => {
+      span.textContent = this.displayName;
+    });
+
+    span.textContent = this.displayName;
+    container.appendChild(span);
+  }
+
+  public registerInputs (manager: InputManager): void {
+    manager.add('f', 'Base frep', DataTypes.FREP, AccessTypes.ITEM);
+  }
+
+  public registerOutputs (manager: OutputManager): void {
+    manager.add('R', 'Frep custom result', DataTypes.FREP, AccessTypes.ITEM);
+  }
+
+  public abstract getCustomSetting (): CustomPayloadType;
+
+  public abstract updateCustomSetting (setting: CustomPayloadType): void;
+
+  toJSON (name: string): FrepCustomJSONType {
+    const setting = this.getCustomSetting();
+    return {
+      ...super.toJSON(name),
+      ...setting
+    };
+  }
+
+  fromJSON (json: FrepCustomJSONType): void {
+    const current = this.getCustomSetting();
+    current.customName = json.customName ?? current.customName;
+    current.customProgram = json.customProgram ?? current.customProgram;
+    current.inDataTypes = json.inDataTypes ?? current.inDataTypes;
+    current.inAccessTypes = json.inAccessTypes ?? current.inAccessTypes;
+    current.outDataTypes = json.outDataTypes ?? current.outDataTypes;
+    current.outAccessTypes = json.outAccessTypes ?? current.outAccessTypes;
+    this.updateCustomSetting(current);
+    super.fromJSON(json);
+  }
+
+}