@xtctwins/tctwins-core 1.1.11 → 1.1.13

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@xtctwins/tctwins-core",
-	"version": "1.1.11",
+	"version": "1.1.13",
 	"private": false,
 	"description": "Web Programming Toolkit for 3D/2D BIM and CAD",
 	"module": "./dist/tctwins-core.es5.js",
@@ -9,9 +9,9 @@
 	"scripts": {
 		"build": "rollup --config rollup.config.js && rollup --config rollup.minified.config.js",
 		"dev": "webpack --config webpack.min.config.js",
-		"publish": "npm publish --access public",
-		"release": "npm version patch && npm publish --access public",
-		"serve": "vite --open --mode dev"
+		"serve": "vite --open --mode dev",
+		"pub": "npm publish",
+		"release": "npm version patch && npm publish --access public"
 	},
 	"keywords": [
 		"webgl",
@@ -38,7 +38,7 @@
 		"3d-viewer"
 	],
 	"author": "Shao Xiang",
-	"license": "",
+	"license": "MIT",
 	"homepage": "https://tctwins.com",
 	"devDependencies": {
 		"@babel/cli": "^7.24.7",
@@ -74,5 +74,9 @@
 	"files": [
 		"/dist",
 		"/types"
-	]
+	],
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/",
+		"access": "public"
+	}
 }

package/types/plugins/SectionPlanesPlugin/SectionBoxControl.d.ts

@@ -0,0 +1,36 @@
+import { Component } from "../../viewer/scene/Component";
+
+export type SectionBoxConfiguration = {
+	/** 场景内唯一 ID；省略时自动生成。 */
+	id?: string;
+	/** 世界坐标范围，省略时自动适配模型。 */
+	aabb?: number[] | Float64Array;
+	/** 是否启用裁剪和交互，默认 true。 */
+	active?: boolean;
+	/** 是否显示控制器，默认 true；隐藏不停止裁剪。 */
+	visible?: boolean;
+	/** 最小间距，默认模型最大边长的 1%。 */
+	minSize?: number | number[] | Float64Array;
+};
+
+/**
+ * 通过 SectionPlanesPlugin 创建；不需要额外 DOM 元素。
+ *
+ * 未手动调整前会自动跟随模型集合（多个模型取并集）；一旦调用 `setAABB()` 或拖动盒面，
+ * 就切换为手动模式，不再自动重新适配，直到再次调用 `fitToScene()`。
+ */
+export declare class SectionBoxControl extends Component {
+	readonly mode: "inside" | "outside";
+	readonly aabb: number[] | null;
+	readonly minSize: number[] | null;
+	active: boolean;
+	visible: boolean;
+	/** 原子更新范围；非法范围抛出异常。切换到手动模式。 */
+	setAABB(aabb: number[] | Float64Array): void;
+	/** 恢复初始范围或最后一次适配范围；不改变自动跟随状态。 */
+	reset(): void;
+	/** 重新适配模型集合（多个模型取并集），并恢复自动跟随；无有效模型时返回 false。 */
+	fitToScene(): boolean;
+	/** 释放控制器及其拥有的六个剖切面。 */
+	destroy(): void;
+}

package/types/plugins/SectionPlanesPlugin/SectionPlanesPlugin.d.ts

@@ -1,6 +1,6 @@
 import { Plugin, Viewer } from "../../viewer";
 import { SectionPlane } from "../../viewer/scene/sectionPlane";
