@buerli.io/core 0.2.0 → 0.3.0-beta.0

package/build/graphic/filters.d.ts

@@ -0,0 +1,11 @@
+import { GraphicType as GT } from '../types/IGraphicPackage';
+export declare const lineFilter: (scope: string, data: GT) => boolean;
+export declare const lineSegmentsFilter: (scope: string, data: GT) => boolean;
+export declare const arcFilter: (scope: string, data: GT) => boolean;
+export declare const circleFilter: (scope: string, data: GT) => boolean;
+export declare const arcCircleFilter: (scope: string, data: GT) => boolean;
+export declare const pointFilter: (scope: string, data: GT) => boolean;
+export declare const meshFilter: (scope: string, data: GT) => boolean;
+export declare const planeFilter: (scope: string, data: GT) => boolean;
+export declare const loopFilter: (scope: string, data: GT) => boolean;
+export declare const solidFilter: (scope: string, data: GT) => boolean;

package/build/graphic/filters.js

@@ -0,0 +1,12 @@
+import { GraphicType as GT, LineSegments, Surfaces } from '../types/IGraphicPackage';
+import { BuerliScope } from '../store/states/selection';
+export const lineFilter = (scope, data) => scope === BuerliScope && (data === GT.LINE || data === GT.EDGE);
+export const lineSegmentsFilter = (scope, data) => scope === BuerliScope && LineSegments.includes(data);
+export const arcFilter = (scope, data) => scope === BuerliScope && data === GT.ARC;
+export const circleFilter = (scope, data) => scope === BuerliScope && data === GT.CIRCLE;
+export const arcCircleFilter = (scope, data) => scope === BuerliScope && (data === GT.ARC || data === GT.CIRCLE);
+export const pointFilter = (scope, data) => scope === BuerliScope && data === GT.POINT;
+export const meshFilter = (scope, data) => scope === BuerliScope && Surfaces.includes(data);
+export const planeFilter = (scope, data) => scope === BuerliScope && data === GT.PLANE;
+export const loopFilter = (scope, data) => scope === BuerliScope && data === GT.LOOP;
+export const solidFilter = (scope, data) => scope === BuerliScope && data === GT.BREP;

package/build/index.d.ts

@@ -5,6 +5,7 @@ export * from './utils/Math';
 export * from './utils/Measure';
 export * from './utils/Timing';
 export * from './store/subscribtion/subscribeToDrawing';
+export * from './graphic/filters';
 /**
  * Because babel typescript tools can not handle the type definitions
  * in an other way, they have to be re-exported as you can see in this code region.

package/build/index.js

@@ -5,4 +5,5 @@ export * from './utils/Math';
 export * from './utils/Measure';
 export * from './utils/Timing';
 export * from './store/subscribtion/subscribeToDrawing';
+export * from './graphic/filters';
 //#endregion Re-export type definitions

package/build/store/states/buerli.d.ts

@@ -40,10 +40,10 @@ declare const generalApi: (set: SetState<BuerliState>, get: GetState<BuerliState
      *
      * @param options - options which will be set into state.options
      */
-    init(options?: Partial<BuerliOptions> | undefined): void;
+    init(options?: Partial<BuerliOptions>): void;
 };
 declare const drawingManagementApi: (set: SetState<BuerliState>, get: GetState<BuerliState>, buerliApi: BuerliStoreApi) => {
-    createDrawing(name?: string | undefined): Promise<DrawingState>;
+    createDrawing(name?: string): Promise<DrawingState>;
     removeDrawing(id: DrawingID): void;
     setActiveDrawing(id: DrawingID | null): void;
 };

package/build/store/states/cad.d.ts

@@ -33,7 +33,7 @@ export declare const cadApi: (set: SetState<DrawingState>, get: GetState<Drawing
     }>) => void;
     addPending: (name: string, options?: {
         args?: any;
-    } | undefined) => string;
+    }) => string;
     removePending: (id: string) => void;
     setConnected: (connected: boolean) => void;
 };

package/build/store/states/drawing.d.ts

@@ -13,6 +13,7 @@ import { CadApi, CadData } from './cad';
 import { CanvasApi, CanvasData } from './canvas';
 import { GeometryApi, GeometryData } from './geometry';
 import { GraphicApi, GraphicData } from './graphic';
+import { InteractionApi, InteractionData } from './interaction';
 import { PluginApi, PluginData } from './plugin';
 import { SelectionApi, SelectionData } from './selection';
 import { StructureApi, StructureData } from './structure';
