Class: PoseRenderer

@geenee/bodyrenderers-three.PoseRenderer

Abstract renderer for PoseProcessor

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

Hierarchy

• ThreeRenderer<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

ThreeRenderer.constructor

Properties

camera

• Protected camera: Camera

Camera instance

Inherited from

ThreeRenderer.camera

---

cameraAngle

• Protected cameraAngle: number

Camera's vertical angle of view

Inherited from

ThreeRenderer.cameraAngle

---

cameraRatio

• Protected cameraRatio: number

Camera aspect ratio

Inherited from

ThreeRenderer.cameraRatio

---

canvas

• canvas: ResponsiveCanvas

Responsive canvas

Inherited from

ThreeRenderer.canvas

---

loaded

• Protected loaded: boolean

Loaded state

Inherited from

ThreeRenderer.loaded

---

padCtx

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

Drawing context of padding canvases

Inherited from

ThreeRenderer.padCtx

---

plugins

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

Attached plugins

Inherited from

ThreeRenderer.plugins

---

renderer

• Protected renderer: WebGLRenderer

Rendering engine

Inherited from

ThreeRenderer.renderer

---

scene

• Protected Optional scene: Scene

Renderer scene

Inherited from

ThreeRenderer.scene

---

setupPadding

• setupPadding: () => void

Type declaration

▸ (): void

Setup padding canvases

Callback sets up size of padding canvases.

Returns

void

Inherited from

ThreeRenderer.setupPadding

---

videoCtx

• Protected videoCtx: null | CanvasRenderingContext2D

Drawing context of video canvas layer

Inherited from

ThreeRenderer.videoCtx

---

videoRatio

• Protected videoRatio: number

Aspect ratio of input video

Inherited from

ThreeRenderer.videoRatio

---

videoSize

• Protected videoSize: Size

Resolution of input video

Inherited from

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.addPlugin

---

dispose

▸ dispose(): void

Dispose renderer object

Extended to dispose all attached plugins.

Returns

void

Inherited from

ThreeRenderer.dispose

---

disposeObject

▸ Protected disposeObject(object): void

Dispose object

Helper method to remove object from the scene and recursively dispose it with all its children and allocated resources like materials and textures.

Parameters

Name	Type	Description
object	Object3D<Event>	Object to dispose

Returns

void

Inherited from

ThreeRenderer.disposeObject

---

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

ThreeRenderer.emit

---

eventNames

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

List of emitter's events

Returns

(string | symbol)[]

List of emitter's events

Inherited from

ThreeRenderer.eventNames

---

getMaxListeners

▸ getMaxListeners(): number

Maximum number of listeners per event

Returns

number

Maximum number of listeners per event

Inherited from

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.listeners

---

load

▸ load(): Promise<void>

Initialize renderer

Initializes all attached plugins.

Returns

Promise<void>

Promise resolving when initialization is finished

Inherited from

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.removeAllListeners

---

removeAllPlugins

▸ removeAllPlugins(): void

Remove all render plugins

Renderer will dispose all plugins before detaching them.

Returns

void

Inherited from

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.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

ThreeRenderer.setMaxListeners

---

setMirror

▸ setMirror(mirror): void

Set mirror mode

CanvasRenderer sets mirror mode of ResponsiveCanvas.

Parameters

Name	Type
mirror	boolean

Returns

void

Inherited from

ThreeRenderer.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

ThreeRenderer.setupCamera

---

setupVideo

▸ setupVideo(size, ratio?): void

Set camera parameters

If camera is OrthographicCamera sets orthographic projection according to resolution of video.

Parameters

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

Returns

void

Inherited from

ThreeRenderer.setupVideo

---

unload

▸ unload(): void

Reset renderer

Resets all attached plugins.

Returns

void

Inherited from

ThreeRenderer.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

ThreeRenderer.update

---

updateScene

▸ Protected updateScene(): void

Update and render the scene

Virtual method updating and rendering 3D scene. Basic implementation for three.js engine calls this.renderer.render(this.scene, this.camera).

Returns

void

Inherited from

ThreeRenderer.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

ThreeRenderer.updateVideo