PoseTwinPlugin
Plugin rendering a digital twin
PoseAlignPlugin extension for digital twins mirroring the pose and residing beside a user. When rendering a twin we do not translate bones to align with keypoint coordinates and only preserve relative rotations. After projecting the detected pose onto a twin, twin’s scene node can be further transformed relative to the initial position - centers of hips are the same.
Extends
Constructors
new PoseTwinPlugin()
new PoseTwinPlugin(
node?,translation?,rotation?,scale?,tune?):PoseTwinPlugin
Constructor
Parameters
• node?: Object3D<Object3DEventMap>
Scene node to attach
• translation?: Vector3
Relative translation of the twin
• rotation?: Quaternion
Relative rotation of the twin
• scale?: number
Scale of the twin
• tune?: PoseTuneParams = ...
Fine-tuning parameters
Returns
Overrides
Properties
alignScore
readonlyalignScore:0.9=0.90
Pose score threshold
Inherited from
alignVisibility
readonlyalignVisibility:0.9=0.90
Keypoint visibility threshold
Inherited from
PoseAlignPlugin.alignVisibility
avatarLength
protectedavatarLength:number=1
Reference length of the model
Inherited from
loaded
loaded:
boolean
Loaded state
Inherited from
node?
protectedoptionalnode:Object3D<Object3DEventMap>
Scene node to attach
Inherited from
ordinal
ordinal:
number
Ordinal number
Inherited from
renderer?
protectedoptionalrenderer:Renderer<PoseResult>
Renderer loaded the plugin
Inherited from
rotation?
protectedoptionalrotation:Quaternion
Relative rotation of the twin
scale?
protectedoptionalscale:number
Scale of the twin
scene?
protectedoptionalscene:Scene
Reference to a scene instance
Inherited from
skeleton?
protectedoptionalskeleton:Skeleton
Reference to model’s skeleton
Inherited from
skeletonNodes?
protectedoptionalskeletonNodes:SkeletonNodes
Bones of the model’s rig
Inherited from
spineCurve?
protectedoptionalspineCurve:SpineCurve
Shape of spine
Inherited from
translation?
protectedoptionaltranslation:Vector3
Relative translation of the twin
tune
protectedtune:PoseTuneParams
Fine-tuning parameters
Inherited from
Methods
alignBone()
protectedalignBone(transform,bone):void
Set bone aligning transformation
Overridden to assign only relative rotation.
Parameters
• transform: BoneTransform
Global bone position and rotation
• bone: Bone<Object3DEventMap>
Reference to bone instance
Returns
void
Overrides
dispose()
dispose():
void
Dispose video plugin
Returns
void
Inherited from
estimateBones()
protectedestimateBones(points,spineCurve):SkeletonTransforms
Estimate bone positions and axes
Based on detected keypoints estimates bone transformations. Position of bone if defined by 3D point itself, bone length is the distance between keypoints connected by bone. Bone’s rotation is defined by its axes that are evaluated from relative positions of adjacent keypoints. Method returns only bone position and orientation axis, final transformation of any bone can be found using the next bone in hierarchy.
Parameters
• points: PosePoints
Pose keypoints
• spineCurve: SpineCurve
Shape of spine
Returns
Bone transformations
Inherited from
load()
load(
renderer):Promise<void>
Initialize plugin
Parses and caches the rig/armature of the attached scene node (one provided to plugin’s constructor). Precalculates geometrical parameters of skeleton.
Parameters
• renderer: Renderer<PoseResult>
Renderer this plugin is attached to
Returns
Promise<void>
Promise resolving when initialization is finished
Inherited from
setNode()
setNode(
node?):void
Set/attach a scene node
Parses and caches the rig/armature of the node. Precalculates geometrical parameters of skeleton.
Parameters
• node?: Object3D<Object3DEventMap>
Scene node to attach
Returns
void
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
Removes the attached node.
Returns
void
Inherited from
update()
update(
result,stream):Promise<void>
Update skeleton of the scene node
Method is extended to set twin’s translation, rotation, and scale relative to estimated pose.
Parameters
• result: PoseResult
Pose estimation results
• stream: HTMLCanvasElement
Captured video frame
Returns
Promise<void>
Promise resolving when update is finished
Overrides
updateHandL()
protectedupdateHandL(anchors,points):void
Update left hand skeleton
Parameters
• anchors: SkeletonTransforms
Positions and axes of bones
• points: PosePoints
Pose keypoints
Returns
void
Inherited from
updateHandR()
protectedupdateHandR(anchors,points):void
Update right hand skeleton
Parameters
• anchors: SkeletonTransforms
Positions and axes of bones
• points: PosePoints
Pose keypoints
Returns
void
Inherited from
updateLegL()
protectedupdateLegL(anchors,points):void
Update left leg skeleton
Parameters
• anchors: SkeletonTransforms
Positions and axes of bones
• points: PosePoints
Pose keypoints
Returns
void
Inherited from
updateLegR()
protectedupdateLegR(anchors,points):void
Update right leg skeleton
Parameters
• anchors: SkeletonTransforms
Positions and axes of bones
• points: PosePoints
Pose keypoints
Returns
void
Inherited from
updateSpine()
protectedupdateSpine(anchors):void
Update spine skeleton
Overridden to ignore relative scaling.
Parameters
• anchors: SkeletonTransforms
Positions and axes of bones
Returns
void