@tmrw-realityos/charm / Exports / ROSModel

Class: ROSModel

An element that adds functionality to ROSPlayer and lives inside the host, usually a <ros-player> element. Defines a simplified and isolated way to communicate with the host without knowing its inner details.

Hierarchy

• LitElement

  ↳ ROSModel

Implements

• ROSPlugin

Table of contents

Constructors

• constructor

Properties

• animationName
• animationTime
• animations
• format
• lastAnimationIndex
• modelURL
• position
• root
• sourceModel
• supportedExtensions

Methods

• connectedCallback
• disconnectedCallback
• getCurrentAnimation
• initializePlugin
• loadModelFromGLB
• loadModelFromURL
• updateAnimation
• willUpdate

HTML Properties

In case modelURL does not include an extension, use format as a hint of how to parse the model. Possible values are "gltf" or "glb".

format

• Optional format: "gltf" | "glb"

Defined in

packages/charm/src/webComponents/ROSModel.ts:41

HTML Properties

The relative or absolute URL of a GLB or GLTF file.

modelURL

• modelURL: string = ""

Defined in

packages/charm/src/webComponents/ROSModel.ts:34

Other

constructor

• new ROSModel(url?): ROSModel

Parameters

Name	Type	Default value
url	string	""

Returns

ROSModel

Overrides

LitElement.constructor

Defined in

packages/charm/src/webComponents/ROSModel.ts:61

---

animationName

• animationName: string = "default"

Defined in

packages/charm/src/webComponents/ROSModel.ts:43

---

animationTime

• animationTime: number = 0

Defined in

packages/charm/src/webComponents/ROSModel.ts:45

---

animations

• animations: Animation[] = []

Defined in

packages/charm/src/webComponents/ROSModel.ts:49

---

lastAnimationIndex

• lastAnimationIndex: number = -1

Defined in

packages/charm/src/webComponents/ROSModel.ts:50

---

position

• position: string = ""

Defined in

packages/charm/src/webComponents/ROSModel.ts:35

---

root

• root: Node

Defined in

packages/charm/src/webComponents/ROSModel.ts:47

---

sourceModel

• Optional sourceModel: GlTf

Defined in

packages/charm/src/webComponents/ROSModel.ts:48

---

supportedExtensions

• supportedExtensions: string[]

Defined in

packages/charm/src/webComponents/ROSModel.ts:172

---

connectedCallback

▸ connectedCallback(): void

Returns

void

Overrides

LitElement.connectedCallback

Defined in

packages/charm/src/webComponents/ROSModel.ts:82

---

disconnectedCallback

▸ disconnectedCallback(): void

Returns

void

Overrides

LitElement.disconnectedCallback

Defined in

packages/charm/src/webComponents/ROSModel.ts:75

---

getCurrentAnimation

▸ getCurrentAnimation(): undefined | Animation

Returns

undefined | Animation

Defined in

packages/charm/src/webComponents/ROSModel.ts:278

---

initializePlugin

▸ initializePlugin(host, device): Promise<void>

Parameters

Name	Type
host	ROSHost
device	GPUDevice

Returns

Promise<void>

Implementation of

ROSPlugin.initializePlugin

Defined in

packages/charm/src/webComponents/ROSModel.ts:68

---

loadModelFromGLB

▸ loadModelFromGLB(buffer): Promise<void>

Parameters

Name	Type
buffer	ArrayBuffer

Returns

Promise<void>

Defined in

packages/charm/src/webComponents/ROSModel.ts:162

---

loadModelFromURL

▸ loadModelFromURL(): Promise<void>

Returns

Promise<void>

Defined in

packages/charm/src/webComponents/ROSModel.ts:113

---

updateAnimation

▸ updateAnimation(elapsedTime): void

Parameters

Name	Type
elapsedTime	number

Returns

void

Defined in

packages/charm/src/webComponents/ROSModel.ts:265

---

willUpdate

▸ willUpdate(changedProperties): Promise<void>

Parameters

Name	Type
changedProperties	PropertyValueMap<ROSModel>

Returns

Promise<void>

Overrides

LitElement.willUpdate

Defined in

packages/charm/src/webComponents/ROSModel.ts:89