Class: PoseRenderer

@geenee/bodyrenderers-babylon.PoseRenderer

Abstract renderer for PoseProcessor

Specializes the BabylonRenderer generic for PoseResult. This is abstract renderer that doesn't implement any logic.

Hierarchy

• BabylonRenderer<PoseResult>

  ↳ PoseRenderer

Constructors

constructor

• new PoseRenderer(container, mode?, mirror?)

Constructor

Parameters

Name	Type	Description
container	HTMLElement	Container of ResponsiveCanvas
mode?	CanvasMode	Fitting mode
mirror?	boolean	Mirror the output

Inherited from

BabylonRenderer.constructor

Properties

camera

• Protected camera: UniversalCamera

Camera instance

Inherited from

BabylonRenderer.camera

---

cameraAngle

• Protected cameraAngle: number

Camera's vertical angle of view

Inherited from

BabylonRenderer.cameraAngle

---

cameraRatio

• Protected cameraRatio: number

Camera aspect ratio

Inherited from

BabylonRenderer.cameraRatio

---

canvas

• canvas: ResponsiveCanvas

Responsive canvas

Inherited from

BabylonRenderer.canvas

---

loaded

• Protected loaded: boolean

Loaded state

Inherited from

BabylonRenderer.loaded

---

padCtx

• Protected padCtx: [null | CanvasRenderingContext2D, null | CanvasRenderingContext2D]

Drawing context of padding canvases

Inherited from

BabylonRenderer.padCtx

---

plugins

• Protected plugins: (ScenePlugin<PoseResult, Scene> | VideoPlugin<PoseResult>)[]

Attached plugins

Inherited from

BabylonRenderer.plugins

---

renderer

• Protected renderer: Engine

Rendering engine

Inherited from

BabylonRenderer.renderer

---

scene

• Protected Optional scene: Scene

Renderer scene

Inherited from

BabylonRenderer.scene

---

setupPadding

• setupPadding: () => void

Type declaration

▸ (): void

Setup padding canvases

Callback sets up size of padding canvases.

Returns

void

Inherited from

BabylonRenderer.setupPadding

---

videoCtx

• Protected videoCtx: null | CanvasRenderingContext2D

Drawing context of video canvas layer

Inherited from

BabylonRenderer.videoCtx

---

videoRatio

• Protected videoRatio: number

Aspect ratio of input video

Inherited from

BabylonRenderer.videoRatio

---

videoSize

• Protected videoSize: Size

Resolution of input video

Inherited from

BabylonRenderer.videoSize

Methods

addListener

▸ addListener<E>(event, listener): PoseRenderer

Adds the listener function to the end of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.addListener

---

addPlugin

▸ addPlugin(plugin): Promise<void>

Add render plugin

Initializes the plugin if it's not loaded yet but renderer is ready. Renderer takes ownership of the plugin instance meaning it will release it when plugin is detached or renderer is disposed itself.

Parameters

Name	Type
plugin	ScenePlugin<PoseResult, Scene> | VideoPlugin<PoseResult>

Returns

Promise<void>

Inherited from

BabylonRenderer.addPlugin

---

dispose

▸ dispose(): void

Dispose renderer object

Extended to dispose all attached plugins.

Returns

void

Inherited from

BabylonRenderer.dispose

---

emit

▸ emit<E>(event, ...args): boolean

Synchronously calls each of the listeners registered for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
...args	Args<RendererEvents[E]>	Arguments passed to the listeners

Returns

boolean

True if the event had listeners, False otherwise

Inherited from

BabylonRenderer.emit

---

eventNames

▸ eventNames(): (string | symbol)[]

List of emitter's events

Returns

(string | symbol)[]

List of emitter's events

Inherited from

BabylonRenderer.eventNames

---

getMaxListeners

▸ getMaxListeners(): number

Maximum number of listeners per event

Returns

number

Maximum number of listeners per event

Inherited from

BabylonRenderer.getMaxListeners

---

listenerCount

▸ listenerCount<E>(event): number

The number of listeners listening to the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

number

Number of listeners

Inherited from

BabylonRenderer.listenerCount

