Class: GUIMesh ​

大部分对象的基类，提供了一系列的属性和方法来对三维空间中的物体进行操作。

Hierarchy ​

• Object3D

  ↳ GUIMesh

Properties ​

• name
• transform
• renderNode
• entityChildren
• components
• bound
• serializeTag
• prefabRef
• uiRenderer
• geometry
• space

Accessors ​

• uuid
• renderLayer
• visible
• numChildren
• isScene3D
• localPosition
• localRotation
• localScale
• localQuaternion
• parent
• parentObject
• x
• y
• z
• scaleX
• scaleY
• scaleZ
• rotationX
• rotationY
• rotationZ
• quadMaxCount

Methods ​

• getObjectByName
• addChild
• removeChild
• removeAllChild
• removeChildByIndex
• hasChild
• removeFromParent
• getChildByIndex
• getChildByName
• genBounds
• forChild
• addComponent
• getOrAddComponent
• removeComponent
• hasComponent
• getComponent
• getComponentFromParent
• getComponentsInChild
• getComponents
• getComponentsExt
• clone
• notifyChange
• getWorldPosition
• traverse
• destroy
• serialization
• unSerialize
• showDebugAxis
• dispatchEvent
• addEventListener
• removeEventListener
• removeEventListenerAt
• removeAllEventListener
• containEventListener
• hasEventListener
• setTextures
• sortIndex
• updateGUIData

Constructors ​

• constructor

Properties ​

name ​

• name: string = ''

对象的名称。默认值是一个空字符串。

Inherited from ​

Object3D.name

Defined in ​

src/engine/core/entities/Entity.ts:24

transform ​

• transform: Transform

附加到此对象的Transform。

Inherited from ​

Object3D.transform

Defined in ​

src/engine/core/entities/Entity.ts:58

renderNode ​

• renderNode: RenderNode

渲染器组件

Inherited from ​

Object3D.renderNode

Defined in ​

src/engine/core/entities/Entity.ts:63

entityChildren ​

• entityChildren: Entity[]

包含对象子对象的数组

Inherited from ​

Object3D.entityChildren

Defined in ​

src/engine/core/entities/Entity.ts:68

components ​

• components: Map<any, ComponentBase>

对象所附加的组件列表

Inherited from ​

Object3D.components

Defined in ​

src/engine/core/entities/Entity.ts:73

bound ​

• bound: IBound

对象的的包围体

Inherited from ​

Object3D.bound

Defined in ​

src/engine/core/entities/Entity.ts:78

serializeTag ​

• Optional serializeTag: SerializeTag

Inherited from ​

Object3D.serializeTag

Defined in ​

src/engine/core/entities/Object3D.ts:19

prefabRef ​

• Optional prefabRef: string

Inherited from ​

Object3D.prefabRef

Defined in ​

src/engine/core/entities/Object3D.ts:20

uiRenderer ​

• uiRenderer: GUIMeshRenderer

Defined in ​

src/engine/gui/core/GUIMesh.ts:7

geometry ​

• geometry: GUIGeometry

Defined in ​

src/engine/gui/core/GUIMesh.ts:8

space ​

• space: GUISpace

Defined in ​

src/engine/gui/core/GUIMesh.ts:9

Accessors ​

uuid ​

• get uuid(): string

该对象的唯一标识符。

Returns ​

string

Inherited from ​

Object3D.uuid

Defined in ​

src/engine/core/entities/Entity.ts:31

renderLayer ​

• get renderLayer(): RenderLayer

Returns ​

RenderLayer

Inherited from ​

Object3D.renderLayer

Defined in ​

src/engine/core/entities/Entity.ts:42

• set renderLayer(value): void

Parameters ​

Returns ​

void

Inherited from ​

Object3D.renderLayer

Defined in ​

src/engine/core/entities/Entity.ts:46

visible ​

• get visible(): boolean

对象是否可见

Returns ​

boolean

Inherited from ​

Object3D.visible

Defined in ​

src/engine/core/entities/Entity.ts:116

• set visible(value): void

设置对象是否可见

Parameters ​

Returns ​

void

Inherited from ​

Object3D.visible

Defined in ​

