AvatarReady
Loading...
Searching...
No Matches
Inria.Avatar.AvatarReady.CalibrationTechnique Class Referenceabstract

Main class to handle avatar calibration. The Awake method can be used to query data from the avatar in T-Pose. More...

Inheritance diagram for Inria.Avatar.AvatarReady.CalibrationTechnique:
Inria.Avatar.AvatarReady.HeightAndArmspanRatioCalibration

Public Member Functions

virtual IEnumerator UpdateUserProfile (AvatarReady avatarReady, CalibrationProfile calibrationProfile)
 Method that initializes or updates a calibration profile.
 
virtual IEnumerator CalibrateAvatar (AvatarReady avatarReady, CalibrationProfile calibrationProfile)
 Method that calibrates an avatar based on the calibration profile.
 
virtual void ApplySettings (AvatarReady avatarReady)
 Method that allows to customize pre-defined parameters linked to animation providers or avatars. This method is called automatically by AvatarReady.
 
virtual void ResetSettings (AvatarReady avatarReady)
 Method that reverts the pre-defined parameters defined by ApplySetting method. This method is called automatically by AvatarReady.
 
virtual float GetData (AvatarReady avatarReady, string dataKey)
 Method used to query the data required by the user profile.
 

Detailed Description

Main class to handle avatar calibration. The Awake method can be used to query data from the avatar in T-Pose.

Member Function Documentation

◆ UpdateUserProfile()

virtual IEnumerator Inria.Avatar.AvatarReady.CalibrationTechnique.UpdateUserProfile ( AvatarReady avatarReady,
CalibrationProfile calibrationProfile )
inlinevirtual

Method that initializes or updates a calibration profile.

Parameters
avatarReadyPointer to avatar ready component.
calibrationProfileNon-null CalibrationProfile
Returns

Reimplemented in Inria.Avatar.AvatarReady.HeightAndArmspanRatioCalibration.

◆ CalibrateAvatar()

virtual IEnumerator Inria.Avatar.AvatarReady.CalibrationTechnique.CalibrateAvatar ( AvatarReady avatarReady,
CalibrationProfile calibrationProfile )
inlinevirtual

Method that calibrates an avatar based on the calibration profile.

Parameters
avatarReadyPointer to avatar ready component.
calibrationProfileValid calibration profile.

Reimplemented in Inria.Avatar.AvatarReady.HeightAndArmspanRatioCalibration.

◆ ApplySettings()

virtual void Inria.Avatar.AvatarReady.CalibrationTechnique.ApplySettings ( AvatarReady avatarReady)
inlinevirtual

Method that allows to customize pre-defined parameters linked to animation providers or avatars. This method is called automatically by AvatarReady.

Parameters
avatarReadyPointer to avatar ready component.

◆ ResetSettings()

virtual void Inria.Avatar.AvatarReady.CalibrationTechnique.ResetSettings ( AvatarReady avatarReady)
inlinevirtual

Method that reverts the pre-defined parameters defined by ApplySetting method. This method is called automatically by AvatarReady.

Parameters
avatarReadyPointer to avatar ready component.

◆ GetData()

virtual float Inria.Avatar.AvatarReady.CalibrationTechnique.GetData ( AvatarReady avatarReady,
string dataKey )
inlinevirtual

Method used to query the data required by the user profile.

Parameters
avatarReadyPointer to avatar ready component.
dataKeyKey value of the parameter requested
Returns

Reimplemented in Inria.Avatar.AvatarReady.HeightAndArmspanRatioCalibration.


The documentation for this class was generated from the following file: