Class: GUIMesh ​

A object3D for GUI, holding material/geometry/renderer

Hierarchy ​

• Object3D

  ↳ GUIMesh

Constructors ​

• constructor

Properties ​

• uiRenderer
• geometry
• space
• limitVertexCount
• name
• transform
• renderNode
• entityChildren
• components
• prefabRef

Accessors ​

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

Methods ​

• updateBound
• updateGUIData
• getObjectByName
• addChild
• removeChild
• removeAllChild
• removeSelf
• removeChildByIndex
• hasChild
• removeFromParent
• getChildByIndex
• getChildByName
• forChild
• addComponent
• getOrAddComponent
• removeComponent
• hasComponent
• getComponent
• getComponentFromParent
• getComponentsInChild
• getComponents
• getComponentsExt
• getComponentsByProperty
• clone
• notifyChange
• traverse
• destroy
• dispatchEvent
• addEventListener
• removeEventListener
• removeEventListenerAt
• removeAllEventListener
• containEventListener
• hasEventListener

Constructors ​

constructor ​

• new GUIMesh(space, param?)

Parameters ​

Overrides ​

Object3D.constructor

Defined in ​

src/components/gui/core/GUIMesh.ts:26

Properties ​

uiRenderer ​

• uiRenderer: GUIRenderer

Defined in ​

src/components/gui/core/GUIMesh.ts:17

geometry ​

• geometry: GUIGeometry

Defined in ​

src/components/gui/core/GUIMesh.ts:18

space ​

• Readonly space: GUISpace

Defined in ​

src/components/gui/core/GUIMesh.ts:19

limitVertexCount ​

• limitVertexCount: number = 0

Defined in ​

src/components/gui/core/GUIMesh.ts:21

name ​

• name: string = ''

The name of the object. The default value is an empty string.

Inherited from ​

Object3D.name

Defined in ​

src/core/entities/Entity.ts:25

transform ​

• transform: Transform

The Transform attached to this object.

Inherited from ​

Object3D.transform

Defined in ​

src/core/entities/Entity.ts:60

renderNode ​

• renderNode: RenderNode

Renderer components

Inherited from ​

Object3D.renderNode

Defined in ​

src/core/entities/Entity.ts:65

entityChildren ​

• entityChildren: Entity[]

An array containing sub objects of an object

Inherited from ​

Object3D.entityChildren

Defined in ​

src/core/entities/Entity.ts:70

components ​

• components: Map<any, IComponent>

List of components attached to an object

Inherited from ​

Object3D.components

Defined in ​

src/core/entities/Entity.ts:75

prefabRef ​

• Optional prefabRef: string

Inherited from ​

Object3D.prefabRef

Defined in ​

src/core/entities/Object3D.ts:14

Accessors ​

quadMaxCount ​

• get quadMaxCount(): number

Return How many Quads can a single GUIGeometry support at most

Returns ​

number

Defined in ​

src/components/gui/core/GUIMesh.ts:36

bound ​

• get bound(): IBound

Returns ​

IBound

Overrides ​

Object3D.bound

Defined in ​

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

• set bound(value): void

Parameters ​

Returns ​

void

Overrides ​

Object3D.bound

Defined in ​

src/components/gui/core/GUIMesh.ts:45

uuid ​

• get uuid(): string

The unique identifier of the object.

Returns ​

string

Inherited from ​

Object3D.uuid

Defined in ​

src/core/entities/Entity.ts:32

renderLayer ​

• get renderLayer(): RenderLayer

Returns ​

RenderLayer

Inherited from ​

Object3D.renderLayer

Defined in ​

src/core/entities/Entity.ts:44

• set renderLayer(value): void

Parameters ​

Returns ​

void

Inherited from ​

Object3D.renderLayer

Defined in ​

src/core/entities/Entity.ts:48

numChildren ​

• get numChildren(): number

Returns the number of child objects of an object

Returns ​

number

Inherited from ​

Object3D.numChildren

Defined in ​

src/core/entities/Entity.ts:130

isScene3D ​

• get isScene3D(): boolean

Returns ​

boolean

Inherited from ​

Object3D.isScene3D

Defined in ​

src/core/entities/Object3D.ts:24

localPosition ​

• get localPosition(): Vector3

Get the position of an object relative to its parent

Returns ​

Vector3

Inherited from ​

Object3D.localPosition

Defined in ​

