ScenePlugin
Generic scene plugin
ScenePlugins can be attached to SceneRenderer instances. Usually they control a scene node and implement simple tasks that can be separated from main rendering context. For example, make a scene node follow (be attached to) person’s head, or make node an occluder, or create face mesh node and set texture as a mask. On load() plugin prepares or modifies the attached node if required and reference to the scene object is cached to be used in update() and unload(); update() implements main logic and updates the scene node according to provided results.
Extends
Plugin<ResultT>
Extended by
Type Parameters
• ResultT extends object = object
Type of processing results
• SceneT = undefined
Type of renderer’s scene
Constructors
new ScenePlugin()
new ScenePlugin<
ResultT,SceneT>():ScenePlugin<ResultT,SceneT>
Constructor
Returns
ScenePlugin<ResultT, SceneT>
Overrides
Properties
loaded
loaded:
boolean=false
Loaded state
Inherited from
ordinal
ordinal:
number=PluginOrdinal.Render
Ordinal number
Inherited from
renderer?
protectedoptionalrenderer:Renderer<ResultT>
Renderer loaded the plugin
Inherited from
scene?
protectedoptionalscene:SceneT
Reference to a scene instance
Methods
dispose()
dispose():
void
Dispose video plugin
Returns
void
Inherited from
load()
load(
renderer):Promise<void>
Initialize plugin
Prepares or modifies the attached node if required. Reference to the scene object is cached and used by plugin on update() and unload(). You need to reload plugin if you want to change scene it’s attached to.
Parameters
• renderer: Renderer<ResultT>
Renderer this plugin is attached to
Returns
Promise<void>
Promise resolving when initialization is finished
Overrides
setupCamera()
setupCamera(
ratio,angle):void
Set camera parameters
Could be overridden to adjust plugin’s pipeline.
Parameters
• ratio: number
Aspect ration of input video
• angle: number
Vertical field of view in radians
Returns
void
Inherited from
setupVideo()
setupVideo(
size):void
Set video size
Could be overridden to adjust plugin’s pipeline.
Parameters
• size: Size
Resolution of input video
Returns
void
Inherited from
unload()
unload():
void
Reset plugin
Releases all resources allocated in load(). Deletes cached reference to the scene object.
Returns
void
Overrides
update()
update(
result,stream):Promise<void>
Update
Main method implementing the logic of the plugin. Overridden by derived classes for particular task.
Parameters
• result: ResultT
Results of video processing
• stream: HTMLCanvasElement
Captured video frame
Returns
Promise<void>
Promise resolving when update is finished