Interface IProvidesControlSpatialHinting
Provides the ability to control spatial-hinting visuals.
Spatial-Hinting visuals are displayed when performing a spatial-input action, such as spatial-scrolling These visual elements assist the user in seeing which spatial direction(s) will reveal/allow additional spatial interaction(s).
Namespace: Unity.Labs.EditorXR.Interfaces
Syntax
public interface IProvidesControlSpatialHinting : IFunctionalityProviderMethods
PulseSpatialHintScrollArrows()
Visually pulse the spatial-scroll arrows; the arrows shown when performing a spatial scroll
Declaration
void PulseSpatialHintScrollArrows()SetSpatialHintContainerRotation(Quaternion)
Set the rotation of the spatial hint visuals container game object
Declaration
void SetSpatialHintContainerRotation(Quaternion rotation)Parameters
| Type | Name | Description |
|---|---|---|
| Quaternion | rotation | The rotation to set on the spatial visuals |
SetSpatialHintControlNode(Node)
Set reference to the object, RayOrigin, controlling the Spatial Hint visuals Each control-object has it's spatial scrolling processed independently
Declaration
void SetSpatialHintControlNode(Node controlNode)Parameters
| Type | Name | Description |
|---|---|---|
| Node | controlNode | Node on which spatial scrolling will be processed independently |
SetSpatialHintDragThresholdTriggerPosition(Vector3)
Set the magnitude at which the user will trigger spatial scrolling
Declaration
void SetSpatialHintDragThresholdTriggerPosition(Vector3 position)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | position | The position, whose magnitude from the origin will be used to detect an initiation of spatial scrolling |
SetSpatialHintLookAtRotation(Vector3)
Set the LookAt target
Declaration
void SetSpatialHintLookAtRotation(Vector3 position)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | position | The position the visuals should look at |
SetSpatialHintPosition(Vector3)
Set the position of the spatial hint visuals
Declaration
void SetSpatialHintPosition(Vector3 position)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | position | The position at which the spatial hint visuals should be displayed |
SetSpatialHintShowHideRotationTarget(Vector3)
Sets the target for the spatial hint visuals to look at while performing an animated show or hide
Declaration
void SetSpatialHintShowHideRotationTarget(Vector3 target)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | target | The position to target |
SetSpatialHintState(SpatialHintState)
Set the spatial hint state
Declaration
void SetSpatialHintState(SpatialHintState state)Parameters
| Type | Name | Description |
|---|---|---|
| SpatialHintState | state | SpatialHintState to set |