Component:FullBodyCalibrator: Difference between revisions

From Resonite Wiki
← Older editNewer edit →
Visual
add info
Automated: update Fields, SyncDelegates
Line 8: Line 8:
{{Table ComponentFields
{{Table ComponentFields
|TargetUser|User| The user we are doing full body tracking for.
|TargetUser|User| The user we are doing full body tracking for.
|UseSymmetryForTrackers|Bool| Whether changes to sided points (left versus right) mirror onto the other side for the User Calibration Reference.  
|UseSymmetryForTrackers|Bool| Whether changes to sided points (left versus right) mirror onto the other side for the User Calibration Reference.
|UseSymmetryForAvatar|Bool| Whether changes to sided points (left versus right) mirror onto the other side for the Avatar Calibration.
|UseSymmetryForAvatar|Bool| Whether changes to sided points (left versus right) mirror onto the other side for the Avatar Calibration.
|ShowBodyOverlay|Bool| Whether to show the User Calibration Reference.
|ShowBodyOverlay|Bool| Whether to show the User Calibration Reference.
Line 51: Line 51:
|_trackers|{{RootFieldType|SyncList`1|[[#Tracker|Tracker]]}}|TypeAdv42=true| A list of trackers registered to the calibrating user.
|_trackers|{{RootFieldType|SyncList`1|[[#Tracker|Tracker]]}}|TypeAdv42=true| A list of trackers registered to the calibrating user.
|_visualizationRoot|Slot| The slot used to store the visuals on the Calibrator platform.
|_visualizationRoot|Slot| The slot used to store the visuals on the Calibrator platform.
|_bodyNodeMaterial|'''[[Component:FresnelMaterial|FresnelMaterial]]'''|TypeAdv44=true| The material being used for the visual of the User Calibration Reference.
|_bodyNodeMaterial|'''[[FresnelMaterial|FresnelMaterial]]'''|TypeAdv44=true| The material being used for the visual of the User Calibration Reference.
|_calibrationReferenceMaterial|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv45=true| The material being used for the visual of the User Calibration Reference.
|_calibrationReferenceMaterial|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv45=true| The material being used for the visual of the User Calibration Reference.
|_leftHandOverrideMaterial|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv46=true| The override material for the left hand visual.
|_leftHandOverrideMaterial|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv46=true| The override material for the left hand visual.
Line 59: Line 59:
|_rightHandOverrideFrontColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv50=true| the color field for the front color of <code>_rightHandOverrideMaterial</code>
|_rightHandOverrideFrontColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv50=true| the color field for the front color of <code>_rightHandOverrideMaterial</code>
|_rightHandOverrideBehindColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv51=true| the color field for the behind color of <code>_rightHandOverrideMaterial</code>
|_rightHandOverrideBehindColor|{{RootFieldType|FieldDrive`1|[[Type:ColorX|ColorX]]}}|TypeAdv51=true| the color field for the behind color of <code>_rightHandOverrideMaterial</code>
|_patternTex|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv52=true| The pattern texture used for the holographic visual for the User Calibration Reference.  
|_patternTex|'''[[Component:StaticTexture2D|StaticTexture2D]]'''|TypeAdv52=true| The pattern texture used for the holographic visual for the User Calibration Reference.
|_title|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv53=true| The title visual of the calibrator pedestal.  
|_title|'''[[Component:TextRenderer|TextRenderer]]'''|TypeAdv53=true| The title visual of the calibrator pedestal.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|OnRotateLeft(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData&gt; -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnRotateRight(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData&gt; -> [[Type:Void|Void]] : HIDDEN METHOD|
|OnGrabbableToggle(IButton, ButtonEventData)|[[Type:Delegate|Delegate]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData&gt; -> [[Type:Void|Void]] : HIDDEN METHOD|
}}
}}


Revision as of 22:29, 16 March 2025

Component image 
Full Body Calibrator component as seen in the Scene Inspector

See Full Body Tracking.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
TargetUser User The user we are doing full body tracking for.
UseSymmetryForTrackers Bool Whether changes to sided points (left versus right) mirror onto the other side for the User Calibration Reference.
UseSymmetryForAvatar Bool Whether changes to sided points (left versus right) mirror onto the other side for the Avatar Calibration.
ShowBodyOverlay Bool Whether to show the User Calibration Reference.
ShowAvatarOverlay Bool Whether to show the avatar reference.
HeightCompensation Float The user height field.
AvatarHeightCompensation Float How much to multiply the avatar size relative to the User Calibration Reference.
_calibratingPose Bool Whether we are Calibrating the pose or not.
_spaceOffset Float3 How much to offset play space.
_grabbable Grabbable The grabbable Component of the base plate.
_headReference Slot The reference visual for the head.
_leftHandReference Slot The reference visual for the left hand.
_rightHandReference Slot The reference visual for the right hand.
_hipsSource TrackedDevicePositioner The source of the hips data.
_chestSource TrackedDevicePositioner The source of the chest data.
_leftFootSource TrackedDevicePositioner The source of the left foot data.
_rightFootSource TrackedDevicePositioner The source of the right foot data.
_leftElbowSource TrackedDevicePositioner The source of the left elbow data.
_rightElbowSource TrackedDevicePositioner The source of the right elbow data.
_leftKneeSource TrackedDevicePositioner The source of the left knee data.
_rightKneeSource TrackedDevicePositioner The source of the right knee data.
_dialog FullBodyCalibratorDialog The dialog used to control this full body Calibration interface.
_platformBody direct BodyReference The reference on the platform visual.
_userBody direct BodyReference The reference on the user in world space.
_customAvatar direct BodyReference The custom avatar reference on the platform visual.
_leftHandOverride Slot The override slot of the left hand.
_rightHandOverride Slot The override slot of the right hand.
_targetCustomAvatar VRIKAvatar The custom avatar to edit when calibrating the avatar.
_avatarHipsOffset Slot The "Target" slot of the avatar hips.
_avatarLeftFootOffset Slot The "Target" slot of the avatar left foot.
_avatarRightFootOffset Slot The "Target" slot of the avatar right foot.
_avatarLeftKneeDefaultOffset Slot The "Target" slot of the avatar left knee.
_avatarRightKneeDefaultOffset Slot The "Target" slot of the avatar right knee.
_avatarHipHandle Slot The handle object being used to adjust the avatar's hips.
_avatarLeftFootHandle Slot The handle object being used to adjust the avatar's left foot.
_avatarRightFootHandle Slot The handle object being used to adjust the avatar's right foot.
_avatarLeftKneeHandle Slot The handle object being used to adjust the avatar's left knee.
_avatarRightKneeHandle Slot The handle object being used to adjust the avatar's right knee.
_avatarLeftKneeOffset direct FieldHook`1<Float3> The field to hook and change for the left knee offset.
_avatarRightKneeOffset direct FieldHook`1<Float3> The field to hook and change for the right knee offset.
_platformBodyMaterialSets list of MaterialSet The set of material switchers used to change the platform Body look.
_ground Slot The Calibrator platform root slot.
_trackers list of Tracker A list of trackers registered to the calibrating user.
_visualizationRoot Slot The slot used to store the visuals on the Calibrator platform.
_bodyNodeMaterial FresnelMaterial The material being used for the visual of the User Calibration Reference.
_calibrationReferenceMaterial OverlayFresnelMaterial The material being used for the visual of the User Calibration Reference.
_leftHandOverrideMaterial OverlayFresnelMaterial The override material for the left hand visual.
_rightHandOverrideMaterial OverlayFresnelMaterial The override material for the right hand visual.
_leftHandOverrideFrontColor field drive of ColorX the color field for the front color of _leftHandOverrideMaterial
_leftHandOverrideBehindColor field drive of ColorX the color field for the behind color of _leftHandOverrideMaterial
_rightHandOverrideFrontColor field drive of ColorX the color field for the front color of _rightHandOverrideMaterial
_rightHandOverrideBehindColor field drive of ColorX the color field for the behind color of _rightHandOverrideMaterial
_patternTex StaticTexture2D The pattern texture used for the holographic visual for the User Calibration Reference.
_title TextRenderer The title visual of the calibrator pedestal.

Sync Delegates

Lua error in mw.text.lua at line 25: bad argument #1 to 'match' (string expected, got nil).
Triggers
Method Name Method type and Arguments. Is the method hidden? Description

BodyReference

Fields
Name Type Description
_vrIkAvatar VRIKAvatar The VRIK avatar this is getting info from.
_head IAvatarObject The head Avatar object.
_hips IAvatarObject The hips Avatar object.
_chest IAvatarObject The chest Avatar object.
_leftHand IAvatarObject The left hand Avatar object.
_rightHand IAvatarObject The right hand Avatar object.
_leftElbow IAvatarObject The left elbow Avatar object.
_rightElbow IAvatarObject The right elbow Avatar object.
_leftFoot IAvatarObject The left foot Avatar object.
_rightFoot IAvatarObject The right foot Avatar object.
_leftKnee IAvatarObject The left knee Avatar object.
_rightKnee IAvatarObject The right knee Avatar object.
_headPos field drive of Float3 The field to drive to create the position of the head slot.
_headRot field drive of FloatQ The field to drive to create the rotation of the head slot.
_leftHandPos field drive of Float3 The field to drive to create the position of the left hand slot.
_leftHandRot field drive of FloatQ The field to drive to create the rotation of the left hand slot.
_rightHandPos field drive of Float3 The field to drive to create the position of the right hand slot.
_rightHandRot field drive of FloatQ The field to drive to create the rotation of the right hand slot.
_hipsPos field drive of Float3 The field to drive to create the position of the hips slot.
_hipsRot field drive of FloatQ The field to drive to create the rotation of the hips slot.
_chestPos field drive of Float3 The field to drive to create the position of the chest slot.
_chestRot field drive of FloatQ The field to drive to create the rotation of the chest slot.
_leftFootPos field drive of Float3 The field to drive to create the position of the left foot slot.
_leftFootRot field drive of FloatQ The field to drive to create the rotation of the left foot slot.
_rightFootPos field drive of Float3 The field to drive to create the position of the right foot slot.
_rightFootRot field drive of FloatQ The field to drive to create the rotation of the right foot slot.
_leftKneePos field drive of Float3 The field to drive to create the position of the left knee slot.
_leftKneeRot field drive of FloatQ The field to drive to create the rotation of the left knee slot.
_rightKneePos field drive of Float3 The field to drive to create the position of the right knee slot.
_rightKneeRot field drive of FloatQ The field to drive to create the rotation of the right knee slot.
_leftElbowPos field drive of Float3 The field to drive to create the position of the left elbow slot.
_leftElbowRot field drive of FloatQ The field to drive to create the rotation of the left elbow slot.
_rightElbowPos field drive of Float3 The field to drive to create the position of the right elbow slot.
_rightElbowRot field drive of FloatQ The field to drive to create the rotation of the right elbow slot.
_ikWeight field drive of Float The Ik weight field of the VRIK.

Tracker

Fields
Name Type Description
VisualRoot Slot The root of the tracker visual.
TrackingReference Slot The slot being used as a tracker position reference.
TrackedDevice TrackedDevicePositioner The tracker this tracker visual represents.
Material OverlayFresnelMaterial The tracker visual material.
Label TextRenderer The tracker label visual.
CalibrationReference Slot The Calibration Reference slot for this tracker.
_position field drive of Float3 The position field of the tracker.
_rotation field drive of FloatQ The rotation field of the tracker.
_labelPosition field drive of Float3 The position field of the tracker label.
_labelRotation field drive of FloatQ The Rotation field of the tracker label.

Usage

See Full Body Tracking.

Examples

See Full Body Tracking.

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:FullBodyCalibrator&oldid=97349"