ThreeRenderer
Generic three.js renderer
Extends @geenee/armature!SceneRenderer for the three.js rendering engine. ThreeRenderer does basic initialization of engine, scene, and camera. It’s a generic class that should be parameterized by type of processing results to build an app using particular implementation of @geenee/armature!Processor.
Extends
SceneRenderer<ResultT,Scene>
Extended by
Type Parameters
• ResultT extends object = object
Type of processing results
Constructors
new ThreeRenderer()
new ThreeRenderer<
ResultT>(container,mode?,mirror?):ThreeRenderer<ResultT>
Constructor
Parameters
• container: HTMLElement
Container of @geenee/armature!ResponsiveCanvas
• mode?: CanvasMode
Fitting mode
• mirror?: boolean
Mirror the output
Returns
ThreeRenderer<ResultT>
Overrides
Properties
camera
protectedcamera:Camera
Camera instance
cameraAngle
protectedcameraAngle:number
Camera vertical angle in radians
Inherited from
cameraRatio
protectedcameraRatio:number
Camera aspect ratio
Inherited from
canvas
canvas:
ResponsiveCanvas
Responsive canvas
Inherited from
current
current:
null|WebGLTexture
Current image texture
Inherited from
input?
optionalinput:ImageTexture
Input image texture
Inherited from
loaded
protectedloaded:boolean
Loaded state
Inherited from
padCtx
protectedpadCtx: [null|CanvasRenderingContext2D,null|CanvasRenderingContext2D]
Drawing context of padding canvases
Inherited from
plugins
protectedplugins:Plugin<ResultT>[]
Attached plugins
Inherited from
renderer
protectedrenderer:WebGLRenderer
Rendering engine
scene?
optionalscene:Scene
Renderer scene
Inherited from
setupPadding()
protectedsetupPadding: () =>void
Setup padding canvases
Callback sets up size of padding canvases.
Returns
void
Inherited from
shader?
protectedoptionalshader:ShaderProgram
Rendering shader
Inherited from
shaderCtx
shaderCtx:
null|WebGL2RenderingContext
Context of the video canvas layer
Inherited from
videoRatio
protectedvideoRatio:number
Aspect ratio of input video
Inherited from
videoSize
protectedvideoSize:Size
Resolution of input video
Inherited from
Methods
addListener()
addListener<
E>(event,listener):this
Adds the listener function to the end of the listeners array
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
• listener: RendererEvents[E]
The callback function
Returns
this
This EventEmitter
Inherited from
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
• plugin: Plugin<ResultT>
Returns
Promise<void>
Inherited from
dispose()
dispose():
void
Dispose renderer object
Extended to dispose scene object.
Returns
void
Inherited from
disposeObject()
protecteddisposeObject(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
• object: Object3D<Object3DEventMap>
Object to dispose
Returns
void
emit()
emit<
E>(event, …args):boolean
Synchronously calls each of the listeners registered for the event
Type Parameters
• E extends keyof RendererEvents
Parameters
• 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
eventNames()
eventNames(): (
string|symbol)[]
List of emitter’s events
Returns
(string | symbol)[]
List of emitter’s events
Inherited from
getMaxListeners()
getMaxListeners():
number
Maximum number of listeners per event
Returns
number
Maximum number of listeners per event
Inherited from
listenerCount()
listenerCount<
E>(event):number
The number of listeners listening to the event
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
Returns
number
Number of listeners
Inherited from
listeners()
listeners<
E>(event):Function[]
Copy of the array of listeners for the event
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
Returns
Function[]
Copy of the listeners array
Inherited from
load()
load():
Promise<void>
Initialize renderer
Initializes rendering context, shader program and buffers.
Returns
Promise<void>
Promise resolving when initialization is finished
Inherited from
off()
off<
E>(event,listener):this
Removes the listener from the listener array for the event
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
• listener: RendererEvents[E]
The callback function
Returns
this
This EventEmitter
Inherited from
on()
on<
E>(event,listener):this
Adds the listener function to the event
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
• listener: RendererEvents[E]
The callback function
Returns
this
This EventEmitter
Inherited from
once()
once<
E>(event,listener):this
Adds a one-time listener function for the event
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
• listener: RendererEvents[E]
The callback function
Returns
this
This EventEmitter
Inherited from
prependListener()
prependListener<
E>(event,listener):this
Adds the listener function to the beginning of the listeners array
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
• listener: RendererEvents[E]
The callback function
Returns
this
This EventEmitter
Inherited from
prependOnceListener()
prependOnceListener<
E>(event,listener):this
Adds a one-time listener function to the beginning of the listeners array
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
• listener: RendererEvents[E]
The callback function
Returns
this
Inherited from
SceneRenderer.prependOnceListener
rawListeners()
rawListeners<
E>(event):Function[]
Copy of the array of listeners for the event including wrappers
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
Returns
Function[]
Copy of the listeners array
Inherited from
removeAllListeners()
removeAllListeners<
E>(event?):this
Removes all listeners, or those of the specified event
Type Parameters
• E extends keyof RendererEvents
Parameters
• event?: E
The name of the event
Returns
this
This EventEmitter
Inherited from
SceneRenderer.removeAllListeners
removeAllPlugins()
removeAllPlugins():
void
Remove all render plugins
Renderer will dispose all plugins before detaching them.
Returns
void
Inherited from
SceneRenderer.removeAllPlugins
removeListener()
removeListener<
E>(event,listener):this
Removes the specified listener from the listener array
Type Parameters
• E extends keyof RendererEvents
Parameters
• event: E
The name of the event
• listener: RendererEvents[E]
The callback function
Returns
this
This EventEmitter
Inherited from
removePlugin()
removePlugin(
plugin):void
Remove render plugin
Renderer will dispose the plugin before detaching it.
Parameters
• plugin: Plugin<ResultT>
Returns
void
Inherited from
setMaxListeners()
setMaxListeners(
n):this
Sets maximum number of listeners per event
Parameters
• n: number
Maximum number of listeners
Returns
this
This EventEmitter
Inherited from
setMirror()
setMirror(
mirror):void
Set mirror mode
CanvasRenderer sets mirror mode of ResponsiveCanvas.
Parameters
• mirror: boolean
Mirror the output
Returns
void
Inherited from
setMode()
setMode(
mode):void
Set fitting mode
CanvasRenderer sets fitting mode of ResponsiveCanvas.
Parameters
• mode: CanvasMode
Fitting mode
Returns
void
Inherited from
setupCamera()
setupCamera(
ratio,angle):void
Set camera parameters
Setups ThreeRenderer#camera instance according to parameters provided by @geenee/armature!Processor.
Parameters
• ratio: number
Aspect ration of input video
• angle: number
Vertical field of view in radians
Returns
void
Overrides
setupVideo()
setupVideo(
size,ratio?):void
Set camera parameters
If ThreeRenderer#camera is OrthographicCamera sets orthographic projection according to resolution of video.
Parameters
• size: Size
Resolution of input video
• ratio?: number
Aspect ration of input video
Returns
void
Overrides
unload()
unload():
void
Reset renderer
Releases all resources and instances created in load(). Releases rendering context, shader program and buffers.
Returns
void
Inherited from
update()
update(
result,stream):Promise<void>
Update the scene
Renderers input video frame on corresponding canvas layer.
Parameters
• result: ResultT
Results of video processing
• stream: HTMLCanvasElement
Captured video frame
Returns
Promise<void>
Promise resolving when update is finished
Inherited from
updatePads()
protectedupdatePads(stream):void
Update padding canvases
Updates padding canvases using portions of video frame.
Parameters
• stream: HTMLCanvasElement
Captured video frame
Returns
void
Inherited from
updatePlugins()
protectedupdatePlugins(result,stream):Promise<void>
Update attached plugins
Calls update() of all attached plugins.
Parameters
• result: ResultT
Results of video processing
• stream: HTMLCanvasElement
Captured video frame
Returns
Promise<void>
Promise resolving when update is finished
Inherited from
updateScene()
protectedupdateScene():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
Overrides
updateVideo()
protectedupdateVideo(stream):void
Update the video layer
Calls rendering shaders with current input texture.
Parameters
• stream: HTMLCanvasElement
Captured video frame
Returns
void