Class ConstrainedMoveProvider
Base class for a locomotion provider that allows for constrained movement with a CharacterController.
Inheritance
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.Locomotion.Movement
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public abstract class ConstrainedMoveProvider : LocomotionProviderProperties
enableFreeXMovement
Controls whether to enable unconstrained movement along the x-axis.
Declaration
public bool enableFreeXMovement { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
enableFreeYMovement
Controls whether to enable unconstrained movement along the y-axis.
Declaration
public bool enableFreeYMovement { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
enableFreeZMovement
Controls whether to enable unconstrained movement along the z-axis.
Declaration
public bool enableFreeZMovement { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
gravityProvider
The gravity provider that applies gravity. When this reference is not set, gravity will be computed and applied by this component when moving the rig. If one is not provided, this provider will attempt to locate one at startup.
Declaration
public GravityProvider gravityProvider { get; set; }Property Value
| Type | Description |
|---|---|
| GravityProvider |
See Also
transformation
The transformation that is used by this component to apply translation movement.
Declaration
public XROriginMovement transformation { get; set; }Property Value
| Type | Description |
|---|---|
| XROriginMovement |
See Also
Methods
Awake()
See MonoBehaviour.
Declaration
protected override void Awake()Overrides
See Also
ComputeDesiredMove(out bool)
Determines how much to move the rig.
Declaration
protected abstract Vector3 ComputeDesiredMove(out bool attemptingMove)Parameters
| Type | Name | Description |
|---|---|---|
| bool | attemptingMove | Whether the provider is attempting to move. |
Returns
| Type | Description |
|---|---|
| Vector3 | Returns the translation amount in world space to move the rig. |
See Also
MoveRig(Vector3)
Creates a locomotion event to move the rig by translationInWorldSpace,
and optionally restricts movement along each axis and applies gravity.
Declaration
protected virtual void MoveRig(Vector3 translationInWorldSpace)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | translationInWorldSpace | The translation amount in world space to move the rig (before restricting movement along each axis and applying gravity). |
See Also
OnEnable()
See MonoBehaviour.
Declaration
protected override void OnEnable()Overrides
See Also
Start()
See MonoBehaviour.
Declaration
protected void Start()See Also
Update()
See MonoBehaviour.
Declaration
protected void Update()