-import { SectionBox } from "../../viewer/scene/SectionBox";
+import { SectionBoxControl, SectionBoxConfiguration } from "./SectionBoxControl";
 
 export declare type SectionPlanesPluginConfiguration = {
 	/** Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}. */
@@ -57,7 +57,13 @@ export declare class SectionPlanesPlugin extends Plugin {
 	 */
 	createSectionPlane(params?: { id?: string; pos?: number[]; dir?: number[]; active?: boolean }): SectionPlane;
 
-	createSectionBox(param: { active?: boolean }): SectionBox;
+	/** 创建六面独立伸缩、保留盒内模型的剖切盒。 */
+	createClippingBox(params?: SectionBoxConfiguration): SectionBoxControl;
+
+	/** 创建固定尺寸整体平移、保留盒外模型的箱框。 */
+	createBoxFrame(params?: SectionBoxConfiguration): SectionBoxControl;
+
+	readonly clippingBox: SectionBoxControl | null;
 
 	/**
 	 * 设置是否是触屏模式
@@ -67,6 +73,12 @@ export declare class SectionPlanesPlugin extends Plugin {
 
 	/**
 	 * 设置剖切方式
+	 *
+	 * - `"plane"`：使用带边框的单面剖切控制器。
+	 * - 其它值（含 `"control"`）：使用默认单面剖切控制器。
+	 *
+	 * 旧的剖切盒取值 `"box"` / `"singleCtrl"` 已移除，剖切盒请使用 `createClippingBox()`。
+	 *
 	 * @param {string} way
 	 */
 	set sectionWay(way: string);
@@ -88,18 +100,6 @@ export declare class SectionPlanesPlugin extends Plugin {
 	 */
 	set sectionConfigs(cfg: any);
 
-	/**
-	 * 设置剖切盒平面样式
-	 * @param {any} cfg
-	 * @param {number} cfg.planeSize?
-	 * @param {number[]} cfg.controlSize?
-	 * @param {number[]} cfg.planeOpacity?
-	 * @param {number} cfg.controlFillColor?
-	 */
-	set boxPlaneConfigs(cfg: any);
-
-	get controlBox(): SectionBox;
-
 	/**
 	 * 设置剖切面位置
 	 * @param pos

package/types/plugins/SectionPlanesPlugin/index.d.ts

@@ -1 +1,2 @@
 export * from "./SectionPlanesPlugin";
+export * from "./SectionBoxControl";

package/types/viewer/scene/sectionPlane/SectionPlane.d.ts

@@ -9,6 +9,12 @@ export declare type SectionPlaneConfiguration = {
 	pos?: number[];
 	/** Vector perpendicular to the plane surface, indicating the SectionPlane plane orientation. */
 	dir?: number[];
+	/**
+	 * 内部盒体分组标记。同一个分组对象下的六个平面按整体盒体规则裁剪：
+	 * `mode` 为 `"inside"` 时只保留盒内片元，为 `"outside"` 时只保留盒外片元。
+	 * 普通单面剖切不设置该字段。
+	 */
+	clipGroup?: { mode: "inside" | "outside" } | null;
 };
 
 /**
@@ -22,6 +28,14 @@ export declare class SectionPlane extends Component {
 	 */
 	constructor(owner?: Component, cfg?: SectionPlaneConfiguration);
 
+	/**
+	 * 内部盒体分组标记，普通单面剖切为 `null`。
+	 *
+	 * 由 {@link SectionPlanesPlugin#createClippingBox} / {@link SectionPlanesPlugin#createBoxFrame}
+	 * 创建的六个平面共享同一个分组对象。
+	 */
+	readonly clipGroup: { mode: "inside" | "outside" } | null;
+
 	/**
 	 * Sets if this SectionPlane is active or not.
 	 *

package/types/viewer/scene/utils.d.ts

@@ -1,166 +1,166 @@
-
-interface JsonNode {
-  type: string;
-  children: JsonNode[];
-  [key: string]: string | JsonNode[] | undefined;
-}
-
-interface HttpRequestArgs {
-  method?: string;
-  url: string;
-}
-
-export declare const utils: {
-  /**
-   *
-   */
-  xmlToJson: (node: any, attributeRenamer: Record<string, string>) => JsonNode | string | undefined;
-
-  /**
-   *
-   */
-  clone: (ob: any) => any;
-
-  /**
-   *
-   */
-  compressGuid: (g: string) => string;
-
-  /**
-   *
-   */
-  findNodeOfType: (m: any, t: string) => any;
-
-  /**
-   *
-   */
-  timeout: (dt: number) => Promise<void>;
-
-  /**
-   *
-   */
-  httpRequest: (args: HttpRequestArgs) => Promise<Document>;
-
-  /**
-   *
-   */
-  loadJSON: (url: string, ok?: Function, err?: Function) => void;
-
-  /**
-   *
-   */
-  loadArraybuffer: (url: string, ok?: Function, err?: Function) => void;
-
-  /**
-   *
-   */
-  queryString: () => Record<string, string | string[]>;
-
-  /**
-   Tests if the given object is an array
-  @private
-  */
-  isArray: (value: any) => boolean;
-
-  /**
-   Tests if the given value is a string
-  @param value
-  @returns {Boolean}
-  @private
-  */
-  isString: (value: any) => boolean;
-
-  /**
-   Tests if the given value is a number
-  @param value
-  @returns {Boolean}
-  @private
-  */
-  isNumeric: (value: any) => boolean;
-
-  /**
-   Tests if the given value is an ID
-  @param value
-  @returns {Boolean}
-  @private
-  */
-  isID: (value: any) => boolean;
-
-  /**
-   Tests if the given components are the same, where the components can be either IDs or instances.
-  @param c1
-  @param c2
-  @returns {Boolean}
-  @private
-  */
-  isSameComponent: (c1: any, c2: any) => boolean;
-
-  /**
-   Tests if the given value is a function
-  @param value
-  @returns {Boolean}
-  @private
-  */
-  isFunction: (value: any) => boolean;
-
-  /**
-   Tests if the given value is a JavaScript JSON object, eg, ````{ foo: "bar" }````.
-  @param value
-  @returns {Boolean}
-  @private
-  */
-  isObject: (value: any) => boolean;
-
-  /** Returns a shallow copy
-   */
-  copy: (o: any) => any;
-
-  /** Add properties of o to o2, overwriting them on o2 if already there
-   */
-  apply: (o: any, o2: any) => any;
-
-  /**
-   Add non-null/defined properties of o to o2
-  @private
-  */
-  apply2: (o: any, o2: any) => any;
-
-  /**
-   Add properties of o to o2 where undefined or null on o2
-  @private
-  */
-  applyIf: (o: any, o2: any) => any;
-
-  /**
-   Returns true if the given map is empty.
-  @param obj
-  @returns {Boolean}
-  @private
-  */
-  isEmptyObject: (obj: any) => boolean;
-
-  /**
-   Returns the given ID as a string, in quotes if the ID was a string to begin with.
-
-  This is useful for logging IDs.
-
-  @param {Number| String} id The ID
-  @returns {String}
-  @private
-  */
-  inQuotes: (id: number | string) => string;
-
-  /**
-   Returns the concatenation of two typed arrays.
-  @param a
-  @param b
-  @returns {*|a}
-  @private
-  */
-  concat: (a: any, b: any) => any;
-
-  /**
-   *
-   */
-  flattenParentChildHierarchy: (root: JsonNode) => JsonNode[];
+
+interface JsonNode {
+  type: string;
+  children: JsonNode[];
+  [key: string]: string | JsonNode[] | undefined;
+}
+
+interface HttpRequestArgs {
+  method?: string;
+  url: string;
+}
+
+export declare const utils: {
+  /**
+   *
+   */
+  xmlToJson: (node: any, attributeRenamer: Record<string, string>) => JsonNode | string | undefined;
+
+  /**
+   *
+   */
+  clone: (ob: any) => any;
+
+  /**
+   *
+   */
+  compressGuid: (g: string) => string;
+
+  /**
+   *
+   */
+  findNodeOfType: (m: any, t: string) => any;
+
+  /**
+   *
+   */
+  timeout: (dt: number) => Promise<void>;
+
+  /**
+   *
+   */
+  httpRequest: (args: HttpRequestArgs) => Promise<Document>;
+
+  /**
+   *
+   */
+  loadJSON: (url: string, ok?: Function, err?: Function) => void;
+
+  /**
+   *
+   */
+  loadArraybuffer: (url: string, ok?: Function, err?: Function) => void;
+
+  /**
+   *
+   */
+  queryString: () => Record<string, string | string[]>;
+
+  /**
+   Tests if the given object is an array
+  @private
+  */
+  isArray: (value: any) => boolean;
+
+  /**
+   Tests if the given value is a string
+  @param value
+  @returns {Boolean}
+  @private
+  */
+  isString: (value: any) => boolean;
+
+  /**
+   Tests if the given value is a number
+  @param value
+  @returns {Boolean}
+  @private
+  */
+  isNumeric: (value: any) => boolean;
+
+  /**
+   Tests if the given value is an ID
+  @param value
+  @returns {Boolean}
+  @private
+  */
+  isID: (value: any) => boolean;
+
+  /**
+   Tests if the given components are the same, where the components can be either IDs or instances.
+  @param c1
+  @param c2
+  @returns {Boolean}
+  @private
+  */
+  isSameComponent: (c1: any, c2: any) => boolean;
+
+  /**
+   Tests if the given value is a function
+  @param value
+  @returns {Boolean}
+  @private
+  */
+  isFunction: (value: any) => boolean;
+
+  /**
+   Tests if the given value is a JavaScript JSON object, eg, ````{ foo: "bar" }````.
+  @param value
+  @returns {Boolean}
+  @private
+  */
+  isObject: (value: any) => boolean;
+
+  /** Returns a shallow copy
+   */
+  copy: (o: any) => any;
+
+  /** Add properties of o to o2, overwriting them on o2 if already there
+   */
+  apply: (o: any, o2: any) => any;
+
+  /**
+   Add non-null/defined properties of o to o2
+  @private
+  */
+  apply2: (o: any, o2: any) => any;
+
+  /**
+   Add properties of o to o2 where undefined or null on o2
+  @private
+  */
+  applyIf: (o: any, o2: any) => any;
+
+  /**
+   Returns true if the given map is empty.
+  @param obj
+  @returns {Boolean}
+  @private
+  */
+  isEmptyObject: (obj: any) => boolean;
+
+  /**
+   Returns the given ID as a string, in quotes if the ID was a string to begin with.
+
+  This is useful for logging IDs.
+
+  @param {Number| String} id The ID
+  @returns {String}
+  @private
+  */
+  inQuotes: (id: number | string) => string;
+
+  /**
+   Returns the concatenation of two typed arrays.
+  @param a
+  @param b
+  @returns {*|a}
+  @private
+  */
+  concat: (a: any, b: any) => any;
+
+  /**
+   *
+   */
+  flattenParentChildHierarchy: (root: JsonNode) => JsonNode[];
 }