@tmrw-realityos/world

---

@tmrw-realityos/world / Components / Surface

Class: Surface

Defined in: world/components/surface.ts:27

Surface component

Extends

• BaseComponent

Constructors

new Surface()

new Surface(): Surface

Defined in: world/components/surface.ts:52

Returns

Surface

Overrides

BaseComponent.constructor

Properties

canvas?

optional canvas: HTMLCanvasElement

Defined in: world/components/surface.ts:34

---

cursor

cursor: vec2

Defined in: world/components/surface.ts:35

---

enabled

enabled: boolean = true

Defined in: world/components.ts:7

Inherited from

BaseComponent.enabled

---

index

index: number

Defined in: world/components/surface.ts:32

---

isVisible

isVisible: boolean = true

Defined in: world/components/surface.ts:37

---

mustSave

mustSave: boolean = true

Defined in: world/components.ts:8

Inherited from

BaseComponent.mustSave

---

parent?

optional parent: ComponentsContainer

Defined in: world/components.ts:14

Inherited from

BaseComponent.parent

---

proxyNodeName

proxyNodeName: string = ""

Defined in: world/components/surface.ts:31

---

tv

tv: boolean = true

Defined in: world/components/surface.ts:38

---

uid

uid: string = ""

Defined in: world/components.ts:9

Inherited from

BaseComponent.uid

---

allowSurface

static allowSurface: boolean = true

Defined in: world/components/surface.ts:50

---

compName

static compName: string = "Surface"

Defined in: world/components/surface.ts:28

Overrides

BaseComponent.compName

---

emissiveFactor

static emissiveFactor: vec3

Defined in: world/components/surface.ts:49

---

lastIndex

static lastIndex: number = 0

Defined in: world/components/surface.ts:29

Accessors

entity

Get Signature

get entity(): undefined | Entity

Defined in: world/components.ts:24

Returns

undefined | Entity

Set Signature

set entity(_v): void

Defined in: world/components.ts:27

Parameters

_v

Entity

Returns

void

Inherited from

BaseComponent.entity

Methods

configure()

configure(o): void

Defined in: world/components/surface.ts:282

Parameters

o

proxy_node

string

Returns

void

Overrides

BaseComponent.configure

---

drawApp()

drawApp(canvas, ctx): void

Defined in: world/components/surface.ts:248

Parameters

canvas

HTMLCanvasElement

ctx

CanvasRenderingContext2D

Returns

void

---

getCompName()

getCompName(): string

Defined in: world/components.ts:11

Returns

string

Inherited from

BaseComponent.getCompName

---

getTargetNode()

getTargetNode(): undefined | Node

Defined in: world/components/surface.ts:105

called from

Returns

undefined | Node

---

onAdded()

onAdded(): void

Defined in: world/components/surface.ts:58

Returns

void

Overrides

BaseComponent.onAdded

---

onClick()?

optional onClick(): void

Defined in: world/components.ts:19

Returns

void

Inherited from

BaseComponent.onClick

---

onDrawGizmos()

onDrawGizmos(renderer): void

Defined in: world/components/surface.ts:286

Parameters

renderer

RendererInterface

Returns

void

---

onMouse()

onMouse(e): void

Defined in: world/components/surface.ts:84

Parameters

e

PointerEvent

Returns

void

---

onRay()

onRay(ray): void

Defined in: world/components/surface.ts:90

Called from Player.sendMouseInteractionToWorld

Parameters

ray

Ray

Returns

void

---

onRemoved()

onRemoved(): void

Defined in: world/components/surface.ts:77

Returns

void

Overrides

BaseComponent.onRemoved

---

onUpdate()?

optional onUpdate(dt): void

Defined in: world/components.ts:20

Parameters

dt

number

Returns

void

Inherited from

BaseComponent.onUpdate

---

preRender()

preRender(camera): void

Defined in: world/components/surface.ts:123

Parameters

camera

Camera

Returns

void

---

serialize()

serialize(): void

Defined in: world/components.ts:17

Returns

void

Inherited from

BaseComponent.serialize

---

updateCanvas()

updateCanvas(camera): void

Defined in: world/components/surface.ts:194

Parameters

camera

Camera

Returns

void

---

setEmissiveFactor()

static setEmissiveFactor(v): void

Defined in: world/components/surface.ts:302

Parameters

v

number | vec3

Returns

void