src/engine/core/entities/Entity.ts:123

numChildren ​

• get numChildren(): number

返回对象子对象的数量

Returns ​

number

Inherited from ​

Object3D.numChildren

Defined in ​

src/engine/core/entities/Entity.ts:154

isScene3D ​

• get isScene3D(): boolean

Returns ​

boolean

Inherited from ​

Object3D.isScene3D

Defined in ​

src/engine/core/entities/Object3D.ts:29

localPosition ​

• get localPosition(): Vector3

物体相对于父级的位置

Returns ​

Vector3

Inherited from ​

Object3D.localPosition

Defined in ​

src/engine/core/entities/Object3D.ts:239

• set localPosition(value): void

设置物体相对于父级的位置

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localPosition

Defined in ​

src/engine/core/entities/Object3D.ts:246

localRotation ​

• get localRotation(): Vector3

物体相对于父级的旋转属性

Returns ​

Vector3

Inherited from ​

Object3D.localRotation

Defined in ​

src/engine/core/entities/Object3D.ts:253

• set localRotation(value): void

设置物体相对于父级的旋转属性

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localRotation

Defined in ​

src/engine/core/entities/Object3D.ts:260

localScale ​

• get localScale(): Vector3

物体相对于父级的缩放属性

Returns ​

Vector3

Inherited from ​

Object3D.localScale

Defined in ​

src/engine/core/entities/Object3D.ts:267

• set localScale(value): void

设置物体相对于父级的缩放属性

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localScale

Defined in ​

src/engine/core/entities/Object3D.ts:274

localQuaternion ​

• get localQuaternion(): Quaternion

物体相对于父级变换属性，以四元数形式存储

Returns ​

Quaternion

Inherited from ​

Object3D.localQuaternion

Defined in ​

src/engine/core/entities/Object3D.ts:281

• set localQuaternion(value): void

设置物体相对于父级变换属性，以四元数形式存储

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localQuaternion

Defined in ​

src/engine/core/entities/Object3D.ts:288

parent ​

• get parent(): Transform

对象父容器的Transform组件

Returns ​

Transform

Inherited from ​

Object3D.parent

Defined in ​

src/engine/core/entities/Object3D.ts:303

parentObject ​

• get parentObject(): Object3D

该对象的父级对象

Returns ​

Object3D

Inherited from ​

Object3D.parentObject

Defined in ​

src/engine/core/entities/Object3D.ts:311

x ​

• get x(): number

相对于父容器的局部坐标的x坐标。

Returns ​

number

Inherited from ​

Object3D.x

Defined in ​

src/engine/core/entities/Object3D.ts:327

• set x(value): void

设置相对于父容器的局部坐标的x坐标。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.x

Defined in ​

src/engine/core/entities/Object3D.ts:319

y ​

• get y(): number

相对于父容器的局部坐标的y坐标。

Returns ​

number

Inherited from ​

Object3D.y

Defined in ​

src/engine/core/entities/Object3D.ts:342

• set y(value): void

设置相对于父容器的局部坐标的y坐标。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.y

Defined in ​

src/engine/core/entities/Object3D.ts:334

z ​

• get z(): number

相对于父容器的局部坐标的z坐标。

Returns ​

number

Inherited from ​

Object3D.z

Defined in ​

src/engine/core/entities/Object3D.ts:357

• set z(value): void

设置相对于父容器的局部坐标的z坐标。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.z

Defined in ​

src/engine/core/entities/Object3D.ts:349

scaleX ​

• get scaleX(): number

沿x轴相对于局部坐标的比例。

Returns ​

number

Inherited from ​

Object3D.scaleX

Defined in ​

src/engine/core/entities/Object3D.ts:372

• set scaleX(value): void

设置沿x轴相对于局部坐标的比例。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.scaleX

Defined in ​

src/engine/core/entities/Object3D.ts:364

scaleY ​

• get scaleY(): number

沿y轴相对于局部坐标的比例。

Returns ​

number

Inherited from ​

Object3D.scaleY

Defined in ​

src/engine/core/entities/Object3D.ts:388

• set scaleY(value): void

设置沿y轴相对于局部坐标的比例。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.scaleY

