API reference
LocomotionGate Class
Extends MonoBehaviour
This Gate reads the IHand orientation towards the shoulder and decides if it should be in Teleport mode or Turning mode.
It enables/disables said modes based on some InputIActiveStates (EnableShape and DisableShape). It outputs it result into two IActiveStates (for Teleport and Turn)
Member Enumerations
Enumeration LocomotionMode
Set of locomotion modes supported by this component - see ActiveMode.
None | No description available |
Teleport | No description available |
Turn | No description available |
Properties
IHand Hand[Get]
The IHand that provides orientation data to this component.
IActiveState EnableShape[Get]
IActiveState DisableShape[Get]
LocomotionMode ActiveMode[Get]
The current active LocomotionMode determined by the shape and orientation of the assigned IHand.
float CurrentAngle[Get]
The current hand angle computed by this component, using the orientation of the Hand.
Vector3 WristDirection[Get]
The wrist direction of the Hand.
Pose StabilizationPose[Get]
A pose used for hand stabilization, derived from the shoulder-to-hand orientation.
Action< LocomotionModeEventArgs > WhenActiveModeChanged
This event is raised whenever the active locomotion mode is changed (see ActiveMode).
Protected Fields
bool _started[Get]
Protected Functions
virtual void Awake ( )
virtual void Start ( )
virtual void OnEnable ( )
virtual void OnDisable ( )
Member Functions
void Disable ( )
Disables the Gate, forcing the user to perform the enable shape
void Cancel ( )
Disables the Gate, forcing the user to perform the disable shape and then the enable shape
void InjectAllLocomotionGate
( IHand hand,
Transform shoulder,
IActiveState enableShape,
IActiveState disableShape,
VirtualActiveState turningState,
VirtualActiveState teleportState,
GateSection [] gateSections )
Injects all required dependencies for a dynamically instantiated LocomotionGate.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectHand
( IHand hand )
Sets the underlying IHand for a dynamically instantiated LocomotionGate.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectShoulder
( Transform shoulder )
Sets the underlying shoulder transform for a dynamically instantiated LocomotionGate.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectEnableShape
( IActiveState enableShape )
Sets the underlying IActiveState enable shape for a dynamically instantiated LocomotionGate.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectDisableShape
( IActiveState disableShape )
Sets the underlying IActiveState disable shape for a dynamically instantiated LocomotionGate.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectTurningState
( VirtualActiveState turningState )
Sets the underlying VirtualActiveState for a dynamically instantiated LocomotionGate representing the turning state.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectTeleportState
( VirtualActiveState teleportState )
Sets the underlying VirtualActiveState for a dynamically instantiated LocomotionGate representing the teleport state.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectGateSections
( GateSection [] gateSections )
Sets the underlying GateSection set for a dynamically instantiated LocomotionGate.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta