Class UsesControlSpatialHintingMethods
Namespace: Unity.Labs.EditorXR.Interfaces
Syntax
public static class UsesControlSpatialHintingMethodsMethods
PulseSpatialHintScrollArrows(IUsesControlSpatialHinting)
Visually pulse the spatial-scroll arrows; the arrows shown when performing a spatial scroll
Declaration
public static void PulseSpatialHintScrollArrows(this IUsesControlSpatialHinting user)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
SetSpatialHintContainerRotation(IUsesControlSpatialHinting, Quaternion)
Set the rotation of the spatial hint visuals container game object
Declaration
public static void SetSpatialHintContainerRotation(this IUsesControlSpatialHinting user, Quaternion rotation)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
| Quaternion | rotation | The rotation to set on the spatial visuals |
SetSpatialHintControlNode(IUsesControlSpatialHinting, Node)
Set reference to the object, RayOrigin, controlling the Spatial Hint visuals Each control-object has it's spatial scrolling processed independently
Declaration
public static void SetSpatialHintControlNode(this IUsesControlSpatialHinting user, Node controlNode)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
| Node | controlNode | Node on which spatial scrolling will be processed independently |
SetSpatialHintDragThresholdTriggerPosition(IUsesControlSpatialHinting, Vector3)
Set the magnitude at which the user will trigger spatial scrolling
Declaration
public static void SetSpatialHintDragThresholdTriggerPosition(this IUsesControlSpatialHinting user, Vector3 position)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
| Vector3 | position | The position, whose magnitude from the origin will be used to detect an initiation of spatial scrolling |
SetSpatialHintLookAtRotation(IUsesControlSpatialHinting, Vector3)
Set the LookAt target
Declaration
public static void SetSpatialHintLookAtRotation(this IUsesControlSpatialHinting user, Vector3 position)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
| Vector3 | position | The position the visuals should look at |
SetSpatialHintPosition(IUsesControlSpatialHinting, Vector3)
Set the position of the spatial hint visuals
Declaration
public static void SetSpatialHintPosition(this IUsesControlSpatialHinting user, Vector3 position)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
| Vector3 | position | The position at which the spatial hint visuals should be displayed |
SetSpatialHintShowHideRotationTarget(IUsesControlSpatialHinting, Vector3)
Sets the target for the spatial hint visuals to look at while performing an animated show or hide
Declaration
public static void SetSpatialHintShowHideRotationTarget(this IUsesControlSpatialHinting user, Vector3 target)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
| Vector3 | target | The position to target |
SetSpatialHintState(IUsesControlSpatialHinting, SpatialHintState)
Set the spatial hint state
Declaration
public static void SetSpatialHintState(this IUsesControlSpatialHinting user, SpatialHintState state)Parameters
| Type | Name | Description |
|---|---|---|
| IUsesControlSpatialHinting | user | The functionality user |
| SpatialHintState | state | SpatialHintState to set |