Defined in ​

src/engine/core/entities/Object3D.ts:380

scaleZ ​

• get scaleZ(): number

沿z轴相对于局部坐标的比例。

Returns ​

number

Inherited from ​

Object3D.scaleZ

Defined in ​

src/engine/core/entities/Object3D.ts:404

• set scaleZ(value): void

设置沿z轴相对于局部坐标的比例。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.scaleZ

Defined in ​

src/engine/core/entities/Object3D.ts:396

rotationX ​

• get rotationX(): number

绕X轴旋转的角度。

Returns ​

number

Inherited from ​

Object3D.rotationX

Defined in ​

src/engine/core/entities/Object3D.ts:420

• set rotationX(value): void

设置绕X轴旋转的角度。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.rotationX

Defined in ​

src/engine/core/entities/Object3D.ts:412

rotationY ​

• get rotationY(): number

绕Y轴旋转的角度。

Returns ​

number

Inherited from ​

Object3D.rotationY

Defined in ​

src/engine/core/entities/Object3D.ts:436

• set rotationY(value): void

设置绕Y轴旋转的角度。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.rotationY

Defined in ​

src/engine/core/entities/Object3D.ts:428

rotationZ ​

• get rotationZ(): number

绕Z轴旋转的角度。

Returns ​

number

Inherited from ​

Object3D.rotationZ

Defined in ​

src/engine/core/entities/Object3D.ts:452

• set rotationZ(value): void

设置绕Z轴旋转的角度。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.rotationZ

Defined in ​

src/engine/core/entities/Object3D.ts:444

quadMaxCount ​

• get quadMaxCount(): number

Returns ​

number

Defined in ​

src/engine/gui/core/GUIMesh.ts:23

Methods ​

getObjectByName ​

▸ getObjectByName(name): Entity

从对象本身开始搜索对象及其子对象，并返回第一个具有匹配名称的子对象。 对于大多数对象，默认情况下名称为空字符串。您必须手动设置才能使用此方法。

Parameters ​

Returns ​

Entity

子对象

Inherited from ​

Object3D.getObjectByName

Defined in ​

src/engine/core/entities/Entity.ts:95

addChild ​

▸ addChild(child): Entity

将对象添加为此对象的子对象。可以添加任意数量的对象。 传递到此处的对象上的任何当前父对象都将被删除，因为一个对象最多只能有一个父对象。

Parameters ​

Returns ​

Entity

Inherited from ​

Object3D.addChild

Defined in ​

src/engine/core/entities/Entity.ts:213

removeChild ​

▸ removeChild(child): any

移除对象的子对象。可以移除任意数量的对象。

Parameters ​

Returns ​

any

Inherited from ​

Object3D.removeChild

Defined in ​

src/engine/core/entities/Entity.ts:234

removeAllChild ​

▸ removeAllChild(): void

移除当前对象的所有子对象

Returns ​

void

Inherited from ​

Object3D.removeAllChild

Defined in ​

src/engine/core/entities/Entity.ts:249

removeChildByIndex ​

▸ removeChildByIndex(index): void

搜索对象子级，移除带有匹配索引的子对象。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeChildByIndex

Defined in ​

src/engine/core/entities/Entity.ts:261

hasChild ​

▸ hasChild(child): boolean

当前对象的子对象中是否包含某一对象

Parameters ​

Returns ​

boolean

是否包含该对象

Inherited from ​

Object3D.hasChild

Defined in ​

src/engine/core/entities/Entity.ts:275

removeFromParent ​

▸ removeFromParent(): GUIMesh

将此对象从其当前父对象中删除。

Returns ​

GUIMesh

当前对象

Inherited from ​

Object3D.removeFromParent

Defined in ​

src/engine/core/entities/Entity.ts:285

getChildByIndex ​

▸ getChildByIndex(index): Entity

搜索对象子级，返回第一个带有匹配索引的子对象。

Parameters ​

Returns ​

Entity

子对象

Inherited from ​

Object3D.getChildByIndex

Defined in ​

src/engine/core/entities/Entity.ts:299

getChildByName ​

▸ getChildByName(name, loopChild?): any

