xr-frame / Exports / AssetPostProcess

# Class: AssetPostProcess

渲染纹理创建组件,用于在xml中创建PostProcess资源,一般被代理到XRAssetPostProcess元素。

# Hierarchy

# Table of contents

# Constructors

# Events

# Properties

# Accessors

# Methods

# Constructors

# constructor

new AssetPostProcess()

# Inherited from

Component.constructor

# Events

# onAdd

onAdd(parent, data): void

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

# Parameters

Name Type
parent Element
data IAssetPostProcessData

# Returns

void

# Inherited from

Component.onAdd


# onRelease

onRelease(data): void

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

# Parameters

Name Type
data IAssetPostProcessData

# Returns

void

# Inherited from

Component.onRelease


# onRemove

onRemove(parent, data): void

移除AssetPostProcess。

# Parameters

Name Type
parent Element
data IAssetPostProcessData

# Returns

void

# Inherited from

Component.onRemove


# onTick

onTick(deltaTime, data): void

渲染每帧触发的回调。

# Parameters

Name Type Description
deltaTime number 单位为毫秒(ms)。
data IAssetPostProcessData -

# Returns

void

# Inherited from

Component.onTick


# onUpdate

onUpdate(data, preData): void

数据更新时触发的回调。

# Parameters

# Returns

void

# Inherited from

Component.onUpdate

# Properties

# priority

Readonly priority: number

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

# Inherited from

Component.priority


# schema

Readonly schema: IComponentSchema

详见{@link AssetPostProcessSchema}。

# Overrides

Component.schema


# EVENTS

Static EVENTS: string[] = []

# Inherited from

Component.EVENTS

# Accessors

# assetData

get assetData(): Object

对应后处理资源的数据,可用于修改。

# Returns

Object


# el

get el(): Element

挂载的元素。

# Returns

Element


# scene

get scene(): Scene

当前场景。

# Returns

Scene


# version

get version(): number

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

# Returns

number

# Methods

# getData

getData<T>(key): IAssetPostProcessData[T]

获取一个当前值。

# Type parameters

Name Type
T extends keyof IAssetPostProcessData

# Parameters

Name Type
key T

# Returns

IAssetPostProcessData[T]

# Inherited from

Component.getData


# setData

setData(data): void

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

# Parameters

Name Type
data Partial<IAssetPostProcessData>

# Returns

void

# Inherited from

Component.setData


# setDataOne

setDataOne<T>(key, value): void

设置一个数据。

# Type parameters

Name Type
T extends keyof IAssetPostProcessData

# Parameters

Name Type
key T
value IAssetPostProcessData[T]

# Returns

void

# Inherited from

Component.setDataOne