@x-viewer/core 0.21.8 → 0.21.9

package/dist/types/core/compare/BaseDxfCompareHelper.d.ts

@@ -43,15 +43,9 @@ export declare class BaseDxfCompareHelper {
     constructor(viewerCfg: Viewer2dConfig);
     protected initSpinner(): void;
     /**
-     * @description {en} Sets font.
-     * This needs to be called before loading a dxf, it won't affect any loaded text.
-     * It accepts shx or typeface formats. For typeface, it only support passing in 1 font file in the array for now.
-     * @description {zh} 设置字体。
-     * 需要在加载dxf之前调用，不会影响已加载的文字。
-     * 支持shx或typeface格式。对于typeface，目前只支持传入1个字体文件。
-     * @param urls
-     * - {en} font file urls.
-     * - {zh} 字体文件链接。
+     * Loads fonts used when parsing DXF text. Call before loading a DXF; does not affect text that is already loaded.
+     * Supports SHX or typeface bundles; for typeface, only a single file in the array is supported for now.
+     * @param urls Font file URLs.
      * @example
      * ```typescript
      * compareHelper.setFont(["https://example.com/xxx.shx"]);
@@ -68,11 +62,8 @@ export declare class BaseDxfCompareHelper {
      */
     compare(modelCfg1: Model2dConfig, modelCfg2: Model2dConfig, compareCfg?: DxfCompareConfig, onProgress?: (event: ProgressEvent) => void): Promise<void>;
     /**
-     * @description {en} Gets compare changes.
-     * @description {zh} 获取对比变动.
-     * @returns
-     * - {en} Compare changes.
-     * - {zh} 对比变动列表。
+     * Returns the comparison diff (per-change records) from the last successful `compare`.
+     * @returns Compare changes keyed by id, or undefined if not yet compared.
      * @example
      * ``` typescript
      * const changes = compareHelper.getChanges();
@@ -81,11 +72,8 @@ export declare class BaseDxfCompareHelper {
      */
     getChanges(): Record<number, DxfChange> | undefined;
     /**
-     * @description {en} Zooms to a compare change.
-     * @description {zh} 聚焦到图纸的一处变动。
-     * @param changeId
-     * - {en} Change id, which is an incremental integer starts from 1.
-     * - {zh} 变动id，该id是从数字1开始自增的整数。
+     * Zooms the camera to the bounding box of a single compare change (with padding).
+     * @param changeId Change id: positive integer, starting at 1.
      * @example
      * ``` typescript
      * const changeId = 1;

package/dist/types/core/compare/DxfCompareHelper.d.ts

@@ -39,8 +39,7 @@ export declare class DxfCompareHelper extends BaseDxfCompareHelper {
     constructor(viewerCfg1: Viewer2dConfig, viewerCfg2: Viewer2dConfig);
     protected initSyncCameraEvent(): void;
     /**
-     * @description {en} Enables to synchronize camera position when another camera is moved.
-     * @description {zh} 设置开启或关闭同步相机视角。
+     * Enables or disables synchronizing the two viewers' cameras when either one moves.
      * @example
      * ```typescript
      * compareHelper.enableSyncCamera(true);
@@ -57,11 +56,8 @@ export declare class DxfCompareHelper extends BaseDxfCompareHelper {
      */
     compare(modelCfg1: Model2dConfig, modelCfg2: Model2dConfig, compareCfg?: DxfCompareConfig, onProgress?: (event: ProgressEvent) => void): Promise<void>;
     /**
-     * @description {en} Zooms to a compare change.
-     * @description {zh} 聚焦到图纸的一处变动。
-     * @param changeId
-     * - {en} Change id, which is an incremental integer starts from 1.
-     * - {zh} 变动id，该id是从数字1开始自增的整数。
+     * Zooms both viewers to the bounding box of one compare change (with padding).
+     * @param changeId Change id: positive integer starting at 1.
      * @example
      * ``` typescript
      * const changeId = 1;

package/dist/types/core/model/Model2d.d.ts

@@ -95,7 +95,7 @@ export declare class Model2d extends Model {
     /**
      * Sets layer visibility.
      */
-    setLayerVisible(layerName: string, visible: boolean, enableHideVisuallySmallObjects?: boolean, cameraZoom?: number): void;
+    setLayerVisible(layerName: string, visible: boolean, enableSmallFeatureCulling?: boolean, cameraZoom?: number): void;
     /**
      * Sets layer opacity.
      */

package/dist/types/core/utils/CoordinateUtils.d.ts

@@ -64,18 +64,12 @@ export declare class CoordinateUtils {
      */
     static screen2World(vector: THREE.Vector2, camera: THREE.Camera, container: HTMLElement): THREE.Vector3;
     /**
-     * Converts screen point to NDC coordinate.
-     * @description {en} Normalized screen coordinate: bottom-left(-1, -1), top-right(1, 1).
-     * @description {zh} 标准化屏幕坐标：左下角(-1, -1), 右上角(1, 1)。
-     * @description {en} World coordinate to normalized screen coordinate(0-1).
-     * @description {zh} 世界坐标转标准化屏幕坐标（0-1）。
+     * Converts a screen pixel point to NDC: bottom-left (-1, -1), top-right (1, 1).
+     * (Related: {@link world2NormalizedScreen} maps world to 0–1 screen space.)
      */
     static screen2Ndc(vector: THREE.Vector2, camera: THREE.Camera, container: HTMLElement): THREE.Vector2;
     /**
-     * @description {en} Normalized screen coordinate: top-left(0, 0), bottom-right(1, 1).
-     * @description {zh} 标准化屏幕坐标：左上角(0, 0), 右下角(1, 1)。
-     * @description {en} World coordinate to normalized screen coordinate(0-1).
-     * @description {zh} 世界坐标转标准化屏幕坐标（0-1）。
+     * Maps a world point to normalized screen coordinates: top-left (0, 0), bottom-right (1, 1).
      */
     static world2NormalizedScreen(worldCoord: THREE.Vector2 | THREE.Vector3, camera: THREE.Camera, container: HTMLElement): THREE.Vector2;
 }

package/dist/types/core/viewers/BaseViewer.d.ts

@@ -125,8 +125,7 @@ export declare abstract class BaseViewer<BaseViewerEvents extends ViewerEvents =
      */
     getPixelSizeInWorldCoord(): number;
     /**
-     * @description {en} Asks user to select a box area, and zooms to it.
-     * @description {zh} 询问用户选择一个框选区域，然后缩放到该区域。
+     * Lets the user box-select a region on screen, then zooms the camera to that region.
      * @example
      * ``` typescript
      * viewer.zoomToRect();

package/dist/types/core/viewers/Viewer2d.d.ts

@@ -166,23 +166,14 @@ export declare class Viewer2d extends BaseViewer {
     constructor(viewerCfg: Viewer2dConfig);
     get camera(): THREE.OrthographicCamera;
     /**
-     * @description {en} Loads a dxf file.
-     * The first loaded file will be taken as a "master" model.
+     * Loads a DXF/DWG model.
+     * The first loaded file becomes the "master" model.
      * Any other files are non-master, we call "overlay" model.
      * We'll load everything of a master model, including model and paper space.
      * For an overlay model, we'll only load its model space. And its model space can only
      * overly to master model's model space.
-     * @description {zh} 加载 dxf 文件。
-     * 第一个加载的文件将被视为“主”模型。
-     * 任何其他文件都是非主文件，我们称之为“叠加”模型。
-     * 我们将加载主模型的所有内容，包括模型和图纸空间。
-     * 对于叠加模型，我们只会加载其模型空间。并且它的模型空间只能叠加到主模型的模型空间上。
-     * @param modelCfg
-     * - {en} The configuration of the model to be loaded.
-     * - {zh} 要加载的模型的配置。
-     * @param onProgress
-     * - {en} A callback function to indicate the loading progress.
-     * - {zh} 用于指示加载进度的回调函数。
+     * @param modelCfg Configuration of the model to load.
+     * @param onProgress Optional callback for loading progress.
      * @example
      * ``` typescript
      * const viewerCfg = {
@@ -228,11 +219,8 @@ export declare class Viewer2d extends BaseViewer {
      */
     getWorldPositionByMousePick(mousePosition: THREE.Vector2): THREE.Vector3 | undefined;
     /**
-     * @description {en} Activates a layout.
-     * @description {zh} 激活布局。
-     * @param layoutName
-     * - {en} The name of the layout to be activated.
-     * - {zh} 要激活的布局名称。
+     * Activates a layout tab (model or paper space).
+     * @param layoutName Layout name to activate.
      * @example
      * ```typescript
      * viewer.activateLayout('Layout1');
@@ -258,10 +246,8 @@ export declare class Viewer2d extends BaseViewer {
     goToHomeView(): void;
     zoomToBBox(bbox: THREE.Box3): void;
     /**
-     * @description {en} Gets current view extent.
-     * This is useful for user to save this value as a viewpoint, and jump to this viewpoint next time.
-     * @description {zh} 获取当前视图范围。
-     * 用户可使用该接口获取当前视口范围，并在适当的场景下跳转到该视口范围。
+     * Returns the current view extent in world XY (from NDC corners).
+     * Useful to save as a viewpoint and restore the same framing later.
      * @example
      * ``` typescript
      * const box = viewer.getCurrentViewExtent();
@@ -291,11 +277,7 @@ export declare class Viewer2d extends BaseViewer {
      */
     getHitResult(event: MouseEvent | PointerEvent | EventInfo): THREE.Vector2 | undefined;
     /**
-     * @description {en} Gets active layout.
-     * @description {zh} 获取当前布局。
-     * @returns
-     * - {en} Active layout name or undefined.
-     * - {zh} 当前激活的布局名称或undefined。
+     * Returns the active layout name, or undefined if none.
      * @example
      * ``` typescript
      * const activeLayout = viewer.getActiveLayoutName();
@@ -306,11 +288,7 @@ export declare class Viewer2d extends BaseViewer {
     zoomIn(step?: number): void;
     zoomOut(step?: number): void;
     /**
-     * @description {en} Gets dxf layers.
-     * @description {zh} 获取dxf图层。
-     * @returns
-     * - {en} Dxf layers.
-     * - {zh} dxf图层。
+     * Returns layer tables grouped by loaded model (master first, then overlays).
      * @example
      * ``` typescript
      * const dxfLayers = viewer.getLayers();
@@ -329,20 +307,11 @@ export declare class Viewer2d extends BaseViewer {
      */
     setModelVisibility(modelId: string, visible: boolean): void;
     /**
-     * @description {en} Sets layer's visibility.
-     * @description {zh} 设置图层的可见性。
-     * @param layerName
-     * - {en} Layer's name to show or hide.
-     * - {zh} 要显示或隐藏的图层名称。
-     * @param visible
-     * - {en} Layer's target visibility.
-     * - {zh} 图层的目标可见性。
-     * @param modelId
-     * - {en} Useful when more than one model is loaded, if not specified, will use the master model.
-     * - {zh} 当加载了多个模型时有用，如果未指定，将使用主模型。
-     * @throws Error
-     * - {en}: Throws exception if given modelId doesn't exist.
-     * - {zh} 如果给定的modelId不存在，则抛出异常。
+     * Sets visibility of a layer by name.
+     * @param layerName Layer to show or hide.
+     * @param visible Target visibility.
+     * @param modelId When multiple models are loaded, target model; defaults to the master model.
+     * @throws If `modelId` does not match any loaded model.
      * @example
      * ``` typescript
      * // Hides layer "0"
@@ -367,11 +336,11 @@ export declare class Viewer2d extends BaseViewer {
      */
     resetLayerColor(layerName: string, modelId?: string): void;
     /**
-     * Enables to hide visually small objects in order to improve performance.
+     * Enables small feature culling in order to improve performance.
      */
-    enableHidingVisuallySmallObjects(enable: boolean): void;
+    enableSmallFeatureCulling(enable: boolean): void;
     /**
-     * If it enabled to hide visually small objects.
+     * If small feature culling is enabled.
      */
-    isHidingVisuallySmallObjectsEnabled(): boolean;
+    isSmallFeatureCullingEnabled(): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@x-viewer/core",
-    "version": "0.21.8",
+    "version": "0.21.9",
     "homepage": "https://dwg.thingraph.site/",
     "description": "WebGL-based 2D/3D viewer engine built on Three.js. View DWG/DXF/PDF files in the browser with no server required. Supports glTF, OBJ, FBX, IFC, STL and BimTiles formats.",
     "author": "thingraph",