---

listeners

▸ listeners<E>(event): Function[]

Copy of the array of listeners for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

BabylonRenderer.listeners

---

load

▸ load(): Promise<void>

Initialize renderer

Initializes all attached plugins.

Returns

Promise<void>

Promise resolving when initialization is finished

Inherited from

BabylonRenderer.load

---

off

▸ off<E>(event, listener): PoseRenderer

Removes the listener from the listener array for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.off

---

on

▸ on<E>(event, listener): PoseRenderer

Adds the listener function to the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.on

---

once

▸ once<E>(event, listener): PoseRenderer

Adds a one-time listener function for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.once

---

prependListener

▸ prependListener<E>(event, listener): PoseRenderer

Adds the listener function to the beginning of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.prependListener

---

prependOnceListener

▸ prependOnceListener<E>(event, listener): PoseRenderer

Adds a one-time listener function to the beginning of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

PoseRenderer

Inherited from

BabylonRenderer.prependOnceListener

---

rawListeners

▸ rawListeners<E>(event): Function[]

Copy of the array of listeners for the event including wrappers

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

BabylonRenderer.rawListeners

---

removeAllListeners

▸ removeAllListeners<E>(event?): PoseRenderer

Removes all listeners, or those of the specified event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event?	E	The name of the event

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.removeAllListeners

---

removeAllPlugins

▸ removeAllPlugins(): void

Remove all render plugins

Renderer will dispose all plugins before detaching them.

Returns

void

Inherited from

BabylonRenderer.removeAllPlugins

---

removeListener

▸ removeListener<E>(event, listener): PoseRenderer

Removes the specified listener from the listener array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.removeListener

---

removePlugin

▸ removePlugin(plugin): void

Remove render plugin

Renderer will dispose the plugin before detaching it.

Parameters

Name	Type
plugin	ScenePlugin<PoseResult, Scene> | VideoPlugin<PoseResult>

Returns

void

Inherited from

BabylonRenderer.removePlugin

---

setMaxListeners

▸ setMaxListeners(n): PoseRenderer

Sets maximum number of listeners per event

Parameters

Name	Type	Description
n	number	Maximum number of listeners

Returns

PoseRenderer

This EventEmitter

Inherited from

BabylonRenderer.setMaxListeners

---

setMirror

▸ setMirror(mirror): void

Set mirror mode

CanvasRenderer sets mirror mode of ResponsiveCanvas.

Parameters

Name	Type
mirror	boolean

Returns

void

Inherited from

BabylonRenderer.setMirror

---

setupCamera

▸ setupCamera(ratio, angle): void

Set camera parameters

Setups camera instance according to parameters provided by Processor.

Parameters

Name	Type	Description
ratio	number	Aspect ration of input video
angle	number	-

Returns

void

Inherited from

BabylonRenderer.setupCamera

---

setupVideo

▸ setupVideo(size, ratio?): void

Set video parameters

Callback sets up size of video canvas layer.

Parameters

Name	Type	Description
size	Size	Resolution of input video
ratio?	number	Aspect ration of input video

Returns

void

Inherited from

BabylonRenderer.setupVideo

---

unload

▸ unload(): void

Reset renderer

Resets all attached plugins.

Returns

void

Inherited from

BabylonRenderer.unload

---

update

▸ update(result, stream): Promise<void>

Update the scene

Calls updated of all attached plugins.

Parameters

Name	Type	Description
result	PoseResult	Results of video processing
stream	HTMLCanvasElement	Captured video frame

Returns

Promise<void>

Promise resolving when update is finished

Inherited from

BabylonRenderer.update

---

updateScene

▸ Protected updateScene(): void

Update and render the scene

Virtual method updating and rendering 3D scene. For babylon.js engine calls this.scene.render().

Returns

void

Inherited from

BabylonRenderer.updateScene

---

updateVideo

▸ Protected updateVideo(stream): void

Update the video

Draws input video frame on corresponding canvas layer.

Parameters

Name	Type	Description
stream	HTMLCanvasElement	Captured video frame

Returns

void

Inherited from

BabylonRenderer.updateVideo