搜索对象子级，返回一个带有匹配名称的子对象。

Parameters ​

Returns ​

any

子对象

Inherited from ​

Object3D.getChildByName

Defined in ​

src/engine/core/entities/Entity.ts:314

genBounds ​

▸ genBounds(): IBound

返回一个矩形，该矩形定义指定层的显示区域。

Returns ​

IBound

Inherited from ​

Object3D.genBounds

Defined in ​

src/engine/core/entities/Entity.ts:406

forChild ​

▸ forChild(call): void

从对象本身开始遍历所有子对象。如果子对象中还有子对象，则递归遍历。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.forChild

Defined in ​

src/engine/core/entities/Object3D.ts:39

addComponent ​

▸ addComponent<T>(c, param?): T

创建新组件并将其添加到对象中，并返回组件的实例。 如果已经存在该类型的组件，则不会添加，并返回null。

Type parameters ​

Parameters ​

Returns ​

T

添加的组件

Inherited from ​

Object3D.addComponent

Defined in ​

src/engine/core/entities/Object3D.ts:52

getOrAddComponent ​

▸ getOrAddComponent<T>(c): T

返回指定类型的组件对象实例，如果没有该类型的组件则创建新组件并将其添加到对象中。

Type parameters ​

Parameters ​

Returns ​

T

组件实例

Inherited from ​

Object3D.getOrAddComponent

Defined in ​

src/engine/core/entities/Object3D.ts:71

removeComponent ​

▸ removeComponent<T>(c): void

移除指定类型的组件

Type parameters ​

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeComponent

Defined in ​

src/engine/core/entities/Object3D.ts:84

hasComponent ​

▸ hasComponent<T>(c): boolean

是否有指定类型的组件

Type parameters ​

Parameters ​

Returns ​

boolean

返回true存在该类型的组件，返回false不存在该类型的组件

Inherited from ​

Object3D.hasComponent

Defined in ​

src/engine/core/entities/Object3D.ts:98

getComponent ​

▸ getComponent<T>(c): T

返回指定类型的组件对象。

Type parameters ​

Parameters ​

Returns ​

T

指定类型的组件对象

Inherited from ​

Object3D.getComponent

Defined in ​

src/engine/core/entities/Object3D.ts:108

getComponentFromParent ​

▸ getComponentFromParent<T>(c): T

从父节点返回指定类型的组件对象，如果没有该类型的组件则调用父对象的父对象查找

Type parameters ​

Parameters ​

Returns ​

T

指定类型的组件对象

Inherited from ​

Object3D.getComponentFromParent

Defined in ​

src/engine/core/entities/Object3D.ts:118

getComponentsInChild ​

▸ getComponentsInChild<T>(c): T[]

返回指定类型的组件对象数组，如果没有该类型的组件则在自身子类对象列表中查找

Type parameters ​

Parameters ​

Returns ​

T[]

指定类型的组件对象

Inherited from ​

Object3D.getComponentsInChild

Defined in ​

src/engine/core/entities/Object3D.ts:137

getComponents ​

▸ getComponents<T>(c, outList?, includeInactive?): T[]

返回当前对象和子对象包含的所有的指定类型的组件，如果子对象还有子对象，则递归查找。

Type parameters ​

Parameters ​

Returns ​

T[]

Inherited from ​

Object3D.getComponents

Defined in ​

src/engine/core/entities/Object3D.ts:159

getComponentsExt ​

▸ getComponentsExt<T>(c, ret?, includeInactive?): T[]

快速获取组件，在某节点获取到了之后，不再访问子节点

Memberof

ELPObject3D

Type parameters ​

Parameters ​

Returns ​

T[]

Inherited from ​

Object3D.getComponentsExt

Defined in ​

src/engine/core/entities/Object3D.ts:185

clone ​

▸ clone(): Object3D

克隆自身

Returns ​

Object3D

Inherited from ​

Object3D.clone

Defined in ​

src/engine/core/entities/Object3D.ts:207

notifyChange ​

▸ notifyChange(): void

通知变换属性更新

Returns ​

void

Inherited from ​

Object3D.notifyChange

Defined in ​

