Skip to content
本页内容

Class: Entity

实体类为所有被视为在场景中具有“存在”的场景对象提供了一个抽象基类,它可以被视为具有位置和大小的实际对象。 实体类是一个抽象类,不能被实例化,如果要实例化,请使用Object3D类。

Hierarchy

Properties

Accessors

Methods

Constructors

Properties

name

name: string = ''

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

Defined in

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


transform

transform: Transform

附加到此对象的Transform。

Defined in

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


renderNode

renderNode: RenderNode

渲染器组件

Defined in

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


entityChildren

entityChildren: Entity[]

包含对象子对象的数组

Defined in

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


components

components: Map<any, ComponentBase>

对象所附加的组件列表

Defined in

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


bound

bound: IBound

对象的的包围体

Defined in

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

Accessors

uuid

get uuid(): string

该对象的唯一标识符。

Returns

string

Defined in

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


renderLayer

get renderLayer(): RenderLayer

Returns

RenderLayer

Defined in

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

set renderLayer(value): void

Parameters

NameType
valueRenderLayer

Returns

void

Defined in

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


visible

get visible(): boolean

对象是否可见

Returns

boolean

Defined in

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

set visible(value): void

设置对象是否可见

Parameters

NameType
valueboolean

Returns

void

Defined in

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


numChildren

get numChildren(): number

返回对象子对象的数量

Returns

number

Defined in

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

Methods

getObjectByName

getObjectByName(name): Entity

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

Parameters

NameTypeDescription
namestring对象名称

Returns

Entity

子对象

Defined in

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


addChild

addChild(child): Entity

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

Parameters

NameTypeDescription
childEntity待添加的对象

Returns

Entity

Defined in

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


removeChild

removeChild(child): any

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

Parameters

NameTypeDescription
childEntity移除的对象

Returns

any

Defined in

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


removeAllChild

removeAllChild(): void

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

Returns

void

Defined in

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


removeChildByIndex

removeChildByIndex(index): void

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

Parameters

NameTypeDescription
indexnumber标识该对象实例的索引

Returns

void

Defined in

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


hasChild

hasChild(child): boolean

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

Parameters

NameTypeDescription
childEntity指定对象

Returns

boolean

是否包含该对象

Defined in

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


removeFromParent

removeFromParent(): Entity

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

Returns

Entity

当前对象

Defined in

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


getChildByIndex

getChildByIndex(index): Entity

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

Parameters

NameTypeDescription
indexnumber标识该对象实例的索引

Returns

Entity

子对象

Defined in

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


getChildByName

getChildByName(name, loopChild?): any

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

Parameters

NameTypeDefault valueDescription
namestringundefined对象名称
loopChildbooleantrue是否遍历子对象的子级。默认值为true

Returns

any

子对象

Defined in

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


genBounds

genBounds(): IBound

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

Returns

IBound

Defined in

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


dispatchEvent

dispatchEvent(event): void

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

Parameters

NameType
eventCEvent

Returns

void

Inherited from

CEventDispatcher.dispatchEvent

Defined in

src/engine/event/CEventDispatcher.ts:22


addEventListener

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

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

Parameters

NameTypeDefault valueDescription
typestring | numberundefined{string} 事件的类型标识符。
callbackFunctionundefined{Function} 处理事件的侦听器函数。此函数必须接受 Event3D 对象作为其唯一的参数,并且不能返回任何结果, 如下面的示例所示: function(evt:Event3D):void 函数可以有任何名称。
thisObjectanyundefined{any} 当前注册对象。
paramanynull{any} 事件携带参数,默认为空。
prioritynumber0{number} 事件侦听器的优先级。优先级由一个带符号的 32 位整数指定。数字越大,优先级越高。优先级为 n 的所有侦听器会在 优先级为 n -1 的侦听器之前得到处理。如果两个或更多个侦听器共享相同的优先级,则按照它们的添加顺序进行处理。默认优先级为 0。

Returns

number

注册事件位置标识id

Inherited from

CEventDispatcher.addEventListener

Defined in

src/engine/event/CEventDispatcher.ts:77


removeEventListener

removeEventListener(type, callback, thisObject): void

移除事件侦听器。

Parameters

NameTypeDescription
typestring | number{string} 事件名。
callbackFunction{Function} 侦听函数。
thisObjectany{any} 当前注册对象。

Returns

void

Inherited from

CEventDispatcher.removeEventListener

Defined in

src/engine/event/CEventDispatcher.ts:111


removeEventListenerAt

removeEventListenerAt(id): void

移除事件侦听器。

Parameters

NameTypeDescription
idnumber事件id,调用addCEventListener的返回值即为事件id.

Returns

void

Inherited from

CEventDispatcher.removeEventListenerAt

Defined in

src/engine/event/CEventDispatcher.ts:130


removeAllEventListener

removeAllEventListener(eventType?): void

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

Parameters

NameTypeDefault value
eventTypestring | numbernull

Returns

void

Inherited from

CEventDispatcher.removeAllEventListener

Defined in

src/engine/event/CEventDispatcher.ts:149


containEventListener

containEventListener(type): boolean

检测是否存在监听器。

Parameters

NameTypeDescription
typestring{string} 事件类型标识符

Returns

boolean

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

Inherited from

CEventDispatcher.containEventListener

Defined in

src/engine/event/CEventDispatcher.ts:181


hasEventListener

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

检测是否存在监听器。

Parameters

NameTypeDefault valueDescription
typestring | numberundefined{string} 事件名
callbackFunctionnull{Function} 处理事件的侦听器函数
thisObjectanynull{any} 注册对象。

Returns

boolean

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

Inherited from

CEventDispatcher.hasEventListener

Defined in

src/engine/event/CEventDispatcher.ts:194

Constructors

constructor

new Entity()

创建一个新的实体类对象

Overrides

CEventDispatcher.constructor

Defined in

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