xr-frame / Exports / Text

# Class: Text

# Hierarchy

Component<ITextData>

↳ Text

# Table of contents

# Constructors

constructor

# Events

# Properties

# Accessors

# Methods

# Constructors

# constructor

• new Text()

# Inherited from

Component.constructor

# Events

# onAdd

▸ onAdd(parent, data): void

所挂载的element被挂载到场景时触发的回调。

# Parameters

Name	Type
`parent`	`Element`
`data`	`ITextData`

# Returns

void

# Inherited from

Component.onAdd

# onRelease

▸ onRelease(data): void

从被挂载的element上被移除，或是element被销毁时，触发的回调。一般用于释放持有的资源。

# Parameters

Name	Type
`data`	`ITextData`

# Returns

void

# Inherited from

Component.onRelease

# onRemove

▸ onRemove(parent, data): void

所挂载的element从父节点parent被移除时，或者自己从element上被移除时，触发的回调。一般用于消除功能的运作。 如果一个组件的元素直接被销毁了，那这个组件就不会经历onRemove而是直接进入onRelease。

# Parameters

Name	Type
`parent`	`Element`
`data`	`ITextData`

# Returns

void

# Inherited from

Component.onRemove

# onTick

▸ onTick(deltaTime, data): void

渲染每帧触发的回调。

# Parameters

Name	Type
`deltaTime`	`number`
`data`	`ITextData`

# Returns

void

# Inherited from

Component.onTick

# onUpdate

▸ onUpdate(data, preData): void

数据更新时触发的回调。

# Parameters

Name	Type
`data`	`ITextData`
`preData`	`ITextData`

# Returns

void

# Inherited from

Component.onUpdate

# Properties

# priority

• Readonly priority: number = 300

自定义组件的更新优先级。

# Overrides

Component.priority

# schema

• Readonly schema: IComponentSchema

自定义组件的schema。

# Overrides

Component.schema

# EVENTS

▪ Static EVENTS: string[] = []

# Inherited from

Component.EVENTS

# FillRenderData

▪ Static FillRenderData: (vertexF32: Float32Array, indexU16: Uint16Array, batchArray: ICharacterData[]) => void

# Type declaration

▸ (vertexF32, indexU16, batchArray): void

# Parameters

Name	Type
`vertexF32`	`Float32Array`
`indexU16`	`Uint16Array`
`batchArray`	`ICharacterData`[]

# Returns

void

# QueryGlyphs

▪ Static QueryGlyphs: (scene: Scene, characters: string, italic: boolean, bold: boolean, fontSize: number, fontFamily: string) => IGlyph[]

# Type declaration

▸ (scene, characters, italic, bold, fontSize, fontFamily): IGlyph[]

多字客户端纹理请求接口

# Parameters

Name	Type
`scene`	`Scene`
`characters`	`string`
`italic`	`boolean`
`bold`	`boolean`
`fontSize`	`number`
`fontFamily`	`string`

# Returns

IGlyph[]

# Typesetting

▪ Static Typesetting: (glyphs: IGlyph[], batchArrays: ICharacterData[][], batchIndexs: number[], wrapWidth: number, wrapHeight: number, lineHeight: number, anchor: number[], padding: number[], vertAlign: EVertAlignment, horzAlign: EHorzAlignment) => void

# Type declaration

▸ (glyphs, batchArrays, batchIndexs, wrapWidth, wrapHeight, lineHeight, anchor, padding, vertAlign, horzAlign): void

# Parameters

Name	Type
`glyphs`	`IGlyph`[]
`batchArrays`	`ICharacterData`[][]
`batchIndexs`	`number`[]
`wrapWidth`	`number`
`wrapHeight`	`number`
`lineHeight`	`number`
`anchor`	`number`[]
`padding`	`number`[]
`vertAlign`	`EVertAlignment`
`horzAlign`	`EHorzAlignment`

# Returns

void

# Accessors

# el

• get el(): Element

挂载的元素。

# Returns

Element

# id

• get id(): number

# Returns

number

# scene

• get scene(): Scene

当前场景。

# Returns

Scene

# version

• get version(): number

当前版本，每次有数据更新都会增加，可以用作和其他组件合作的依据。

# Returns

number

# Methods

# getData

▸ getData<T>(key): ITextData[T]

获取一个当前值。

# Type parameters

Name	Type
`T`	extends keyof `ITextData`

# Parameters

Name	Type
`key`	`T`

# Returns

ITextData[T]

# Inherited from

Component.getData

# setData

▸ setData(data): void

不通过xml而是直接设置data，注意值的类型需要和schema中一致。

# Parameters

Name	Type
`data`	`Partial`<`ITextData`>

# Returns

void

# Inherited from

Component.setData

# setDataOne

▸ setDataOne<T>(key, value): void

设置一个数据。

# Type parameters

Name	Type
`T`	extends keyof `ITextData`

# Parameters

Name	Type
`key`	`T`
`value`	`ITextData`[`T`]

# Returns

void

# Inherited from

Component.setDataOne