Class AssemblyEntityObject

| y | | | x /— — — — — — / / /z 右手坐标系

Hierarchy

EntityObject
- AssemblyEntityObject

Index

Constructors

Accessors

box2Front box2FrontAABBWCS box2FrontWCS box2Left box2LeftAABBWCS box2LeftWCS box2Top box2TopAABBWCS box2TopWCS box3 box3AABB box3AABBWCS box3WCS concatenatedMatrix matrix3Front matrix3Left matrix3Top matrix4 scaledSize

Constructors

constructor

new AssemblyEntityObject(id?): AssemblyEntityObject
Parameters
- id: string = ...
Returns AssemblyEntityObject
Inherited from EntityObject.constructor
- Defined in packages/design-engine/src/entity-object/index.ts:93

Properties

$$turboxProperties

$$turboxProperties: {
    $$turboxProperties?: { id?: string | undefined; name?: string | undefined; position?: Vector3 | undefined; rotation?: Vector3 | undefined; scale?: Vector3 | undefined; size?: Vector3 | undefined; ... 80 more ...; $update?: (<K extends never>(obj: {} | Pick<...>, actionName?: string | undefined, displayName?: string | undefined, forceSav...;
    box2Front: undefined | Vector2[];
    box2FrontAABBWCS: undefined | Vector2[];
    box2FrontWCS: undefined | Vector2[];
    box2Left: undefined | Vector2[];
    box2LeftAABBWCS: undefined | Vector2[];
    box2LeftWCS: undefined | Vector2[];
    box2Top: undefined | Vector2[];
    box2TopAABBWCS: undefined | Vector2[];
    box2TopWCS: undefined | Vector2[];
    box3: undefined | Vector3[];
    box3AABB: undefined | Vector3[];
    box3AABBWCS: undefined | Vector3[];
    box3WCS: undefined | Vector3[];
    children?: Set<EntityObject>;
    concatenatedMatrix: undefined | Matrix4;
    hidden?: boolean;
    id?: string;
    isClickable?: boolean;
    isDraggable?: boolean;
    isHoverable?: boolean;
    isPinchable?: boolean;
    isPressable?: boolean;
    isRotatable?: boolean;
    locked?: boolean;
    matrix3Front: undefined | Matrix3;
    matrix3Left: undefined | Matrix3;
    matrix3Top: undefined | Matrix3;
    matrix4: undefined | Matrix4;
    meshes?: MeshModel[];
    name?: string;
    parent?: EntityObject;
    position?: Vector3;
    renderOrder?: number;
    rotation?: Vector3;
    scale?: Vector3;
    scaledSize: undefined | Vector3;
    size?: Vector3;
    $update?<K>(obj, actionName?, displayName?, forceSaveHistory?, isNeedRecord?, immediately?): void;
    addChild?(child): AssemblyEntityObject;
    addChildren?(children): AssemblyEntityObject;
    clockwisePoints?(points, clockwise?): Vector2[];
    computedPropertyGet?<T>(key, options?, descriptor?): T;
    computedPropertySet?<T>(key, original): void;
    disposeReactivePipeLine?(): void;
    getBox2?(type, useWCS?): Vector2[];
    getBox2AABB?(type, useWCS?): Vector2[];
    getBox3?(matrix4?, useWCS?): Vector3[];
    getBox3AABB?(matrix4?, useWCS?): Vector3[];
    getConcatenatedMatrix?(): Matrix4;
    getConcatenatedMatrix3?(type): Matrix3;
    getDepth?(): number;
    getMatrix3?(type): Matrix3;
    getMatrix4?(order?): Matrix4;
    getParentPathChain?(): EntityObject[];
    getRawBox2?(type): Vector2[];
    getRawBox3?(): Box3;
    getRawBox3Points?(): Vector3[];
    getRoot?(stopCondition?): EntityObject;
    getScaledSize?(): Vector3;
    hide?(): AssemblyEntityObject;
    initDomainContext?(): {
        isNeedRecord: boolean;
    };
    isRoot?(): boolean;
    lock?(): AssemblyEntityObject;
    propertyGet?(key, config, hasInitializer?, defaultValue?): any;
    propertySet?(key, v, config): void;
    removeChild?(child): AssemblyEntityObject;
    removeChildren?(children?): AssemblyEntityObject;
    runReactivePipeLine?(): void;
    setClickable?(clickable): AssemblyEntityObject;
    setDraggable?(draggable): AssemblyEntityObject;
    setHoverable?(hoverable): AssemblyEntityObject;
    setInteractive?(interactive): AssemblyEntityObject;
    setMatrix4?(value): AssemblyEntityObject;
    setMeshes?(value): AssemblyEntityObject;
    setName?(name): AssemblyEntityObject;
    setPinchable?(pinchable): AssemblyEntityObject;
    setPosition?(position): AssemblyEntityObject;
    setPressable?(pressable): AssemblyEntityObject;
    setRenderOrder?(renderOrder): AssemblyEntityObject;
    setRotatable?(rotatable): AssemblyEntityObject;
    setRotation?(rotation): AssemblyEntityObject;
    setScale?(scale): AssemblyEntityObject;
    setSize?(size): AssemblyEntityObject;
    show?(): AssemblyEntityObject;
    traverse?(callback): AssemblyEntityObject;
    unlock?(): AssemblyEntityObject;
}

Type declaration

Optional $$turboxProperties?: { id?: string | undefined; name?: string | undefined; position?: Vector3 | undefined; rotation?: Vector3 | undefined; scale?: Vector3 | undefined; size?: Vector3 | undefined; ... 80 more ...; $update?: (<K extends never>(obj: {} | Pick<...>, actionName?: string | undefined, displayName?: string | undefined, forceSav...
box2Front: undefined | Vector2[]
box2FrontAABBWCS: undefined | Vector2[]
box2FrontWCS: undefined | Vector2[]
box2Left: undefined | Vector2[]
box2LeftAABBWCS: undefined | Vector2[]
box2LeftWCS: undefined | Vector2[]
box2Top: undefined | Vector2[]
box2TopAABBWCS: undefined | Vector2[]
box2TopWCS: undefined | Vector2[]
box3: undefined | Vector3[]
box3AABB: undefined | Vector3[]
box3AABBWCS: undefined | Vector3[]
box3WCS: undefined | Vector3[]
Optional children?: Set<EntityObject>
模型子节点
concatenatedMatrix: undefined | Matrix4
Optional hidden?: boolean
是否隐藏
Optional id?: string
Optional isClickable?: boolean
是否可被点击
Optional isDraggable?: boolean
是否可被拖拽
Optional isHoverable?: boolean
是否可被 hover
Optional isPinchable?: boolean
是否可被捏合（移动端）
Optional isPressable?: boolean
是否可被按压（移动端）
Optional isRotatable?: boolean
是否可被旋转（移动端）
Optional locked?: boolean
是否锁定
matrix3Front: undefined | Matrix3
matrix3Left: undefined | Matrix3
matrix3Top: undefined | Matrix3
matrix4: undefined | Matrix4
Optional meshes?: MeshModel[]
对应的模型网格
Optional name?: string
模型名称
Optional parent?: EntityObject
模型父节点
Optional position?: Vector3
模型位置
Optional renderOrder?: number
渲染顺序
Optional rotation?: Vector3
模型旋转角度（注意不是弧度）
Optional scale?: Vector3
模型缩放
scaledSize: undefined | Vector3
Optional size?: Vector3
模型尺寸
$update?:function
- $update<K>(obj, actionName?, displayName?, forceSaveHistory?, isNeedRecord?, immediately?): void
- the syntax sweet of updating state out of mutation
  Type Parameters
  - K extends never
  Parameters
  - obj: {} | Pick<{}, K>
  - Optional actionName: string
  - Optional displayName: string
  - Optional forceSaveHistory: boolean
  - Optional isNeedRecord: boolean
  - Optional immediately: boolean
  Returns void
  - Defined in packages/reactivity/typings/core/domain.d.ts:43
addChild?:function
- addChild(child): AssemblyEntityObject
- 添加子模型
  Parameters
  - child: EntityObject
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:418
addChildren?:function
- addChildren(children): AssemblyEntityObject
- 批量添加子模型
  Parameters
  - children: EntityObject[]
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:426
clockwisePoints?:function
- clockwisePoints(points, clockwise?): Vector2[]
- 把无序的点排序成顺逆时针，只支持凸多边形
  Parameters
  - points: Vector2[]
  - clockwise: boolean = false
  Returns Vector2[]
  - Defined in packages/design-engine/src/entity-object/index.ts:553
computedPropertyGet?:function
- computedPropertyGet<T>(key, options?, descriptor?): T
- Type Parameters
  - T
  Parameters
  - key: string
  - Optional options: ComputedOption
  - Optional descriptor: PropertyDescriptor
  Returns T
  - Defined in packages/reactivity/typings/core/domain.d.ts:38
computedPropertySet?:function
- computedPropertySet<T>(key, original): void
- Type Parameters
  - T
  Parameters
  - key: string
  - original: any
  Returns void
  - Defined in packages/reactivity/typings/core/domain.d.ts:39
disposeReactivePipeLine?:function
- disposeReactivePipeLine(): void
- 销毁所有响应式任务管线
  
  Returns void
  - Defined in packages/design-engine/src/entity-object/index.ts:111
getBox2?:function
- getBox2(type, useWCS?): Vector2[]
- Parameters
  - type: EPerspectiveType
  - useWCS: boolean = false
  Returns Vector2[]
  - Defined in packages/design-engine/src/entity-object/index.ts:573
getBox2AABB?:function
- getBox2AABB(type, useWCS?): Vector2[]
- Parameters
  - type: EPerspectiveType
  - useWCS: boolean = false
  Returns Vector2[]
  - Defined in packages/design-engine/src/entity-object/index.ts:541
getBox3?:function
- getBox3(matrix4?, useWCS?): Vector3[]
- Parameters
  - Optional matrix4: Matrix4
  - useWCS: boolean = false
  Returns Vector3[]
  - Defined in packages/design-engine/src/entity-object/index.ts:707
getBox3AABB?:function
- getBox3AABB(matrix4?, useWCS?): Vector3[]
- Parameters
  - Optional matrix4: Matrix4
  - useWCS: boolean = false
  Returns Vector3[]
  - Defined in packages/design-engine/src/entity-object/index.ts:692
getConcatenatedMatrix?:function
- getConcatenatedMatrix(): Matrix4
- Returns Matrix4
  - Defined in packages/design-engine/src/entity-object/index.ts:519
getConcatenatedMatrix3?:function
- getConcatenatedMatrix3(type): Matrix3
- Parameters
  - type: EPerspectiveType
  Returns Matrix3
  - Defined in packages/design-engine/src/entity-object/index.ts:530
getDepth?:function
- getDepth(): number
- 获取模型节点深度
  
  Returns number
  - Defined in packages/design-engine/src/entity-object/index.ts:466
getMatrix3?:function
- getMatrix3(type): Matrix3
- Parameters
  - type: EPerspectiveType
  Returns Matrix3
  - Defined in packages/design-engine/src/entity-object/index.ts:733
getMatrix4?:function
- getMatrix4(order?): Matrix4
- Parameters
  - order: string = 'ZYX'
  Returns Matrix4
  - Defined in packages/design-engine/src/entity-object/index.ts:713
getParentPathChain?:function
- getParentPathChain(): EntityObject[]
- 获取该模型与其祖先节点的路径链（从祖先节点到当前模型的顺序）
  
  Returns EntityObject[]
  - Defined in packages/design-engine/src/entity-object/index.ts:454
getRawBox2?:function
- getRawBox2(type): Vector2[]
- Parameters
  - type: EPerspectiveType
  Returns Vector2[]
  - Defined in packages/design-engine/src/entity-object/index.ts:638
getRawBox3?:function
- getRawBox3(): Box3
- 初始建模包围盒，默认建模原点为几何中心，如需修改请重写该方法
  
  Returns Box3
  Breaking Change
  之前建模原点默认为左后下，现在默认为几何中心（更便于做计算）
  - Defined in packages/design-engine/src/entity-object/index.ts:669
getRawBox3Points?:function
- getRawBox3Points(): Vector3[]
- Returns Vector3[]
  - Defined in packages/design-engine/src/entity-object/index.ts:677
getRoot?:function
- getRoot(stopCondition?): EntityObject
- 获取该模型的顶层模型
  Parameters
  - Optional stopCondition: ((currentNode) => boolean)
    停止查找的条件函数，返回 true 就停下查找
    - (currentNode): boolean
      Parameters
      currentNode: EntityObject
      Returns boolean
  Returns EntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:391
getScaledSize?:function
- getScaledSize(): Vector3
- Returns Vector3
  - Defined in packages/design-engine/src/entity-object/index.ts:727
hide?:function
- hide(): AssemblyEntityObject
- 隐藏模型
  
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:339
initDomainContext?:function
- initDomainContext(): {
  isNeedRecord: boolean;
  }
- Returns {
  isNeedRecord: boolean;
  }
  - isNeedRecord: boolean
  - Defined in packages/design-engine/src/entity-object/index.ts:99
isRoot?:function
- isRoot(): boolean
- 是否是顶层模型
  
  Returns boolean
  - Defined in packages/design-engine/src/entity-object/index.ts:383
lock?:function
- lock(): AssemblyEntityObject
- 锁定
  
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:325
propertyGet?:function
- propertyGet(key, config, hasInitializer?, defaultValue?): any
- Parameters
  - key: string
  - config: ReactorConfig
  - Optional hasInitializer: boolean
  - Optional defaultValue: any
  Returns any
  - Defined in packages/reactivity/typings/core/domain.d.ts:36
propertySet?:function
- propertySet(key, v, config): void
- Parameters
  - key: string
  - v: any
  - config: ReactorConfig
  Returns void
  - Defined in packages/reactivity/typings/core/domain.d.ts:37
removeChild?:function
- removeChild(child): AssemblyEntityObject
- 删除子模型
  Parameters
  - child: EntityObject
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:433
removeChildren?:function
- removeChildren(children?): AssemblyEntityObject
- 批量移除指定的子模型，不传参则移除所有子模型
  Parameters
  - Optional children: EntityObject[]
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:441
runReactivePipeLine?:function
- runReactivePipeLine(): void
- 启动响应式任务管线
  
  Returns void
  - Defined in packages/design-engine/src/entity-object/index.ts:106
setClickable?:function
- setClickable(clickable): AssemblyEntityObject
- Parameters
  - clickable: boolean
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:270
setDraggable?:function
- setDraggable(draggable): AssemblyEntityObject
- Parameters
  - draggable: boolean
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:282
setHoverable?:function
- setHoverable(hoverable): AssemblyEntityObject
- Parameters
  - hoverable: boolean
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:276
setInteractive?:function
- setInteractive(interactive): AssemblyEntityObject
- 设置是否可交互
  Parameters
  - interactive: boolean
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:307
setMatrix4?:function
- setMatrix4(value): AssemblyEntityObject
- 设置一个 4x4 矩阵
  Parameters
  - value: Matrix4
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:360
setMeshes?:function
- setMeshes(value): AssemblyEntityObject
- Parameters
  - value: MeshModel[]
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:514
setName?:function
- setName(name): AssemblyEntityObject
- 设置名称
  Parameters
  - name: string
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:353
setPinchable?:function
- setPinchable(pinchable): AssemblyEntityObject
- Parameters
  - pinchable: boolean
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:288
setPosition?:function
- setPosition(position): AssemblyEntityObject
- Parameters
  - position: {
        x?: number;
        y?: number;
        z?: number;
    }
    - Optional x?: number
    - Optional y?: number
    - Optional z?: number
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:478
setPressable?:function
- setPressable(pressable): AssemblyEntityObject
- Parameters
  - pressable: boolean
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:300
setRenderOrder?:function
- setRenderOrder(renderOrder): AssemblyEntityObject
- Parameters
  - renderOrder: number
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:318
setRotatable?:function
- setRotatable(rotatable): AssemblyEntityObject
- Parameters
  - rotatable: boolean
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:294
setRotation?:function
- setRotation(rotation): AssemblyEntityObject
- Parameters
  - rotation: {
        x?: number;
        y?: number;
        z?: number;
    }
    - Optional x?: number
    - Optional y?: number
    - Optional z?: number
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:487
setScale?:function
- setScale(scale): AssemblyEntityObject
- Parameters
  - scale: {
        x?: number;
        y?: number;
        z?: number;
    }
    - Optional x?: number
    - Optional y?: number
    - Optional z?: number
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:496
setSize?:function
- setSize(size): AssemblyEntityObject
- Parameters
  - size: {
        x?: number;
        y?: number;
        z?: number;
    }
    - Optional x?: number
    - Optional y?: number
    - Optional z?: number
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:505
show?:function
- show(): AssemblyEntityObject
- 显示模型
  
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:346
traverse?:function
- traverse(callback): AssemblyEntityObject
- 遍历
  Parameters
  - callback: ((current) => boolean | void)
    遍历的处理逻辑函数，返回值是布尔值，如果是 true，则会停止当前遍历到的节点继续往下遍历
    - (current): boolean | void
      Parameters
      current: EntityObject
      Returns boolean | void
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:405
unlock?:function
- unlock(): AssemblyEntityObject
- 解锁
  
  Returns AssemblyEntityObject
  - Defined in packages/design-engine/src/entity-object/index.ts:332

children

children: Set<EntityObject> = ...

模型子节点

hidden

hidden: boolean = false

是否隐藏

id

id: string

isClickable

isClickable: boolean = true

是否可被点击

isDraggable

isDraggable: boolean = true

是否可被拖拽

isHoverable

isHoverable: boolean = true

是否可被 hover

isPinchable

isPinchable: boolean = true

是否可被捏合（移动端）

isPressable

isPressable: boolean = true

是否可被按压（移动端）

isRotatable

isRotatable: boolean = true

是否可被旋转（移动端）

locked

locked: boolean = false

是否锁定

meshes

meshes: MeshModel[] = []

对应的模型网格

name

name: string = ''

模型名称

`Optional` parent

parent?: EntityObject

模型父节点

position

position: Vector3 = ...

模型位置

`Protected` reactivePipeLine

reactivePipeLine: {
    func: Function;
    options?: {
        deps?: Function[];
        immediately?: boolean;
        name?: string;
    };
}[] = []

响应式的任务管线

Type declaration

func: Function
Optional options?: {
    deps?: Function[];
    immediately?: boolean;
    name?: string;
}
- Optional deps?: Function[]
- Optional immediately?: boolean
- Optional name?: string

renderOrder

renderOrder: number = 0

渲染顺序

rotation

rotation: Vector3 = ...

模型旋转角度（注意不是弧度）

scale

scale: Vector3 = ...

模型缩放

size

size: Vector3 = ...

模型尺寸

`Static` EPerspectiveType

EPerspectiveType: typeof EPerspectiveType = EPerspectiveType

Accessors

box2Front

get box2Front(): Vector2[]
top 3---------2 | | |left |right | | 0---------1 bottom 正视/立面的紧贴包围盒点集合，忽略 x、y 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2Front
- Defined in packages/design-engine/src/entity-object/index.ts:153

box2FrontAABBWCS

get box2FrontAABBWCS(): Vector2[]
基于世界坐标系的正视/立面的 AABB 包围盒点集合，忽略 x、y 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2FrontAABBWCS
- Defined in packages/design-engine/src/entity-object/index.ts:167

box2FrontWCS

get box2FrontWCS(): Vector2[]
基于世界坐标系的正视/立面的紧贴包围盒点集合，忽略 x、y 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2FrontWCS
- Defined in packages/design-engine/src/entity-object/index.ts:159

box2Left

get box2Left(): Vector2[]
top 3---------2 | | |left |right | | 0---------1 bottom 左视的紧贴包围盒点集合，忽略 y、z 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2Left
- Defined in packages/design-engine/src/entity-object/index.ts:181

box2LeftAABBWCS

get box2LeftAABBWCS(): Vector2[]
基于世界坐标系的左视的 AABB 包围盒点集合，忽略 y、z 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2LeftAABBWCS
- Defined in packages/design-engine/src/entity-object/index.ts:195

box2LeftWCS

get box2LeftWCS(): Vector2[]
基于世界坐标系的左视的紧贴包围盒点集合，忽略 y、z 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2LeftWCS
- Defined in packages/design-engine/src/entity-object/index.ts:187

box2Top

get box2Top(): Vector2[]
back 0---------3 | | |left |right | | 1---------2 front 顶视的紧贴包围盒点集合，忽略 x、z 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2Top
- Defined in packages/design-engine/src/entity-object/index.ts:125

box2TopAABBWCS

get box2TopAABBWCS(): Vector2[]
基于世界坐标系的顶视的 AABB 包围盒点集合，忽略 x、z 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2TopAABBWCS
- Defined in packages/design-engine/src/entity-object/index.ts:139

box2TopWCS

get box2TopWCS(): Vector2[]
基于世界坐标系的顶视的紧贴包围盒点集合，忽略 x、z 轴旋转

Returns Vector2[]
Inherited from EntityObject.box2TopWCS
- Defined in packages/design-engine/src/entity-object/index.ts:131

box3

get box3(): Vector3[]
7-----------6 / . / | / . / | 4-----------5 | | . | | | . | | | 0.......|...3 | . | / | . | / 1-----------2 三维的紧贴包围盒点集合

Returns Vector3[]
Inherited from EntityObject.box3
- Defined in packages/design-engine/src/entity-object/index.ts:213

box3AABB

get box3AABB(): Vector3[]
三维的 AABB 包围盒点集合

Returns Vector3[]
Inherited from EntityObject.box3AABB
- Defined in packages/design-engine/src/entity-object/index.ts:227

box3AABBWCS

get box3AABBWCS(): Vector3[]
基于世界坐标系的三维的 AABB 包围盒点集合

Returns Vector3[]
Inherited from EntityObject.box3AABBWCS
- Defined in packages/design-engine/src/entity-object/index.ts:235

box3WCS

get box3WCS(): Vector3[]
基于世界坐标系的三维的紧贴包围盒点集合

Returns Vector3[]
Inherited from EntityObject.box3WCS
- Defined in packages/design-engine/src/entity-object/index.ts:219

concatenatedMatrix

get concatenatedMatrix(): Matrix4
相对于世界坐标系的矩阵

Returns Matrix4
Inherited from EntityObject.concatenatedMatrix
- Defined in packages/design-engine/src/entity-object/index.ts:378

matrix3Front

get matrix3Front(): Matrix3
3x3 entity 正视/立面矩阵

Returns Matrix3
Inherited from EntityObject.matrix3Front
- Defined in packages/design-engine/src/entity-object/index.ts:253

matrix3Left

get matrix3Left(): Matrix3
3x3 entity 左视矩阵

Returns Matrix3
Inherited from EntityObject.matrix3Left
- Defined in packages/design-engine/src/entity-object/index.ts:259

matrix3Top

get matrix3Top(): Matrix3
3x3 entity 顶视矩阵

Returns Matrix3
Inherited from EntityObject.matrix3Top
- Defined in packages/design-engine/src/entity-object/index.ts:247

matrix4

get matrix4(): Matrix4
4x4 entity 矩阵

Returns Matrix4
Inherited from EntityObject.matrix4
- Defined in packages/design-engine/src/entity-object/index.ts:265

scaledSize

get scaledSize(): Vector3
缩放过的尺寸

Returns Vector3
Inherited from EntityObject.scaledSize
- Defined in packages/design-engine/src/entity-object/index.ts:241

Methods

$update

$update<K>(obj, actionName?, displayName?, forceSaveHistory?, isNeedRecord?, immediately?): void
the syntax sweet of updating state out of mutation
Type Parameters
- K extends never
Parameters
- obj: {} | Pick<{}, K>
- Optional actionName: string
- Optional displayName: string
- Optional forceSaveHistory: boolean
- Optional isNeedRecord: boolean
- Optional immediately: boolean
Returns void
Inherited from EntityObject.$update
- Defined in packages/reactivity/typings/core/domain.d.ts:43

addChild

addChild(child): AssemblyEntityObject
添加子模型
Parameters
- child: EntityObject
Returns AssemblyEntityObject
Inherited from EntityObject.addChild
- Defined in packages/design-engine/src/entity-object/index.ts:418

addChildren

addChildren(children): AssemblyEntityObject
批量添加子模型
Parameters
- children: EntityObject[]
Returns AssemblyEntityObject
Inherited from EntityObject.addChildren
- Defined in packages/design-engine/src/entity-object/index.ts:426

clockwisePoints

clockwisePoints(points, clockwise?): Vector2[]
把无序的点排序成顺逆时针，只支持凸多边形
Parameters
- points: Vector2[]
- clockwise: boolean = false
Returns Vector2[]
Inherited from EntityObject.clockwisePoints
- Defined in packages/design-engine/src/entity-object/index.ts:553

computedPropertyGet

computedPropertyGet<T>(key, options?, descriptor?): T
Type Parameters
- T
Parameters
- key: string
- Optional options: ComputedOption
- Optional descriptor: PropertyDescriptor
Returns T
Inherited from EntityObject.computedPropertyGet
- Defined in packages/reactivity/typings/core/domain.d.ts:38

computedPropertySet

computedPropertySet<T>(key, original): void
Type Parameters
- T
Parameters
- key: string
- original: any
Returns void
Inherited from EntityObject.computedPropertySet
- Defined in packages/reactivity/typings/core/domain.d.ts:39

disposeReactivePipeLine

disposeReactivePipeLine(): void
销毁所有响应式任务管线

Returns void
Inherited from EntityObject.disposeReactivePipeLine
- Defined in packages/design-engine/src/entity-object/index.ts:111

getBox2

getBox2(type, useWCS?): Vector2[]
Parameters
- type: EPerspectiveType
- useWCS: boolean = false
Returns Vector2[]
Inherited from EntityObject.getBox2
- Defined in packages/design-engine/src/entity-object/index.ts:573

getBox2AABB

getBox2AABB(type, useWCS?): Vector2[]
Parameters
- type: EPerspectiveType
- useWCS: boolean = false
Returns Vector2[]
Inherited from EntityObject.getBox2AABB
- Defined in packages/design-engine/src/entity-object/index.ts:541

getBox3

getBox3(matrix4?, useWCS?): Vector3[]
Parameters
- Optional matrix4: Matrix4
- useWCS: boolean = false
Returns Vector3[]
Inherited from EntityObject.getBox3
- Defined in packages/design-engine/src/entity-object/index.ts:707

getBox3AABB

getBox3AABB(matrix4?, useWCS?): Vector3[]
Parameters
- Optional matrix4: Matrix4
- useWCS: boolean = false
Returns Vector3[]
Inherited from EntityObject.getBox3AABB
- Defined in packages/design-engine/src/entity-object/index.ts:692

getConcatenatedMatrix

getConcatenatedMatrix(): Matrix4
Returns Matrix4
Inherited from EntityObject.getConcatenatedMatrix
- Defined in packages/design-engine/src/entity-object/index.ts:519

getConcatenatedMatrix3

getConcatenatedMatrix3(type): Matrix3
Parameters
- type: EPerspectiveType
Returns Matrix3
Inherited from EntityObject.getConcatenatedMatrix3
- Defined in packages/design-engine/src/entity-object/index.ts:530

getDepth

getDepth(): number
获取模型节点深度

Returns number
Inherited from EntityObject.getDepth
- Defined in packages/design-engine/src/entity-object/index.ts:466

getMatrix3

getMatrix3(type): Matrix3
Parameters
- type: EPerspectiveType
Returns Matrix3
Inherited from EntityObject.getMatrix3
- Defined in packages/design-engine/src/entity-object/index.ts:733

getMatrix4

getMatrix4(order?): Matrix4
Parameters
- order: string = 'ZYX'
Returns Matrix4
Inherited from EntityObject.getMatrix4
- Defined in packages/design-engine/src/entity-object/index.ts:713

getParentPathChain

getParentPathChain(): EntityObject[]
获取该模型与其祖先节点的路径链（从祖先节点到当前模型的顺序）

Returns EntityObject[]
Inherited from EntityObject.getParentPathChain
- Defined in packages/design-engine/src/entity-object/index.ts:454

getRawBox2

getRawBox2(type): Vector2[]
Parameters
- type: EPerspectiveType
Returns Vector2[]
Inherited from EntityObject.getRawBox2
- Defined in packages/design-engine/src/entity-object/index.ts:638

getRawBox3

getRawBox3(): Box3
初始建模包围盒，默认建模原点为几何中心，如需修改请重写该方法

Returns Box3
Breaking Change
之前建模原点默认为左后下，现在默认为几何中心（更便于做计算）
Inherited from EntityObject.getRawBox3
- Defined in packages/design-engine/src/entity-object/index.ts:669

getRawBox3Points

getRawBox3Points(): Vector3[]
Returns Vector3[]
Inherited from EntityObject.getRawBox3Points
- Defined in packages/design-engine/src/entity-object/index.ts:677

getRoot

getRoot(stopCondition?): EntityObject
获取该模型的顶层模型
Parameters
- Optional stopCondition: ((currentNode) => boolean)
  停止查找的条件函数，返回 true 就停下查找
  - - (currentNode): boolean
    - Parameters
      currentNode: EntityObject
      Returns boolean
Returns EntityObject
Inherited from EntityObject.getRoot
- Defined in packages/design-engine/src/entity-object/index.ts:391

getScaledSize

getScaledSize(): Vector3
Returns Vector3
Inherited from EntityObject.getScaledSize
- Defined in packages/design-engine/src/entity-object/index.ts:727

hide

hide(): AssemblyEntityObject
隐藏模型

Returns AssemblyEntityObject
Inherited from EntityObject.hide
- Defined in packages/design-engine/src/entity-object/index.ts:339

initDomainContext

initDomainContext(): {
isNeedRecord: boolean;
}
Returns {
isNeedRecord: boolean;
}
- isNeedRecord: boolean
Inherited from EntityObject.initDomainContext
- Defined in packages/design-engine/src/entity-object/index.ts:99

isRoot

isRoot(): boolean
是否是顶层模型

Returns boolean
Inherited from EntityObject.isRoot
- Defined in packages/design-engine/src/entity-object/index.ts:383

lock

lock(): AssemblyEntityObject
锁定

Returns AssemblyEntityObject
Inherited from EntityObject.lock
- Defined in packages/design-engine/src/entity-object/index.ts:325

propertyGet

propertyGet(key, config, hasInitializer?, defaultValue?): any
Parameters
- key: string
- config: ReactorConfig
- Optional hasInitializer: boolean
- Optional defaultValue: any
Returns any
Inherited from EntityObject.propertyGet
- Defined in packages/reactivity/typings/core/domain.d.ts:36

propertySet

propertySet(key, v, config): void
Parameters
- key: string
- v: any
- config: ReactorConfig
Returns void
Inherited from EntityObject.propertySet
- Defined in packages/reactivity/typings/core/domain.d.ts:37

removeChild

removeChild(child): AssemblyEntityObject
删除子模型
Parameters
- child: EntityObject
Returns AssemblyEntityObject
Inherited from EntityObject.removeChild
- Defined in packages/design-engine/src/entity-object/index.ts:433

removeChildren

removeChildren(children?): AssemblyEntityObject
批量移除指定的子模型，不传参则移除所有子模型
Parameters
- Optional children: EntityObject[]
Returns AssemblyEntityObject
Inherited from EntityObject.removeChildren
- Defined in packages/design-engine/src/entity-object/index.ts:441

runReactivePipeLine

runReactivePipeLine(): void
启动响应式任务管线

Returns void
Inherited from EntityObject.runReactivePipeLine
- Defined in packages/design-engine/src/entity-object/index.ts:106

setInteractive

setInteractive(interactive): AssemblyEntityObject
设置是否可交互
Parameters
- interactive: boolean
Returns AssemblyEntityObject
Inherited from EntityObject.setInteractive
- Defined in packages/design-engine/src/entity-object/index.ts:307

setMatrix4

setMatrix4(value): AssemblyEntityObject
设置一个 4x4 矩阵
Parameters
- value: Matrix4
Returns AssemblyEntityObject
Inherited from EntityObject.setMatrix4
- Defined in packages/design-engine/src/entity-object/index.ts:360

setMeshes

setMeshes(value): AssemblyEntityObject
Parameters
- value: MeshModel[]
Returns AssemblyEntityObject
Inherited from EntityObject.setMeshes
- Defined in packages/design-engine/src/entity-object/index.ts:514

setName

setName(name): AssemblyEntityObject
设置名称
Parameters
- name: string
Returns AssemblyEntityObject
Inherited from EntityObject.setName
- Defined in packages/design-engine/src/entity-object/index.ts:353

setPinchable

setPinchable(pinchable): AssemblyEntityObject
Parameters
- pinchable: boolean
Returns AssemblyEntityObject
Inherited from EntityObject.setPinchable
- Defined in packages/design-engine/src/entity-object/index.ts:288

setPosition

setPosition(position): AssemblyEntityObject
Parameters
- position: {
      x?: number;
      y?: number;
      z?: number;
  }
  - Optional x?: number
  - Optional y?: number
  - Optional z?: number
Returns AssemblyEntityObject
Inherited from EntityObject.setPosition
- Defined in packages/design-engine/src/entity-object/index.ts:478

setPressable

setPressable(pressable): AssemblyEntityObject
Parameters
- pressable: boolean
Returns AssemblyEntityObject
Inherited from EntityObject.setPressable
- Defined in packages/design-engine/src/entity-object/index.ts:300

setRenderOrder

setRenderOrder(renderOrder): AssemblyEntityObject
Parameters
- renderOrder: number
Returns AssemblyEntityObject
Inherited from EntityObject.setRenderOrder
- Defined in packages/design-engine/src/entity-object/index.ts:318

setRotatable

setRotatable(rotatable): AssemblyEntityObject
Parameters
- rotatable: boolean
Returns AssemblyEntityObject
Inherited from EntityObject.setRotatable
- Defined in packages/design-engine/src/entity-object/index.ts:294

setRotation

setRotation(rotation): AssemblyEntityObject
Parameters
- rotation: {
      x?: number;
      y?: number;
      z?: number;
  }
  - Optional x?: number
  - Optional y?: number
  - Optional z?: number
Returns AssemblyEntityObject
Inherited from EntityObject.setRotation
- Defined in packages/design-engine/src/entity-object/index.ts:487

setScale

setScale(scale): AssemblyEntityObject
Parameters
- scale: {
      x?: number;
      y?: number;
      z?: number;
  }
  - Optional x?: number
  - Optional y?: number
  - Optional z?: number
Returns AssemblyEntityObject
Inherited from EntityObject.setScale
- Defined in packages/design-engine/src/entity-object/index.ts:496

setSize

setSize(size): AssemblyEntityObject
Parameters
- size: {
      x?: number;
      y?: number;
      z?: number;
  }
  - Optional x?: number
  - Optional y?: number
  - Optional z?: number
Returns AssemblyEntityObject
Inherited from EntityObject.setSize
- Defined in packages/design-engine/src/entity-object/index.ts:505

show

show(): AssemblyEntityObject
显示模型

Returns AssemblyEntityObject
Inherited from EntityObject.show
- Defined in packages/design-engine/src/entity-object/index.ts:346

traverse

traverse(callback): AssemblyEntityObject
遍历
Parameters
- callback: ((current) => boolean | void)
  遍历的处理逻辑函数，返回值是布尔值，如果是 true，则会停止当前遍历到的节点继续往下遍历
  - - (current): boolean | void
    - Parameters
      current: EntityObject
      Returns boolean | void
Returns AssemblyEntityObject
Inherited from EntityObject.traverse
- Defined in packages/design-engine/src/entity-object/index.ts:405

unlock

unlock(): AssemblyEntityObject
解锁

Returns AssemblyEntityObject
Inherited from EntityObject.unlock
- Defined in packages/design-engine/src/entity-object/index.ts:332

`Static` getEntityById

getEntityById(id): undefined | EntityObject
Parameters
- id: string
Returns undefined | EntityObject
Inherited from EntityObject.getEntityById
- Defined in packages/design-engine/src/entity-object/index.ts:41

Class AssemblyEntityObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string = ...

Returns AssemblyEntityObject

Properties

$$turboxProperties

Type declaration

box2Front: undefined | Vector2[]

box2FrontAABBWCS: undefined | Vector2[]

box2FrontWCS: undefined | Vector2[]

box2Left: undefined | Vector2[]

box2LeftAABBWCS: undefined | Vector2[]

box2LeftWCS: undefined | Vector2[]

box2Top: undefined | Vector2[]

box2TopAABBWCS: undefined | Vector2[]

box2TopWCS: undefined | Vector2[]

box3: undefined | Vector3[]

box3AABB: undefined | Vector3[]

box3AABBWCS: undefined | Vector3[]

box3WCS: undefined | Vector3[]

Optional children?: Set<EntityObject>

concatenatedMatrix: undefined | Matrix4

Optional hidden?: boolean

Optional id?: string

Optional isClickable?: boolean

Optional isDraggable?: boolean

Optional isHoverable?: boolean

Optional isPinchable?: boolean

Optional isPressable?: boolean

Optional isRotatable?: boolean

Optional locked?: boolean

matrix3Front: undefined | Matrix3

matrix3Left: undefined | Matrix3

matrix3Top: undefined | Matrix3

matrix4: undefined | Matrix4

Optional meshes?: MeshModel[]

Optional name?: string

Optional parent?: EntityObject

Optional position?: Vector3

Optional renderOrder?: number

Optional rotation?: Vector3

Optional scale?: Vector3

scaledSize: undefined | Vector3

Optional size?: Vector3

$update?:function

Type Parameters

K extends never

Parameters

obj: {} | Pick<{}, K>

Optional actionName: string

Optional displayName: string

Optional forceSaveHistory: boolean

Optional isNeedRecord: boolean

Optional immediately: boolean

Returns void

addChild?:function

Parameters

child: EntityObject

Returns AssemblyEntityObject

addChildren?:function

Parameters

children: EntityObject[]

Returns AssemblyEntityObject

clockwisePoints?:function

Parameters

points: Vector2[]

clockwise: boolean = false

Returns Vector2[]

computedPropertyGet?:function

Type Parameters

T

Parameters

`Optional` children?: Set<EntityObject>

`Optional` hidden?: boolean

`Optional` id?: string

`Optional` isClickable?: boolean

`Optional` isDraggable?: boolean

`Optional` isHoverable?: boolean

`Optional` isPinchable?: boolean

`Optional` isPressable?: boolean

`Optional` isRotatable?: boolean

`Optional` locked?: boolean

`Optional` meshes?: MeshModel[]

`Optional` name?: string

`Optional` parent?: EntityObject

`Optional` position?: Vector3

`Optional` renderOrder?: number

`Optional` rotation?: Vector3

`Optional` scale?: Vector3

`Optional` size?: Vector3

`Optional` actionName: string

`Optional` displayName: string

`Optional` forceSaveHistory: boolean

`Optional` isNeedRecord: boolean

`Optional` immediately: boolean

`Optional` options: ComputedOption

`Optional` descriptor: PropertyDescriptor

`Optional` matrix4: Matrix4

`Optional` matrix4: Matrix4

`Optional` stopCondition: ((currentNode) => boolean)