xr-frame / Exports / Element

# Class: Element

元素，系统核心之一。

本质上就是对应于xml中标签，所有的标签的实现都是继承自Element的，其一般不包含逻辑，仅仅是通过defaultComponents和dataMapping定义组件的集合与映射。 自定义元素最后使用{#@link registerElement}。

# Hierarchy

• Element

  ↳ Scene

  ↳ XRNode

  ↳ XRShadow

  ↳ XRCamera

  ↳ XRMesh

  ↳ XRLight

  ↳ XRMaterial

  ↳ XRAssetRenderTexture

  ↳ XRAssetLoad

  ↳ XRAssets

  ↳ XREnv

  ↳ XRARTracker

  ↳ XRText

  ↳ XRParticle

  ↳ XRAssetPostProcess

# Table of contents

# Constructors

• constructor

# Properties

• dataMapping
• defaultComponents
• TYPE

# Accessors

• event
• id
• inXML
• name
• parent
• scene

# Methods

• addChild
• addComponent
• dfs
• getChildAtIndex
• getChildByClass
• getChildByFilter
• getChildByName
• getChildrenByFilter
• getChildrenByName
• getComponent
• release
• removeChild
• removeComponent
• setAttribute
• setId

# Constructors

# constructor

• new Element(_type, triggerEvent)

# Parameters

# Properties

# dataMapping

• Readonly dataMapping: Object

Element的数据映射。它是为了给组件的属性提供一个方便的用法，比如：

{
  position: [transform, position]
}

就是将xml中写在这个Element的position直接映射到了transform组件的position属性上。

通常来讲，所有的驼峰如nodeId都会被映射为小写加中划线node-id。

# Index signature

▪ [key: string]: string[]

# defaultComponents

• Readonly defaultComponents: IEntityComponents

Element的默认组件集合，详见IEntityComponents。

# TYPE

▪ Static TYPE: string = 'element'

# Accessors

# event

• get event(): EventManager

事件管理器。

# Returns

EventManager

# id

• get id(): string

写在xml上的那个id，要求唯一。

# Returns

string

# inXML

• get inXML(): boolean

元素是否在xml中，若是xr-shadow下的节点，则为false。

# Returns

boolean

# name

• get name(): string

名字，写在xml上的那个name，不唯一。

# Returns

string

• set name(value): void

名字，写在xml上的那个name，不唯一。

# Parameters

# Returns

void

# parent

• get parent(): Element

父元素。

# Returns

Element

# scene

• get scene(): Scene

场景实例。

# Returns

Scene

# Methods

# addChild

▸ addChild(child): void

手动添加一个子节点，注意需要保证当前节点是xr-shadow或其子节点。

# Parameters

# Returns

void

# addComponent

▸ addComponent<T>(clz, options?): T

手动添加一个Component。

# Type parameters

# Parameters

# Returns

T

# dfs

▸ dfs<T>(callback, defaultParams?, excludeRoot?, stop?): void

递归遍历元素的所有子孙节点。

# Type parameters

# Parameters

# Returns

void

# getChildAtIndex

▸ getChildAtIndex<T>(index): T

获取第index个子元素。

# Type parameters

# Parameters

# Returns

T

# getChildByClass

▸ getChildByClass<T>(clz): T

通过元素的类获取子元素。

# Type parameters

# Parameters

# Returns

T

# getChildByFilter

▸ getChildByFilter<T>(filter): T

通过filter获取子元素。

# Type parameters

# Parameters

# Returns

T

# getChildByName

▸ getChildByName<T>(name): T

通过元素的名字name获取子元素。

# Type parameters

# Parameters

# Returns

T

# getChildrenByFilter

▸ getChildrenByFilter(filter): Element[]

通过filter获取子元素列表。

# Parameters

# Returns

Element[]

# getChildrenByName

▸ getChildrenByName(name): Element[]

通过元素的名字name获取子元素们。

# Parameters

# Returns

Element[]

# getComponent

▸ getComponent<T>(clzName): T

获取一个Component，可以使用类或者名字获取。

# Type parameters

# Parameters

# Returns

T

▸ getComponent<T>(clz): T

# Type parameters

# Parameters

# Returns

T

# release

▸ release(): void

仅限自己创建的节点使用，否则后果自负。

# Returns

void

# removeChild

▸ removeChild(child): void

手动移除一个子节点，注意需要保证当前节点是xr-shadow或其子节点。 只调用removeChild没有办法走进子节点的onRelease里，需要手动调用子节点的release才行。

# Parameters

# Returns

void

# removeComponent

▸ removeComponent(clz): void

手动移除一个Component，注意保证其不在xml上。

# Parameters

# Returns

void

# setAttribute

▸ setAttribute(name, value): void

设置一个属性，对应于xml标签中的那些属性，值为字符串。 一般建议使用component的setData方法！！！

# Parameters

# Returns

void

# setId

▸ setId(id): void

仅限自己创建的节点使用，否则后果自负。

# Parameters

# Returns

void