@@ -20,6 +21,7 @@ export declare type DrawingID = string | number;
 export declare type DrawingAPI = {
     structure: StructureApi;
     selection: SelectionApi;
+    interaction: InteractionApi;
     plugin: PluginApi;
     geometry: GeometryApi;
     graphic: GraphicApi;
@@ -34,6 +36,7 @@ declare type StateData = {
     graphic: GraphicData;
     canvas: CanvasData;
     selection: SelectionData;
+    interaction: InteractionData;
     plugin: PluginData;
     cad: CadData;
 };

package/build/store/states/drawing.js

@@ -12,6 +12,7 @@ import { cadApi, cadData } from './cad';
 import { canvasApi, canvasData } from './canvas';
 import { geometryApi, geometryData } from './geometry';
 import { graphicApi, graphicData } from './graphic';
+import { interactionApi, interactionData } from './interaction';
 import { pluginApi, pluginData } from './plugin';
 import { selectionApi, selectionData } from './selection';
 import { structureApi, structureData } from './structure';
@@ -23,6 +24,7 @@ export const createDrawingState = (set, get, buerliApi, drawingNumber, name) =>
     return {
         structure: structureData(),
         selection: selectionData(),
+        interaction: interactionData(),
         plugin: pluginData(),
         geometry: geometryData(),
         graphic: graphicData(),
@@ -36,6 +38,7 @@ export const createDrawingState = (set, get, buerliApi, drawingNumber, name) =>
             graphic: graphicApi(set, get, buerliApi),
             canvas: canvasApi(set, get, buerliApi),
             cad: cadApi(set, get, buerliApi),
+            interaction: interactionApi(set, get, buerliApi),
         },
         id: drawingId,
         name: name || `Drawing #${drawingNumber}`,

package/build/store/states/geometry.d.ts

@@ -41,14 +41,14 @@ export declare const geometryApi: (set: SetState<DrawingState>, get: GetState<Dr
      * The update will only happen, if at least one solid of one product is available.
      */
     updateBounds: () => void;
-    createGeometryIfNotCached: (containerId: number, color?: number[] | undefined) => ContainerGeometryT | undefined;
+    createGeometryIfNotCached: (containerId: number, color?: number[]) => ContainerGeometryT | undefined;
     setColor: (containerId: GraphicID, r: number, g: number, b: number) => void;
     setOpacity: (containerId: GraphicID, opacity: number) => void;
     setConfig: (objId: ObjectID | GraphicID, config: Partial<GeometryConfig> | null) => void;
     findDecorated: () => GeometryElement[];
     filter: (cb: (elem: GeometryElement) => boolean, options?: {
-        onlyOne?: boolean | undefined;
-        containerId?: number | undefined;
-    } | undefined) => GeometryElement[];
+        onlyOne?: boolean;
+        containerId?: ObjectID;
+    }) => GeometryElement[];
 };
 export {};

package/build/store/states/graphic.d.ts

