FacePlugin
Abstract plugin for FaceRenderer
Specializes the ThreePlugin generic for @geenee/bodyprocessors!FaceResult. This’s abstract plugin that doesn’t implement any logic.
Extends
Constructors
new FacePlugin()
new FacePlugin():
FacePlugin
Constructor
Returns
Inherited from
Properties
loaded
loaded:
boolean
Loaded state
Inherited from
ordinal
ordinal:
number
Ordinal number
Inherited from
renderer?
protectedoptionalrenderer:Renderer<FaceResult>
Renderer loaded the plugin
Inherited from
scene?
protectedoptionalscene:Scene
Reference to a scene instance
Inherited from
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<FaceResult>
Renderer this plugin is attached to
Returns
Promise<void>
Promise resolving when initialization is finished
Inherited from
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
Inherited from
update()
update(
result,stream):Promise<void>
Update
Main method implementing the logic of the plugin. Overridden by derived classes for particular task.
Parameters
• result: FaceResult
Results of video processing
• stream: HTMLCanvasElement
Captured video frame
Returns
Promise<void>
Promise resolving when update is finished