Class: Entity ​

The entity class provides an abstract base class for all scene objects that are considered to have "existence" in the scene, which can be considered as actual objects with positions and sizes. Entity class is an abstract class and cannot be instantiated. If you want to instantiate it, please use the Object 3D class.

Hierarchy ​

• CEventDispatcher

  ↳ Entity

  ↳↳ Object3D

Constructors ​

• constructor

Properties ​

• name
• transform
• renderNode
• entityChildren
• components

Accessors ​

• instanceID
• numChildren
• bound

Methods ​

• getObjectByName
• addChild
• removeChild
• removeAllChild
• removeSelf
• removeChildByIndex
• hasChild
• removeFromParent
• getChildByIndex
• getChildByName
• destroy
• dispatchEvent
• addEventListener
• removeEventListener
• removeEventListenerAt
• removeAllEventListener
• containEventListener
• hasEventListener

Constructors ​

constructor ​

• new Entity()

Overrides ​

CEventDispatcher.constructor

Defined in ​

src/core/entities/Entity.ts:104

Properties ​

name ​

• name: string = ''

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

Defined in ​

src/core/entities/Entity.ts:24

transform ​

• transform: Transform

The Transform attached to this object.

Defined in ​

src/core/entities/Entity.ts:42

renderNode ​

• renderNode: RenderNode

Renderer components

Defined in ​

src/core/entities/Entity.ts:47

entityChildren ​

• entityChildren: Entity[]

An array containing sub objects of an object

Defined in ​

src/core/entities/Entity.ts:52

components ​

• components: Map<any, IComponent>

List of components attached to an object

Defined in ​

src/core/entities/Entity.ts:57

Accessors ​

instanceID ​

• get instanceID(): string

The unique identifier of the object.

Returns ​

string

Defined in ​

src/core/entities/Entity.ts:32

numChildren ​

• get numChildren(): number

Returns the number of child objects of an object

Returns ​

number

Defined in ​

src/core/entities/Entity.ts:116

bound ​

• get bound(): IBound

Returns ​

IBound

Defined in ​

src/core/entities/Entity.ts:275

• set bound(value): void

Parameters ​

Returns ​

void

Defined in ​

src/core/entities/Entity.ts:280

Methods ​

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

Defined in ​

src/core/entities/Entity.ts:81

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

Defined in ​

src/core/entities/Entity.ts:127

removeChild ​

▸ removeChild(child): any

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

Parameters ​

Returns ​

any

Defined in ​

src/core/entities/Entity.ts:151

removeAllChild ​

▸ removeAllChild(): void

Remove all children of the current object

Returns ​

void

Defined in ​

src/core/entities/Entity.ts:166

removeSelf ​

▸ removeSelf(): Entity

Remove the current node from the parent

Returns ​

Entity

this

Defined in ​

src/core/entities/Entity.ts:177

removeChildByIndex ​

▸ removeChildByIndex(index): void

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

Parameters ​

Returns ​

void

Defined in ​

src/core/entities/Entity.ts:187

hasChild ​

▸ hasChild(child): boolean

Does the current object contain a certain object

Parameters ​

Returns ​

boolean

boolean

Defined in ​

src/core/entities/Entity.ts:201

removeFromParent ​

▸ removeFromParent(): Entity

Remove the current node from the parent

Returns ​

Entity

this

Defined in ​

src/core/entities/Entity.ts:211

getChildByIndex ​

▸ getChildByIndex(index): Entity

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

Parameters ​

Returns ​

Entity

child entity

Defined in ​

src/core/entities/Entity.ts:225

getChildByName ​

▸ getChildByName(name, loopChild?): any

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

Parameters ​

Returns ​

any

result

Defined in ​

src/core/entities/Entity.ts:240

destroy ​

▸ destroy(force?): void

release current object

Parameters ​

Returns ​

void

Overrides ​

CEventDispatcher.destroy

Defined in ​

src/core/entities/Entity.ts:332

dispatchEvent ​

▸ dispatchEvent(event): void

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

Parameters ​

Returns ​

void

Inherited from ​

CEventDispatcher.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 ​

CEventDispatcher.addEventListener

Defined in ​

src/event/CEventDispatcher.ts:79

removeEventListener ​

▸ removeEventListener(type, callback, thisObject): void

Remove Event Listening

Parameters ​

Returns ​

void

Inherited from ​

CEventDispatcher.removeEventListener

Defined in ​

src/event/CEventDispatcher.ts:113

removeEventListenerAt ​

▸ removeEventListenerAt(id): boolean

Remove an event Listening with id

Parameters ​

Returns ​

boolean

Inherited from ​

CEventDispatcher.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 ​

CEventDispatcher.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 ​

CEventDispatcher.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 ​

CEventDispatcher.hasEventListener

Defined in ​

src/event/CEventDispatcher.ts:198