autohandmodel - eisclimber/ExPresS-XR GitHub Wiki

AutoHandModel

Class in ExPresSXR.Rig

Inherits from UnityEngine.MonoBehaviour

Summary

The Auto Hand Model detects and displays the currently used controller as well as providing an optional animated hand model. It is used to represent the hand/controller of the XR Rig.

There are in total four versions, two for for the for each hand, one having collisions and one doesn't.

public class AutoHandModel : MonoBehaviour

Fields

Name Description
_controllerCharacteristics Characteristics of the controller to search for, which is used to get the correct controller for the correct hand.
_controllerModels A list of models from which the correct model for the used controller when is chosen HandModelMode is set to Controller or Both.
If no model was found for the controller a generic model will be shown.
_handModel The model that is displayed and animated when HandModelMode is set to Hand or Both.
customModel A custom model that is shown when HandModelMode is set to Custom.
OnModelsLoaded Emitted when the auto hand models were loaded, meaning a controller was detected.

Methods

Name Description
SetHandPointing(bool) Sets the hand pointing pose enabled/disabled, if possible.

Properties

Name Description
CollisionsCurrentlyEnabled Temporary en-/disables collisions if _modelCollisionsEnabled is true. Will be controlled by the HandController.
To disable collisions completely use _modelCollisionsEnabled instead.
CurrentAttach The current attach transform provided by the current model.
HandModelMode Determines which model is displayed.
ModelCollisionsEnabled Completely disables collisions with the hand/controller models during runtime.
Overwrites the functionality of _collisionsEnabled.
⚠️ **GitHub.com Fallback** ⚠️