@@ -12,9 +12,9 @@ export declare const graphicApi: (set: SetState<DrawingState>, get: GetState<Dra
     addPackages: (packages: IGraphicPackage[]) => void;
     cleanupGraphicRecords: () => void;
     filter: (cb: (elem: IGraphicElement) => boolean, options?: {
-        onlyOne?: boolean | undefined;
-        containerId?: number | undefined;
-    } | undefined) => {
+        onlyOne?: boolean;
+        containerId?: ObjectID;
+    }) => {
         elem: IGraphicElement;
         containerId: ObjectID;
         solidId: ObjectID;

package/build/store/states/interaction.d.ts

@@ -0,0 +1,34 @@
+import { GetState, SetState } from 'zustand';
+import { BuerliStoreApi } from '../../store/store';
+import { InteractionInfo } from '../../types';
+import { DrawingState } from './drawing';
+export declare type InteractionData = {
+    hovered?: InteractionInfo | null;
+    selected?: InteractionInfo[];
+};
+export declare type InteractionApi = ReturnType<typeof interactionApi>;
+export declare const interactionData: () => InteractionData;
+export declare const interactionApi: (set: SetState<DrawingState>, get: GetState<DrawingState>, buerliApi: BuerliStoreApi) => {
+    /**
+     * Sets the hovered item in the store to the given item.
+     *
+     * @param item The item.
+     */
+    setHovered: (item: InteractionInfo | null) => void;
+    /**
+     * Reset the 'selected' array to the given items.
+     *
+     * @param items The items.
+     */
+    setSelected: (items: InteractionInfo[]) => void;
+    /**
+     * Adds the given item to the 'selected' array if it is not yet selected.
+     * If the item is already selected, it will be removed from the 'selected' array.
+     *
+     * With 'multi' enabled, the already selected items will remain selected.
+     *
+     * @param item The item to select.
+     * @param multi Do multi select.
+     */
+    select: (item: InteractionInfo, multi?: boolean) => void;
+};

package/build/store/states/interaction.js

@@ -0,0 +1,50 @@
+////////////////////////////////////////////////////
+// DATA
+////////////////////////////////////////////////////
+export const interactionData = () => ({
+    hovered: null,
+    selected: [],
+});
+////////////////////////////////////////////////////
+// API
+////////////////////////////////////////////////////
+export const interactionApi = (set, get, buerliApi) => ({
+    /**
+     * Sets the hovered item in the store to the given item.
+     *
+     * @param item The item.
+     */
+    setHovered: (item) => {
+        set(state => (Object.assign(Object.assign({}, state), { interaction: Object.assign(Object.assign({}, state.interaction), { hovered: item }) })));
+    },
+    /**
+     * Reset the 'selected' array to the given items.
+     *
+     * @param items The items.
+     */
+    setSelected: (items) => {
+        set(state => (Object.assign(Object.assign({}, state), { interaction: Object.assign(Object.assign({}, state.interaction), { selected: items }) })));
+    },
+    /**
+     * Adds the given item to the 'selected' array if it is not yet selected.
+     * If the item is already selected, it will be removed from the 'selected' array.
+     *
+     * With 'multi' enabled, the already selected items will remain selected.
+     *
+     * @param item The item to select.
+     * @param multi Do multi select.
+     */
+    select: (item, multi) => {
+        const setSelected = get().api.interaction.setSelected;
+        const selected = get().interaction.selected || [];
+        const newKey = item.uniqueIdent;
+        let newSel = selected.length === 1 && selected[0].uniqueIdent === newKey ? [] : [item];
+        if (multi) {
+            newSel = selected.filter(s => s.uniqueIdent != newKey);
+            if (newSel.length === selected.length) {
+                newSel.push(item);
+            }
+        }
+        setSelected(newSel);
+    },
+});

package/build/store/states/plugin.d.ts

@@ -47,7 +47,7 @@ export declare const pluginApi: (set: SetState<DrawingState>, get: GetState<Draw
     setActiveFeature: (id: ObjectID | null) => void;
     setVisiblePlugin: (id: PluginID, visible: boolean) => void;
     setActiveGlobal: (id: PluginID, active: boolean) => void;
-    createPlugin: (def: PluginDef, defaultId?: string | number | undefined, drawingId?: DrawingID | undefined, objectId?: number | undefined) => (deactivate?: boolean) => void;
+    createPlugin: (def: PluginDef, defaultId?: ObjectID | string, drawingId?: DrawingID, objectId?: ObjectID) => (deactivate?: boolean) => void;
 };
 export declare function isPromisePlugin(def: PluginDef): def is Promise<Plugin>;
 export {};

package/build/store/states/selection.d.ts

@@ -15,7 +15,7 @@ export declare type SelectedItem<T extends SeletedItemData<any> = any> = {
     readonly label?: any;
     readonly removeCondition?: (d: DrawingState) => boolean;
 };
-export declare type SelectionFilter = (scope: SelectionScope, data: any) => boolean;
+export declare type SelectionFilter<T = any> = (scope: SelectionScope, data: T) => boolean;
 export declare type CustomSelect = (selectorId: SelectorID, newItems: SelectedItem[], diff: SelectedItem[]) => void;
 /**
  * Type for selector.
@@ -41,22 +41,22 @@ export declare type SelectionData = {
 export declare type SelectionApi = ReturnType<typeof selectionApi>;
 export declare const selectionData: () => SelectionData;
 export declare const selectionApi: (set: SetState<DrawingState>, get: GetState<DrawingState>, buerliApi: BuerliStoreApi) => {
-    unselectAll(selectorId?: SelectorID | undefined): void;
-    unselect(items: SelectedItem | SelectedItem[], selectorId?: SelectorID | undefined): void;
-    select(items: SelectedItem | SelectedItem[], selectorId?: SelectorID | undefined): void;
-    setHovered(item: SelectedItem | null, selectorId?: SelectorID | undefined): void;
+    unselectAll(selectorId?: SelectorID): void;
+    unselect(items: SelectedItem | SelectedItem[], selectorId?: SelectorID): void;
+    select(items: SelectedItem | SelectedItem[], selectorId?: SelectorID): void;
+    setHovered(item: SelectedItem | null, selectorId?: SelectorID): void;
     activateSelector(selectorId: SelectorID | null): void;
-    createSelector(selectorId: SelectorID, filter: SelectionFilter, activate?: boolean, initialItems?: SelectedItem[], maxLen?: number, customSelect?: CustomSelect | undefined, customUnSelect?: CustomSelect | undefined): () => void;
-    areItemsSelected: (items: SelectedItem[], selectorId?: SelectorID | undefined) => boolean;
-    isItemSelected: (item: SelectedItem, selectorId?: SelectorID | undefined) => boolean;
+    createSelector(selectorId: SelectorID, filter: SelectionFilter, activate?: boolean, initialItems?: SelectedItem[], maxLen?: number, customSelect?: CustomSelect, customUnSelect?: CustomSelect): () => void;
+    areItemsSelected: (items: SelectedItem[], selectorId?: SelectorID) => boolean;
+    isItemSelected: (item: SelectedItem, selectorId?: SelectorID) => boolean;
     setItems(id: SelectorID, items: SelectedItem[]): void;
     selectGraphic: (selectorId: SelectorID, items: {
         productId: ObjectID;
         containerId: GraphicID;
         graphicId?: GraphicID;
     }[], options?: {
-        unselectExisting?: boolean | undefined;
-    } | undefined) => void;
-    getGraphicItem: (productId: ObjectID, containerId: GraphicID, graphicId?: number | undefined) => SelectedItem<ProductElement> | null;
+        unselectExisting?: boolean;
+    }) => void;
+    getGraphicItem: (productId: ObjectID, containerId: GraphicID, graphicId?: GraphicID) => SelectedItem<ProductElement> | null;
 };
 export declare const createGraphicItem: (productId: ObjectID, el: GeometryElement) => SelectedItem<ProductElement>;

package/build/store/states/structure.d.ts

@@ -29,7 +29,7 @@ export declare const structureApi: (set: SetState<DrawingState>, get: GetState<D
     calculateProductBounds: (productId: ObjectID, base?: {
         min: THREE.Vector3;
         max: THREE.Vector3;
-    } | undefined) => {
+    }) => {
         center: THREE.Vector3;
         radius: number;
         max: THREE.Vector3;

package/build/types/InteractionInfo.d.ts

@@ -0,0 +1,43 @@
+import { GraphicID } from './IGraphicPackage';
+import { ObjectID } from './IStructureTree';
+/**
+ * It contains general information that can be used to identify CCObjects as well as Brep Elements.
+ */
+export declare type InteractionInfo<T = any> = {
+    /**
+     * Unique identifier of the interaction info.
+     */
+    uniqueIdent: string;
+    /**
+     * Identifies the object of the Part (for BaseModeling).
+     * Needed to identify the location ot the object in the tree.
+     */
+    objectId: ObjectID;
+    /**
+     * Identifies the node of the Assembly (for BaseModeling).
+     * Needed to identify the location ot the object in the tree.
+     */
+    prodRefId?: ObjectID | null;
+    /**
+     * Indentifies an object in the tree by it's full path, starting at AllObjects.
+     * It is optional, but should be filled if possible. It can be used to get the full,
+     * proper transformation of the identified object.
+     */
+    objectPath?: ObjectID[];
+    /**
+     * Identifies the cad entity of the graphic/geometry cache.
+     * Optional but needed for graphic/geometry element identification.
+     */
+    containerId?: ObjectID;
+    /**
+     * Identifies a single graphic/geometry element of a cad entity.
+     * Optional but needed for graphic/geometry element identification.
+     */
+    graphicId?: GraphicID;
+    /**
+     * Arbitrary object that contains user specific information.
+     */
+    userData?: T;
+};
+export declare const createInfo: (data: Omit<InteractionInfo, 'uniqueIdent'>) => InteractionInfo;
+export declare const createUniqueIdent: (data: Omit<InteractionInfo, 'uniqueIdent'>) => string;

package/build/types/InteractionInfo.js

@@ -0,0 +1,6 @@
+export const createInfo = (data) => {
+    return Object.assign({ uniqueIdent: createUniqueIdent(data) }, data);
+};
+export const createUniqueIdent = (data) => {
+    return `${[data.prodRefId, data.objectId, data.containerId, data.graphicId]}`;
+};

package/build/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from './ErrorTypes';
 export * from './IGraphicPackage';
+export * from './InteractionInfo';
 export * from './IStructurePatch';
 export * from './IStructureTree';

package/build/types/index.js

@@ -1,4 +1,5 @@
 export * from './ErrorTypes';
 export * from './IGraphicPackage';
+export * from './InteractionInfo';
 export * from './IStructurePatch';
 export * from './IStructureTree';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buerli.io/core",
-  "version": "0.2.0",
+  "version": "0.3.0-beta.0",
   "description": "buerli state management",
   "author": "AWV Informatik AG <info@awv-informatik.ch>",
   "license": "ISC",