ClothSkirtPlugin
Cloth plugin for armatures with auxiliary skirt bones
ClothSkirtPlugin is an extension of ClothAlignPlugin that controls auxiliary skirt bones of armature if presented. Skirt bones are driven by legs but has additional kinematic constrains to mimic deformation of a fabric more naturally. This technic provides for higher fidelity virtual try-on of apparels that have a loose bottom skirt by controlling this part independently and not making it stick to legs so tightly. Auxiliary skirt bones must be clones of up leg and leg bones and skirt part should be skinned against them instead of legs.
Extends
Constructors
new ClothSkirtPlugin()
new ClothSkirtPlugin(
node?,tune?):ClothSkirtPlugin
Constructor
Parameters
• node?: TransformNode
Scene node to attach
• tune?: PoseTuneParams = ...
Fine-tuning parameters
Returns
Inherited from
Properties
alignScore
readonlyalignScore:0.9=0.90
Pose score threshold
Inherited from
alignVisibility
readonlyalignVisibility:0.9=0.90
Keypoint visibility threshold
Inherited from
ClothAlignPlugin.alignVisibility
cameraAngle
protectedcameraAngle:number
Camera vertical angle in radians
Inherited from
cameraRatio
protectedcameraRatio:number
Camera aspect ratio
Inherited from
loaded
loaded:
boolean
Loaded state
Inherited from
node?
protectedoptionalnode:TransformNode
Scene node to attach
Inherited from
nodeOrigin
protectednodeOrigin:BoneTransform
Origin of node relative to the root bone
Inherited from
ordinal
ordinal:
number
Ordinal number
Inherited from
renderer?
protectedoptionalrenderer:Renderer<PoseResult>
Renderer loaded the plugin
Inherited from
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
ClothAlignPlugin.skeletonNodes
skeletonSizes?
protectedoptionalskeletonSizes:SkeletonSizes
Reference sizes of skeleton
Inherited from
ClothAlignPlugin.skeletonSizes
skirtSkeletonNodes?
protectedoptionalskirtSkeletonNodes:SkirtSkeletonNodes
Auxiliary bones of skirt rig
spineCurve?
protectedoptionalspineCurve:SpineCurve
Shape of spine
Inherited from
tune
protectedtune:PoseTuneParams
Fine-tuning parameters
Inherited from
Methods
dispose()
dispose():
void
Dispose video plugin
Returns
void
Inherited from
estimateBones()
protectedestimateBones(pose,spineCurve,skeletonSizes):object
Estimate bone positions and orientations
Using detected keypoints approximates 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 using kinematic rules and relative positions of adjacent keypoints. Method returns bone position and orientation in global world frame, final relative transformations are found traversing skeleton hierarchy and accumulating transforms of parents.
Parameters
• pose: PosePoints
Pose keypoints
• spineCurve: SpineCurve
Reference shape of spine
• skeletonSizes: SkeletonSizes
Reference sizes of skeleton
Returns
object
Bone transformations
armL
armL:
BoneTransform=armL.arm
armMidL
armMidL:
BoneTransform=armL.armMid
armMidR
armMidR:
BoneTransform=armR.armMid
armR
armR:
BoneTransform=armR.arm
footL
footL:
BoneTransform=legL.foot
footR
footR:
BoneTransform=legR.foot
forearmL
forearmL:
BoneTransform=armL.forearm
forearmMidL
forearmMidL:
BoneTransform=armL.forearmMid
forearmMidR
forearmMidR:
BoneTransform=armR.forearmMid
forearmR
forearmR:
BoneTransform=armR.forearm
handL
handL:
BoneTransform=armL.hand
handR
handR:
BoneTransform=armR.hand
head
head:
BoneTransform
legL
legL:
BoneTransform=legL.leg
legR
legR:
BoneTransform=legR.leg
neck
neck:
BoneTransform
neck1
neck1:
BoneTransform
pelvis
pelvis:
BoneTransform
root
root:
BoneTransform
shoulderL
shoulderL:
BoneTransform=armL.shoulder
shoulderR
shoulderR:
BoneTransform=armR.shoulder
spine
spine:
BoneTransform
spine1
spine1:
BoneTransform
spine2
spine2:
BoneTransform
spine3
spine3:
BoneTransform
uplegL
uplegL:
BoneTransform=legL.upleg
uplegMidL
uplegMidL:
BoneTransform=legL.uplegMid
uplegMidR
uplegMidR:
BoneTransform=legR.uplegMid
uplegR
uplegR:
BoneTransform=legR.upleg
Inherited from
ClothAlignPlugin.estimateBones
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
Extended to parses and caches auxiliary skirt bones. Backward compatible with base skeleton rig, if skirt bones are not parsed controls only the base skeleton.
Parameters
• node?: TransformNode
Scene node to attach
Returns
void
Overrides
setupCamera()
setupCamera(
ratio,angle):void
Set camera parameters
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
Clears internal state and frees all resources allocated in load().
Returns
void
Inherited from
update()
update(
result,stream):Promise<void>
Update skeleton of the scene node
Extends alignment of the base armature with guided control of skirt bones. Skirt bones are driven by leg bones but has additional kinematic constrains to mimic deformation of a fabric more naturally.
Parameters
• result: PoseResult
Pose estimation results
• stream: HTMLCanvasElement
Captured video frame
Returns
Promise<void>
Promise resolving when update is finished
Overrides
updateArm()
protectedupdateArm(bones,points):void
Update arm rig (see update)
Parameters
• bones
Arm bones and transforms
• bones.arm
• bones.arm.bone: TransformNode
• bones.arm.transform: BoneTransform
• bones.armMid
• bones.armMid.bone: TransformNode
• bones.armMid.transform: BoneTransform
• bones.forearm
• bones.forearm.bone: TransformNode
• bones.forearm.transform: BoneTransform
• bones.forearmMid
• bones.forearmMid.bone: TransformNode
• bones.forearmMid.transform: BoneTransform
• bones.hand
• bones.hand.bone: TransformNode
• bones.hand.transform: BoneTransform
• points
Arm keypoints
• points.elbow: PosePoint
• points.shoulder: PosePoint
Returns
void
Inherited from
updateLeg()
protectedupdateLeg(bones,points):void
Update leg rig (see update)
Parameters
• bones
Leg bones and transforms
• bones.foot
• bones.foot.bone: TransformNode
• bones.foot.transform: BoneTransform
• bones.leg
• bones.leg.bone: TransformNode
• bones.leg.transform: BoneTransform
• bones.upleg
• bones.upleg.bone: TransformNode
• bones.upleg.transform: BoneTransform
• bones.uplegMid
• bones.uplegMid.bone: TransformNode
• bones.uplegMid.transform: BoneTransform
• points
Leg keypoints
• points.hip: PosePoint
• points.knee: PosePoint
Returns
void
Inherited from
updateSpine()
protectedupdateSpine(transforms,bones):void
Update spine rig (see update)
Parameters
• transforms
Estimated transformations
• transforms.armL: BoneTransform = armL.arm
• transforms.armMidL: BoneTransform = armL.armMid
• transforms.armMidR: BoneTransform = armR.armMid
• transforms.armR: BoneTransform = armR.arm
• transforms.footL: BoneTransform = legL.foot
• transforms.footR: BoneTransform = legR.foot
• transforms.forearmL: BoneTransform = armL.forearm
• transforms.forearmMidL: BoneTransform = armL.forearmMid
• transforms.forearmMidR: BoneTransform = armR.forearmMid
• transforms.forearmR: BoneTransform = armR.forearm
• transforms.handL: BoneTransform = armL.hand
• transforms.handR: BoneTransform = armR.hand
• transforms.head: BoneTransform = ...
• transforms.legL: BoneTransform = legL.leg
• transforms.legR: BoneTransform = legR.leg
• transforms.neck: BoneTransform = ...
• transforms.neck1: BoneTransform = ...
• transforms.pelvis: BoneTransform = ...
• transforms.root: BoneTransform = ...
• transforms.shoulderL: BoneTransform = armL.shoulder
• transforms.shoulderR: BoneTransform = armR.shoulder
• transforms.spine: BoneTransform = ...
• transforms.spine1: BoneTransform = ...
• transforms.spine2: BoneTransform = ...
• transforms.spine3: BoneTransform = ...
• transforms.uplegL: BoneTransform = legL.upleg
• transforms.uplegMidL: BoneTransform = legL.uplegMid
• transforms.uplegMidR: BoneTransform = legR.uplegMid
• transforms.uplegR: BoneTransform = legR.upleg
• bones: SkeletonNodes
Spine bones
Returns
void