RealityOS Docs and Examples

Appearance

@tmrw-realityos/world • Docs

@tmrw-realityos/world / Components / PrefabRenderer

Class: PrefabRenderer ​

Prefab renderer component

Extends ​

Constructors ​

new PrefabRenderer() ​

new PrefabRenderer(): PrefabRenderer

Returns ​

PrefabRenderer

Overrides ​

BaseComponent.constructor

Defined in ​

world/components/prefabRenderer.ts:43

Properties ​

animationMode ​

animationMode: eAnimationMode = 0

Defined in ​

world/components/prefabRenderer.ts:37

currentTime ​

currentTime: number = 0

Defined in ​

world/components/prefabRenderer.ts:36

enabled ​

enabled: boolean = true

Inherited from ​

BaseComponent.enabled

Defined in ​

world/components.ts:7

mustSave ​

mustSave: boolean = true

Inherited from ​

BaseComponent.mustSave

Defined in ​

world/components.ts:8

parent? ​

optional parent: ComponentsContainer

Inherited from ​

BaseComponent.parent

Defined in ​

world/components.ts:14

uid ​

uid: string = ""

Inherited from ​

BaseComponent.uid

Defined in ​

world/components.ts:9

url ​

url: string = ""

Defined in ​

world/components/prefabRenderer.ts:35

compName ​

static compName: string = "PrefabRenderer"

Overrides ​

BaseComponent.compName

Defined in ​

world/components/prefabRenderer.ts:33

Accessors ​

entity ​

get entity(): undefined | Entity

set entity(_v): void

Parameters ​

• _v: Entity

Returns ​

undefined | Entity

Inherited from ​

BaseComponent.entity

Defined in ​

world/components.ts:24

Methods ​

configure() ​

configure(o): void

Parameters ​

• o: PrefabRendererDescriptor

Returns ​

void

Overrides ​

BaseComponent.configure

Defined in ​

world/components/prefabRenderer.ts:152

getCompName() ​

getCompName(): string

Returns ​

string

Inherited from ​

BaseComponent.getCompName

Defined in ​

world/components.ts:11

loadPrefab() ​

loadPrefab(): void

Returns ​

void

Defined in ​

world/components/prefabRenderer.ts:58

onAdded()? ​

optional onAdded(): void

Returns ​

void

Inherited from ​

BaseComponent.onAdded

Defined in ​

world/components.ts:21

onClick()? ​

optional onClick(): void

Returns ​

void

Inherited from ​

BaseComponent.onClick

Defined in ​

world/components.ts:19

onGLTFProcess() ​

onGLTFProcess(gltf, _url, gltfToNodes): void

Parameters ​

• gltf: GlTf

• _url: string

• gltfToNodes: GltfToNodes

Returns ​

void

Defined in ​

world/components/prefabRenderer.ts:87

onRemoved()? ​

optional onRemoved(): void

Returns ​

void

Inherited from ​

BaseComponent.onRemoved

Defined in ​

world/components.ts:22

onUpdate() ​

onUpdate(dt): void

Parameters ​

• dt: number

Returns ​

void

Overrides ​

BaseComponent.onUpdate

Defined in ​

world/components/prefabRenderer.ts:47

serialize() ​

serialize(): void

Returns ​

void

Inherited from ​

BaseComponent.serialize

Defined in ​

world/components.ts:17

updateMaterials() ​

updateMaterials(): void

updates materials from GLTF with the custom ones found in the JSON of this component

Returns ​

void

Defined in ​

world/components/prefabRenderer.ts:93