@xtctwins/tctwins-core 1.1.10 → 1.1.12

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@xtctwins/tctwins-core",
-	"version": "1.1.10",
+	"version": "1.1.12",
 	"private": false,
 	"description": "Web Programming Toolkit for 3D/2D BIM and CAD",
 	"module": "./dist/tctwins-core.es5.js",

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/sectionBox/SectionBox.d.ts

@@ -1,41 +0,0 @@
-import { Component } from "../Component";
-
-export declare class SectionBox extends Component {
-	/**
-	 * @constructor
-	 * @param {Component} [owner]  Owner component. When destroyed, the owner will destroy this SectionBox as well.
-	 * @param {SectionPlaneConfiguration} [cfg]  SectionBox configuration
-	 */
-	constructor(owner?: Component, cfg?: any);
-
-	/**
-	 * Sets if this SectionBox is active or not.
-	 *
-	 * Default value is ````true````.
-	 *
-	 * @param {Boolean} value Set ````true```` to activate else ````false```` to deactivate.
-	 */
-	set active(arg: boolean);
-
-	/**
-	 * Gets if this SectionBox is active or not.
-	 *
-	 * Default value is ````true````.
-	 *
-	 * @returns {Boolean} Returns ````true```` if active.
-	 */
-	get active(): boolean;
-
-	set visible(visible: boolean);
-	get visible(): boolean;
-
-	/**
-	 * Gets this SectionPlane's distance to the origin of the World-space coordinate system.
-	 *
-	 * This is the dot product of {@link SectionPlane.pos} and {@link SectionPlane.dir} and is automatically re-calculated
-	 * each time either of two properties are updated.
-	 *
-	 * @returns {Number}
-	 */
-	get dist(): number;
-}

package/types/viewer/scene/sectionBox/index.d.ts

@@ -1 +0,0 @@
-export * from "./SectionBox";