Skip to content
目录

类Entity

实体。

继承

属性

id

获取或设置编号。 string 类型。

name

获取或设置名称。 string 类型。

type

获取实体类型。 EntityType 类型。

visable

获取或设置可见性。 boolean 类型。

viewInfo

获取或设置观察视角。 ViewInfo 类型,默认值为 null

position

获取或设置位置。 Point3D 类型。

offset

获取或设置偏移量。 Point3D 类型。

rotation

获取或设置旋转(四元数)。 Point4D 类型。

euler

获取或设置欧拉角(弧度)。 Point3D 类型。

angles

获取或设置角度。 Point3D 类型。

scale

获取或设置缩放。 Point3D 类型。

center

获取包围盒中心点坐标(世界坐标)。 Point3D 类型。

radius

获取包围盒半径。 Point3D 类型。

size

获取包围盒大小。 Point3D 类型。

showBoundingBox

获取或设置是否显示包围盒。 boolean 类型。

showBox

获取或设置是否显示为盒子模式。 boolean 类型。

enablePointerMoveEvents

获取或设置允许指针移动事件。 boolean 类型。

pickable

获取或设置是否可被拾取。 boolean 类型。

cursor

获取或设置指针样式,与CSS保持一致。 string 类型。

children

获取子元素。 Entity 数组类型。

built

获取是否已创建。 boolean 类型。

parent

获取父元素。 Entity 类型。

tags

获取标签。 Set<string> 类型。

userData

获取用户数据。 Object 类型。

appEventIds

获取实体注册的应用事件ID列表,当实体销毁时自动移除集合中的事件。

方法

worldToLocal

typescript
worldToLocal(world: Point3D): Point3D;

世界坐标转局部坐标。

返回局部坐标, Point3D 类型。

参数

世界坐标。

localToWorld

typescript
localToWorld(local: Point3D): Point3D;

局部坐标转世界坐标。

返回世界坐标, Point3D 类型。

参数

局部坐标。

worldToScreen

typescript
worldToScreen(world: Point3D): Point2D;

世界坐标转屏幕坐标。

返回屏幕坐标, Point2D 类型。

参数

世界坐标。

localToScreen

typescript
localToScreen(local: Point3D): Point2D;

局部坐标转屏幕坐标。

返回屏幕坐标, Point2D 类型。

参数

局部坐标。

add

typescript
add(item: Entity, index?: number): void;

添加子元素。

返回 void 类型。

参数

子元素。

  • index : number

索引。可选,默认值为 undefined ,表示添加到末尾。

remove

typescript
remove(item: Entity): void;

移除子元素。

返回 void 类型。

参数

子元素。

removeSelf

typescript
removeSelf(): void;

从父元素中移除自身。

返回 void 类型。

无参数。

addComponent

typescript
addComponent<T extends Component>(type: new (entity: Entity) => T): T;

添加指定组件(不可重复添加)。

返回添加的组件对象, Component 子类类型。

参数

  • typeT extends Component

组件类型,是 Component 子类类型。

getComponent

typescript
getComponent<T extends Component>(type: new (entity: Entity) => T): T | null;

获取指定类型的组件。

返回添加的组件对象, Component 子类类型。不存在则返回 null

参数

  • typeT extends Component

组件类型,是 Component 子类类型。

disposeBox

typescript
disposeBox(): void;

释放盒子。

返回 void 类型。

无参数。

toJson

typescript
toJson(): any;

序列化成JSON对象。

返回JSON对象, Object 类型。

无参数。

fromJson

typescript
fromJson(json: any): void;

从JSON对象反序列化(仅生成层级树)。

参数

  • jsonObject

JSON对象, Object 类型。

build

typescript
async build(force: boolean = false): Promise<void>;

创建(仅当前层级可见对象),异步方法。

异步返回 void 类型。

参数

  • forceboolean

是否强制, boolean 类型,默认值 false

unbuild

typescript
unbuild(): void;

拆毁(销毁网格,仅保留层级树)。

返回 void 类型。

无参数。

技术支持:13352865103(柯工,微信同号);18688783852(柯工)