src/core/entities/Object3D.ts:268

• set localPosition(value): void

Set the position of an object relative to its parent

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localPosition

Defined in ​

src/core/entities/Object3D.ts:275

localRotation ​

• get localRotation(): Vector3

Get the rotation attribute of an object relative to its parent

Returns ​

Vector3

Inherited from ​

Object3D.localRotation

Defined in ​

src/core/entities/Object3D.ts:282

• set localRotation(value): void

Set the rotation attribute of an object relative to its parent

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localRotation

Defined in ​

src/core/entities/Object3D.ts:289

localScale ​

• get localScale(): Vector3

Get the scaling attribute of an object relative to its parent

Returns ​

Vector3

Inherited from ​

Object3D.localScale

Defined in ​

src/core/entities/Object3D.ts:296

• set localScale(value): void

Set the scaling attribute of an object relative to its parent

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localScale

Defined in ​

src/core/entities/Object3D.ts:303

localQuaternion ​

• get localQuaternion(): Quaternion

Get the rotation attribute of an object relative to its parent, which is a quaternion

Returns ​

Quaternion

Inherited from ​

Object3D.localQuaternion

Defined in ​

src/core/entities/Object3D.ts:310

• set localQuaternion(value): void

Set the rotation attribute of an object relative to its parent, which is a quaternion

Parameters ​

Returns ​

void

Inherited from ​

Object3D.localQuaternion

Defined in ​

src/core/entities/Object3D.ts:317

parent ​

• get parent(): Transform

Transform component of object parent

Returns ​

Transform

Inherited from ​

Object3D.parent

Defined in ​

src/core/entities/Object3D.ts:332

parentObject ​

• get parentObject(): Object3D

parent object3D

Returns ​

Object3D

Inherited from ​

Object3D.parentObject

Defined in ​

src/core/entities/Object3D.ts:340

x ​

• get x(): number

Get the x coordinate relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.x

Defined in ​

src/core/entities/Object3D.ts:356

• set x(value): void

Set the x coordinate relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.x

Defined in ​

src/core/entities/Object3D.ts:348

y ​

• get y(): number

Get the y coordinate relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.y

Defined in ​

src/core/entities/Object3D.ts:371

• set y(value): void

Set the y coordinate relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.y

Defined in ​

src/core/entities/Object3D.ts:363

z ​

• get z(): number

Get the z coordinate relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.z

Defined in ​

src/core/entities/Object3D.ts:385

• set z(value): void

Set the z coordinate relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.z

Defined in ​

src/core/entities/Object3D.ts:378

scaleX ​

• get scaleX(): number

Get the x scale relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.scaleX

Defined in ​

src/core/entities/Object3D.ts:400

• set scaleX(value): void

Set the x scale relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.scaleX

Defined in ​

src/core/entities/Object3D.ts:392

scaleY ​

• get scaleY(): number

Get the y scale relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.scaleY

Defined in ​

src/core/entities/Object3D.ts:416

• set scaleY(value): void

Set the y scale relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.scaleY

Defined in ​

src/core/entities/Object3D.ts:408

scaleZ ​

• get scaleZ(): number

Get the z scale relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.scaleZ

Defined in ​

src/core/entities/Object3D.ts:432

• set scaleZ(value): void

Set the z scale relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.scaleZ

Defined in ​

src/core/entities/Object3D.ts:424

rotationX ​

• get rotationX(): number

Get the x rotation relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.rotationX

Defined in ​

src/core/entities/Object3D.ts:448

• set rotationX(value): void

Set the x rotation relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.rotationX

Defined in ​

src/core/entities/Object3D.ts:440

rotationY ​

• get rotationY(): number

Get the y rotation relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.rotationY

Defined in ​

src/core/entities/Object3D.ts:464

• set rotationY(value): void

Set the y rotation relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.rotationY

Defined in ​

src/core/entities/Object3D.ts:456

rotationZ ​

• get rotationZ(): number

Set the z rotation relative to the local coordinates of the parent container.

Returns ​

number

Inherited from ​

Object3D.rotationZ

Defined in ​

src/core/entities/Object3D.ts:480

• set rotationZ(value): void

Set the z rotation relative to the local coordinates of the parent container.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.rotationZ

Defined in ​

src/core/entities/Object3D.ts:472

Methods ​

updateBound ​

▸ updateBound(): void