src/engine/core/entities/Object3D.ts:295

getWorldPosition ​

▸ getWorldPosition(target?): Vector3

Parameters ​

Returns ​

Vector3

Inherited from ​

Object3D.getWorldPosition

Defined in ​

src/engine/core/entities/Object3D.ts:468

traverse ​

▸ traverse(callback): void

递归子节点

Parameters ​

Returns ​

void

Inherited from ​

Object3D.traverse

Defined in ​

src/engine/core/entities/Object3D.ts:480

destroy ​

▸ destroy(): void

Returns ​

void

Inherited from ​

Object3D.destroy

Defined in ​

src/engine/core/entities/Object3D.ts:491

serialization ​

▸ serialization(assets): SerializeObject3D

Parameters ​

Returns ​

SerializeObject3D

Inherited from ​

Object3D.serialization

Defined in ​

src/engine/core/entities/Object3D.ts:495

unSerialize ​

▸ unSerialize(nodeData, data): void

Parameters ​

Returns ​

void

Inherited from ​

Object3D.unSerialize

Defined in ​

src/engine/core/entities/Object3D.ts:516

showDebugAxis ​

▸ showDebugAxis(show): void

Parameters ​

Returns ​

void

Inherited from ​

Object3D.showDebugAxis

Defined in ​

src/engine/core/entities/Object3D.ts:523

dispatchEvent ​

▸ dispatchEvent(event): void

派发一个 Event3D 事件到所有注册了特定类型侦听器的对象中。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.dispatchEvent

Defined in ​

src/engine/event/CEventDispatcher.ts:22

addEventListener ​

▸ addEventListener(type, callback, thisObject, param?, priority?): number

使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。可以为特定类型的事件和优先级注册事件侦听器。成功注册一个事件侦听器后，无法通过额外调用 addCEventListener() 来更改其优先级。要更改侦听器的优先级，必须首先调用 removeCEventListener()。然后，可以使用新的优先级再次注册该侦听器。

Parameters ​

Returns ​

number

注册事件位置标识id

Inherited from ​

Object3D.addEventListener

Defined in ​

src/engine/event/CEventDispatcher.ts:77

removeEventListener ​

▸ removeEventListener(type, callback, thisObject): void

移除事件侦听器。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeEventListener

Defined in ​

src/engine/event/CEventDispatcher.ts:111

removeEventListenerAt ​

▸ removeEventListenerAt(id): void

移除事件侦听器。

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeEventListenerAt

Defined in ​

src/engine/event/CEventDispatcher.ts:130

removeAllEventListener ​

▸ removeAllEventListener(eventType?): void

移除指定类型的事件侦听器。 eventType 不指定类型 则移除所有的事件

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeAllEventListener

Defined in ​

src/engine/event/CEventDispatcher.ts:149

containEventListener ​

▸ containEventListener(type): boolean

检测是否存在监听器。

Parameters ​

Returns ​

boolean

是否存在该类型监视器，true为存在，反之不存在。

Inherited from ​

Object3D.containEventListener

Defined in ​

src/engine/event/CEventDispatcher.ts:181

hasEventListener ​

▸ hasEventListener(type, callback?, thisObject?): boolean

检测是否存在监听器。

Parameters ​

Returns ​

boolean

是否存在该事件，true为存在，反之不存在。

Inherited from ​

Object3D.hasEventListener

Defined in ​

src/engine/event/CEventDispatcher.ts:194

setTextures ​

▸ setTextures(textures): void

Parameters ​

Returns ​

void

Defined in ​

src/engine/gui/core/GUIMesh.ts:42

sortIndex ​

▸ sortIndex(z): void

Parameters ​

Returns ​

void

Defined in ​

src/engine/gui/core/GUIMesh.ts:46

updateGUIData ​

▸ updateGUIData(screenWidth, screenHeight, camera): void

Parameters ​

Returns ​

void

Defined in ​

src/engine/gui/core/GUIMesh.ts:50

Constructors ​

constructor ​

• new GUIMesh(space)

Parameters ​

Overrides ​

Object3D.constructor

Defined in ​

src/engine/gui/core/GUIMesh.ts:16