WebCAD-Lib-TS API 文档 - v1.0.0
    Preparing search index...

    Class CircleEnt

    圆形类

    表示CAD中的圆形实体,继承自实体基类。 圆形是最基本的CAD几何图形之一,由圆心和半径完全确定。

    主要功能:

    1. 圆形的几何定义和属性管理
    2. 面积、周长、直径等几何量计算
    3. 圆形的几何变换操作
    4. 象限点计算和夹点编辑
    import { CircleEnt, Point2D, Engine } from '@aspect/webcad-lib-ts';

    // 创建圆形
    const circle = new CircleEnt(new Point2D(50, 50), 25);
    circle.setDefaults();

    // 添加到画布
    Engine.addEntities(circle);

    // 获取面积和周长
    console.log(`面积: ${circle.area}, 周长: ${circle.circumference}`);

    Hierarchy (View Summary)

    Index

    Constructors

    • 构造函数

      创建一个圆形实体,设置圆心、半径和颜色。 支持简化的数组写法 [x, y]

      Parameters

      • centerPoint: PointInput

        圆心坐标点,支持 Point2D 或数组 [x, y]

      • radiusValue: number

        半径值(必须为正数)

      • color: number = 256

        颜色索引,默认为256(随图层颜色)

      Returns CircleEnt

      // 简化写法
      const circle1 = new CircleEnt([50, 50], 25);

      // Point2D 写法
      const circle2 = new CircleEnt(new Point2D(50, 50), 25);

    Properties

    type: string

    实体类型标识符(如"LINE"、"CIRCLE"等)

    objectId: string

    DWG对象ID(句柄)- 从DWG文件导入时的唯一标识符 这个值不应该在克隆时复制,新创建的实体应该为空字符串

    id: number

    实体索引ID - 从1开始递增的唯一索引 用于在WebCAD格式中标识实体

    _lineType: string
    _isAlive: boolean
    isDirty: boolean

    是否处于脏状态,供渲染器增量更新

    block?: any

    Accessors

    • get center(): Point2D

      获取圆心

      Returns Point2D

      圆心坐标

    • set center(center: PointInput): void

      设置圆心 赋值并标记实体已修改

      Parameters

      • center: PointInput

        新的圆心坐标,支持 Point2D 或数组 [x, y]

      Returns void

    • get radius(): number

      获取半径

      Returns number

      半径值

    • set radius(radius: number): void

      设置半径 赋值并标记实体已修改

      Parameters

      • radius: number

        新的半径值

      Returns void

    • get area(): number

      获取圆形面积

      计算圆形的面积,使用公式:面积 = π × 半径²

      Returns number

      圆形面积

    • get circumference(): number

      获取周长(属性版本)

      计算圆形的周长,与getCircumference()方法功能相同。

      Returns number

      圆形周长

    • get color(): number

      获取颜色索引

      Returns number

      颜色索引值(256表示"随图层"颜色)

    • set color(value: number): void

      设置颜色索引

      Parameters

      • value: number

        颜色索引值(256表示"随图层"颜色)

      Returns void

    • get layerId(): string

      获取图层ID

      Returns string

      图层ID字符串

    • set layerId(value: string): void

      设置图层ID

      Parameters

      • value: string

        图层ID字符串

      Returns void

    • get lineTypeScale(): number

      获取线型比例

      Returns number

      线型比例因子

    • set lineTypeScale(value: number): void

      设置线型比例

      Parameters

      • value: number

        线型比例因子

      Returns void

    • get lineWeight(): number

      获取线宽

      Returns number

      线宽值(-1=ByLayer, -2=ByBlock, >=0为具体值,单位为0.01mm)

    • set lineWeight(value: number): void

      设置线宽

      Parameters

      • value: number

        线宽值(-1=ByLayer, -2=ByBlock, >=0为具体值)

      Returns void

    • get transpMgr(): TransparencyManager

      获取透明度管理器

      Returns TransparencyManager

      透明度管理器实例

    • set transpMgr(value: TransparencyManager): void

      设置透明度管理器

      Parameters

      Returns void

    • get isAlive(): boolean

      获取实体存活状态

      Returns boolean

      是否存活(true表示有效,false表示已删除)

    • set isAlive(value: boolean): void

      设置实体存活状态

      Parameters

      • value: boolean

        是否存活

      Returns void

    • get xdataRaw(): Record<string, string>

      获取原始扩展数据(用于序列化) 格式: { "1001": "AppName", "1000": "JSON字符串" }

      Returns Record<string, string>

      原始xdata对象或undefined

    • set xdataRaw(value: Record<string, string>): void

      设置原始扩展数据(从数据库加载时使用)

      Parameters

      • value: Record<string, string>

        原始xdata对象

      Returns void

    • get extData(): Record<string, any>

      获取扩展数据(用户友好格式) 自动解析JSON字符串返回对象

      Returns Record<string, any>

      解析后的扩展数据对象,或undefined

      const data = entity.extData;
      console.log(data?.sensorVal); // 10
    • get extDataAppName(): string

      获取扩展数据的应用程序名(AppName)

      Returns string

      AppName字符串,或undefined

    • get doc(): any

      获取所属文档

      通过实体所在的块来获取文档对象。在CAD系统中, 实体总是属于某个块,而块又属于某个文档。

      Returns any

      文档对象,如果无法获取则返回undefined

    • get layer(): string

      获取图层名称

      根据实体的layerId从文档的图层集合中查找对应的图层名称。 如果找不到对应的图层,则返回默认图层"0"。

      Returns string

      图层名称,默认为"0"

    • set layer(layerName: string): void

      设置图层名称

      根据图层名称查找对应的图层ID并设置给实体。 如果找不到指定的图层,则使用默认图层ID("0")。

      注意:优先使用实体所属文档的图层列表,如果实体尚未添加到文档, 则使用 Engine.currentDoc 的图层列表。

      Parameters

      • layerName: string

        图层名称

      Returns void

    • get lineType(): string

      获取线型

      返回实体当前的线型设置。线型控制线条的显示样式 (如实线、虚线、点划线等)。

      Returns string

      线型名称

    • set lineType(lineTypeName: string): void

      设置线型

      设置实体的线型,支持标准CAD线型、常见别名和自定义线型。 输入的线型名称会被转换为大写进行匹配。

      支持的线型:

      • CONTINUOUS: 连续线(实线)
      • HIDDEN/DASHED: 虚线(虚线)
      • CENTER: 中心线
      • PHANTOM: 幻影线
      • DOT: 点线(映射为虚线)
      • 自定义线型:通过LinetypeManager管理的线型

      Parameters

      • lineTypeName: string

        线型名称

      Returns void

    Methods

    • 获取象限点

      计算圆形的四个象限点(右、上、左、下),可选择性地进行旋转。 象限点是圆形上的四个特殊点,常用于夹点编辑和对象捕捉。

      Parameters

      • rotationAngle: number = 0

        旋转角度(弧度),默认为0

      Returns Point2D[]

      四个象限点的坐标数组 [右, 上, 左, 下]

    • 根据面积设置半径

      根据指定的面积反推并设置圆形的半径。 使用公式:半径 = √(面积 / π)

      Parameters

      • targetArea: number

        目标面积

      Returns void

    • 获取直径

      计算圆形的直径,即半径的两倍。

      Returns number

      圆形直径

    • 根据直径设置半径

      根据指定的直径设置圆形的半径。

      Parameters

      • targetDiameter: number

        目标直径

      Returns void

    • 获取周长

      计算圆形的周长,使用公式:周长 = 2π × 半径

      Returns number

      圆形周长

    • 根据周长设置半径

      根据指定的周长反推并设置圆形的半径。 使用公式:半径 = 周长 / (2π)

      Parameters

      • targetCircumference: number

        目标周长

      Returns void

    • 检查所有关键点是否在指定框内

      对于圆形,只需检查圆心是否在指定的边界框内。 这是一个简化的可见性检测方法。

      Parameters

      Returns boolean

      如果圆心在框内返回true,否则返回false

    • 初始化圆形参数

      使用给定的圆心、半径和颜色初始化圆形。

      Parameters

      • centerPoint: Point2D

        圆心坐标

      • radiusValue: number

        半径值

      • color: number

        颜色索引

      Returns void

    • 镜像变换

      对圆形进行镜像变换,以指定的两点为镜像轴。 对于圆形,镜像操作只影响圆心位置,不影响半径。

      Parameters

      Returns void

    • 移动变换

      将圆形从一个位置移动到另一个位置。 只改变圆心位置,不影响半径。

      Parameters

      Returns void

    • 旋转变换

      围绕指定点旋转圆形。对于圆形,旋转只影响圆心位置。

      Parameters

      • rotationCenter: PointInput

        旋转中心点

      • rotationAngle: number

        旋转角度(弧度)

      Returns void

    • 缩放变换

      以指定点为中心对圆形进行缩放。 缩放会同时影响圆心位置和半径大小。

      Parameters

      • scaleCenter: PointInput

        缩放中心点

      • scaleFactor: number

        缩放因子

      Returns void

    • 拉伸变形操作

      根据拉伸框和移动向量对圆形进行拉伸。 如果圆心在拉伸框内,则移动整个圆形。

      Parameters

      Returns void

    • 夹点编辑操作

      根据夹点类型和新位置更新圆形的几何参数。 支持两种夹点类型:圆心和象限点。

      Parameters

      • newGripPosition: Point2D

        新的夹点位置

      • gripType: string

        夹点类型("center"=圆心,"quad"=象限点)

      Returns void

    • 修复拉伸操作

      从备份数据恢复圆形的几何参数,用于撤销拉伸操作。

      Parameters

      Returns void

    • 获取OpenGL渲染点集

      生成圆形的离散点集,用于OpenGL或WebGL渲染。 将圆形分为四个象限,每个象限生成相等数量的点。

      Parameters

      • totalPoints: number

        总点数(必须是4的倍数)

      Returns Point2D[]

      渲染点集数组,按象限顺序排列

    • 计算边界框

      根据指定的坐标系计算圆形的最小边界矩形。 对于圆形,边界框是以圆心为中心、边长为直径的正方形。

      Parameters

      • coordinateSystemType: CoordinateSystemType = CoordinateSystemType.WCS

        坐标系类型(M.WCS=世界坐标系,M.UCS=用户坐标系,M.DCS=显示坐标系)

      Returns BoundingBox

      边界框对象,包含最小点和最大点

    • 撤销映射操作

      从撤销数据恢复圆形的几何参数。

      Parameters

      Returns void

    • 克隆圆形

      创建当前圆形的完整副本,包括所有几何参数和属性。

      Returns CircleEnt

      新的圆形实例

    • 转换为数据库格式

      将圆形对象转换为适合数据库存储的格式。

      Returns DbCircle

      数据库格式的圆形对象

    • 从数据库格式恢复

      从数据库格式的对象恢复圆形的所有参数。

      Parameters

      • dbData: any

        数据库格式的圆形数据

      Returns void

    • 设置扩展数据(用户友好格式) 自动将对象序列化为JSON字符串存储

      Parameters

      • appName: string

        应用程序名(用于在DWG中标识数据来源)

      • data: Record<string, any>

        要存储的数据对象(将被序列化为JSON)

      Returns void

      entity.setExtData("MY_SENSOR", {
      sensorVal: 10,
      deviceName: "温度传感器",
      isActive: true
      });
    • 清除扩展数据

      Returns void

    • 检查是否有扩展数据

      Returns boolean

      是否存在扩展数据

    • 从默认属性对象复制属性

      将指定的默认属性对象的所有相关属性复制到当前实体。 这通常用于创建新实体时应用默认设置。

      Parameters

      • defaultPropsObject: any

        默认属性对象,包含layer、colorIndex、lineType等属性

      Returns this

      当前实例(支持链式调用)

    • 设置为系统默认值

      从全局CAD系统设置中获取当前的默认属性值并应用到实体。 这些默认值包括当前图层、当前颜色、当前线型等。

      使用的全局变量:

      • Engine.currentDoc.CLAYER: 当前图层名称
      • Engine.CECOLOR: 当前实体颜色
      • Engine.CELTYPE: 当前实体线型
      • Engine.CELTSCALE: 当前实体线型比例

      Returns void

    • 从数据库默认属性对象设置属性

      从数据库查询结果或序列化数据中恢复实体属性。 这个方法处理数据库中可能存在的空值和默认值情况。

      Parameters

      • dbPropsObject: any

        数据库属性对象,包含layerId、colorIndex等属性

      Returns this

      当前实例(支持链式调用)

    • 将属性映射到数据库默认属性对象

      将当前实体的属性映射到数据库存储格式的对象中。 用于保存实体数据到数据库或序列化。

      Parameters

      • targetDbObject: any

        目标数据库属性对象

      Returns any

      映射后的属性对象

    • 通知渲染系统此实体已被修改。 在桶渲染模式下,这将标记对应的桶为"脏",以便在下次 regenPartial 时重绘。 注意:此方法只标记,不触发重绘。调用方需要在适当的时候(如命令结束时)调用 regenPartial()

      Returns void

    • 释放实体占用的外部资源 子类如持有 PIXI 对象或大尺寸缓冲,应覆盖此方法清理

      Returns void