Returns ​

void

Overrides ​

Object3D.updateBound

Defined in ​

src/components/gui/core/GUIMesh.ts:40

updateGUIData ​

▸ updateGUIData(screenWidth, screenHeight, camera): void

Parameters ​

Returns ​

void

Defined in ​

src/components/gui/core/GUIMesh.ts:68

getObjectByName ​

▸ getObjectByName(name): Entity

Starting from the object itself, search for the object and its children, and return the first child object with a matching name. For most objects, the name is an empty string by default. You must manually set it to use this method.

Parameters ​

Returns ​

Entity

result Entity

Inherited from ​

Object3D.getObjectByName

Defined in ​

src/core/entities/Entity.ts:95

addChild ​

▸ addChild(child): Entity

Add an object as a child of this object. You can add any number of objects. Any current parent object on the object passed here will be deleted, as an object can only have at most one parent object.

Parameters ​

Returns ​

Entity

Inherited from ​

Object3D.addChild

Defined in ​

src/core/entities/Entity.ts:141

removeChild ​

▸ removeChild(child): any

Remove the child objects of the object. You can remove any number of objects.

Parameters ​

Returns ​

any

Inherited from ​

Object3D.removeChild

Defined in ​

src/core/entities/Entity.ts:167

removeAllChild ​

▸ removeAllChild(): void

Remove all children of the current object

Returns ​

void

Inherited from ​

Object3D.removeAllChild

Defined in ​

src/core/entities/Entity.ts:181

removeSelf ​

▸ removeSelf(): GUIMesh

Remove the current node from the parent

Returns ​

GUIMesh

this

Inherited from ​

Object3D.removeSelf

Defined in ​

src/core/entities/Entity.ts:192

removeChildByIndex ​

▸ removeChildByIndex(index): void

Search for child nodes of objects and remove child objects with matching indexes.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeChildByIndex

Defined in ​

src/core/entities/Entity.ts:202

hasChild ​

▸ hasChild(child): boolean

Does the current object contain a certain object

Parameters ​

Returns ​

boolean

boolean

Inherited from ​

Object3D.hasChild

Defined in ​

src/core/entities/Entity.ts:216

removeFromParent ​

▸ removeFromParent(): GUIMesh

Remove the current node from the parent

Returns ​

GUIMesh

this

Inherited from ​

Object3D.removeFromParent

Defined in ​

src/core/entities/Entity.ts:226

getChildByIndex ​

▸ getChildByIndex(index): Entity

Search for object children and return the first child object with a matching index.

Parameters ​

Returns ​

Entity

child entity

Inherited from ​

Object3D.getChildByIndex

Defined in ​

src/core/entities/Entity.ts:240

getChildByName ​

▸ getChildByName(name, loopChild?): any

Search for object children and return a child object with a matching name.

Parameters ​

Returns ​

any

result

Inherited from ​

Object3D.getChildByName

Defined in ​

src/core/entities/Entity.ts:255

forChild ​

▸ forChild(call): void

Traverse all sub objects starting from the object itself. If there are still sub objects in the sub object, recursively traverse.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.forChild

Defined in ​

src/core/entities/Object3D.ts:35

addComponent ​

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

Create a new component and add it to the object, and return an instance of the component. If a component of this type already exists, it will not be added and will return null.

Type parameters ​

Parameters ​

Returns ​

T

result component

Inherited from ​

Object3D.addComponent

Defined in ​

src/core/entities/Object3D.ts:49

getOrAddComponent ​

▸ getOrAddComponent<T>(c): T

Returns an instance of a component object of the specified type. If there are no components of that type, a new component is created and added to the object.

Type parameters ​

Parameters ​

Returns ​

T

result component

Inherited from ​

Object3D.getOrAddComponent

Defined in ​

src/core/entities/Object3D.ts:71

removeComponent ​

▸ removeComponent<T>(c): void

Remove components of the specified type

Type parameters ​

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeComponent

Defined in ​

src/core/entities/Object3D.ts:85

hasComponent ​

▸ hasComponent<T>(c): boolean

Is there a component of the specified type

Type parameters ​

Parameters ​

Returns ​

boolean

boolean

Inherited from ​

Object3D.hasComponent

Defined in ​

src/core/entities/Object3D.ts:101

getComponent ​

▸ getComponent<T>(c): T

Returns a component of the specified type.

Type parameters ​

