Documentation / scene / GPUClothComponent

Class: GPUClothComponent

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:201

Serializable owner for one GPU cloth simulation.

The component stores only stable asset data. GPU buffers are rebuilt when its host enters a scene.

Extends

• Disposable

Constructors

Constructor

new GPUClothComponent(config?): GPUClothComponent

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:210

Parameters

config?

Partial<GPUClothComponentConfig>

Returns

GPUClothComponent

Overrides

Disposable.constructor

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/dist/index.d.ts:6107

Returns

boolean

Inherited from

Disposable.disposed

---

config

Get Signature

get config(): GPUClothComponentConfig

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:221

Returns

GPUClothComponentConfig

---

host

Get Signature

get host(): SceneNode

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:225

Returns

SceneNode

---

system

Get Signature

get system(): GPUClothSystem

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:229

Returns

GPUClothSystem

---

disabledReason

Get Signature

get disabledReason(): string

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:233

Returns

string

Methods

on()

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:630

IEventTarget.on

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Disposable.on

---

once()

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:634

IEventTarget.once

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Disposable.once

---

off()

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:638

IEventTarget.off

Type Parameters

K

K extends "dispose"

Parameters

type

K

listener?

EventListener<{ dispose: []; }>

context?

unknown

Returns

void

Inherited from

Disposable.off

---

dispatchEvent()

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:642

IEventTarget.dispatchEvent

Type Parameters

K

K extends "dispose"

Parameters

type

K

args

...object[K]

Returns

void

Inherited from

Disposable.dispatchEvent

---

dispose()

dispose(): void

Defined in: libs/base/dist/index.d.ts:6108

Returns

void

Inherited from

Disposable.dispose

---

setConfig()

setConfig(config): Promise<void>

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:237

Parameters

config

Partial<GPUClothComponentConfig>

Returns

Promise<void>

---

rebuild()

rebuild(): Promise<void>

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:281

Returns

Promise<void>

---

onDispose()

protected onDispose(): void

Defined in: libs/scene/src/animation/cloth/gpu_cloth_component.ts:439

Returns

void

Overrides

Disposable.onDispose