Parameters ​

Returns ​

T

result component

Inherited from ​

Object3D.getComponent

Defined in ​

src/core/entities/Object3D.ts:112

getComponentFromParent ​

▸ getComponentFromParent<T>(c): T

Returns a component object of the specified type from the parent node. If there are no components of that type, calls the parent object lookup of the parent object

Type parameters ​

Parameters ​

Returns ​

T

reulst component

Inherited from ​

Object3D.getComponentFromParent

Defined in ​

src/core/entities/Object3D.ts:125

getComponentsInChild ​

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

Returns an array of component objects of the specified type. If there are no components of that type, search in the list of self body class objects

Type parameters ​

Parameters ​

Returns ​

T[]

result components

Inherited from ​

Object3D.getComponentsInChild

Defined in ​

src/core/entities/Object3D.ts:145

getComponents ​

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

Returns all components of the specified type contained in the current object and its children. If there are children in the child object, recursively search.

Type parameters ​

Parameters ​

Returns ​

T[]

Inherited from ​

Object3D.getComponents

Defined in ​

src/core/entities/Object3D.ts:169

getComponentsExt ​

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

Quickly obtain components and no longer access child nodes after obtaining them at a certain node

Memberof

Object3D

Type parameters ​

Parameters ​

Returns ​

T[]

{T}

Inherited from ​

Object3D.getComponentsExt

Defined in ​

src/core/entities/Object3D.ts:194

getComponentsByProperty ​

▸ getComponentsByProperty<T>(key, value, findedAndBreak?, ret?, includeInactive?): T[]

Type parameters ​

Parameters ​

Returns ​

T[]

Inherited from ​

Object3D.getComponentsByProperty

Defined in ​

src/core/entities/Object3D.ts:209

clone ​

▸ clone(): Object3D

clone a Object3D

Returns ​

Object3D

Inherited from ​

Object3D.clone

Defined in ​

src/core/entities/Object3D.ts:236

notifyChange ​

▸ notifyChange(): void

Notify transformation attribute updates

Returns ​

void

Inherited from ​

Object3D.notifyChange

Defined in ​

src/core/entities/Object3D.ts:324

traverse ​

▸ traverse(callback): void

Recursive child nodes and execute specified function

Parameters ​

Returns ​

void

Inherited from ​

Object3D.traverse

Defined in ​

src/core/entities/Object3D.ts:501

destroy ​

▸ destroy(force?): void

Release self

Parameters ​

Returns ​

void

Inherited from ​

Object3D.destroy

Defined in ​

src/core/entities/Object3D.ts:516

dispatchEvent ​

▸ dispatchEvent(event): void

Dispatch an event to all registered objects with a specific type of listener.

Parameters ​

Returns ​

void

Inherited from ​

Object3D.dispatchEvent

Defined in ​

src/event/CEventDispatcher.ts:24

addEventListener ​

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

register an event listener to event distancher.

Parameters ​

Returns ​

number

Returns register event id

Inherited from ​

Object3D.addEventListener

Defined in ​

src/event/CEventDispatcher.ts:79

removeEventListener ​

▸ removeEventListener(type, callback, thisObject): void

Remove Event Listening

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeEventListener

Defined in ​

src/event/CEventDispatcher.ts:113

removeEventListenerAt ​

▸ removeEventListenerAt(id): boolean

Remove an event Listening with id

Parameters ​

Returns ​

boolean

Inherited from ​

Object3D.removeEventListenerAt

Defined in ​

src/event/CEventDispatcher.ts:133

removeAllEventListener ​

▸ removeAllEventListener(eventType?): void

Specify a event type to remove all related event listeners eventType event type, set null to remove all event listeners

Parameters ​

Returns ​

void

Inherited from ​

Object3D.removeAllEventListener

Defined in ​

src/event/CEventDispatcher.ts:153

containEventListener ​

▸ containEventListener(type): boolean

whether the target presence of a listener with event type.

Parameters ​

Returns ​

boolean

Returns a boolean.

Inherited from ​

Object3D.containEventListener

Defined in ​

src/event/CEventDispatcher.ts:185

hasEventListener ​

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

whether the target presence of a listener with event type. it associate more registration parameters.

Parameters ​

Returns ​

boolean

Returns a boolean.

Inherited from ​

Object3D.hasEventListener

Defined in ​

src/event/CEventDispatcher.ts:198