Defines a near-poke interaction target that is driven by a near-distance proximity computation and a raycast between the position recorded across two frames against a target surface.

The interactor type for this interactable is PokeInteractor.

Properties

ISurfacePatch SurfacePatch[Get]

An ISurfacePatch, which provides both the backing surface (generally infinite) and pokable area (generally finite) of the interactor.

float EnterHoverNormal[Get]

The distance required for a PokeInteractor to enter hovering, measured along the tangent plane to the surface (in meters).

float EnterHoverTangent[Get]

The distance required for a PokeInteractor to enter hovering, measured along the tangent plane to the surface (in meters).

float ExitHoverNormal[Get]

The distance required for a PokeInteractor to exit hovering, measured along the normal to the surface (in meters).

float ExitHoverTangent[Get]

The distance required for a PokeInteractor to exit hovering, measured along the tangent plane to the surface (in meters).

float CancelSelectNormal[Get]

If greater than zero, the distance required for a selecting PokeInteractor to cancel selection, measured along the negative normal to the surface (in meters).

float CancelSelectTangent[Get]

If greater than zero, the distance required for a selecting PokeInteractor to cancel selection, measured along the tangent plane to the surface (in meters).

float CloseDistanceThreshold[Get]

The threshold below which distances near this surface are treated as equal in depth for the purposes of ranking, in world-space meters.

int TiebreakerScore[Get]

If a PokeInteractor is positioned near multiple interactables such that it is equally interactable with any of them (i.e., the distances to all of them are within CloseDistanceThreshold of each other), the interactable with the largest TiebreakerScore wins and is targeted for interaction.

If there's a tie for largest TiebreakerScore, one of the interactables will be selected arbitrarily.

MinThresholdsConfig MinThresholds[Get]

The MinThresholdsConfig for this interactable instance.

This value is typically set from the Unity Editor, but it can also be set and modified programmatically.

DragThresholdsConfig DragThresholds[Get]

The DragThresholdsConfig for this interactable instance.

This value is typically set from the Unity Editor, but it can also be set and modified programmatically.

PositionPinningConfig PositionPinning[Get]

The PositionPinningConfig for this interactable instance.

This value is typically set from the Unity Editor, but it can also be set and modified programmatically.

RecoilAssistConfig RecoilAssist[Get]

The RecoilAssistConfig for this interactable instance.

This value is typically set from the Unity Editor, but it can also be set and modified programmatically.

Protected Functions

override void Awake ( )

override void Start ( )

Member Functions

bool ClosestSurfacePatchHit

( Vector3 point,

out SurfaceHit hit )

Convenience method wrapping a call to ISurface.ClosestSurfacePoint(in Vector3, out SurfaceHit, float) on the SurfacePatch.

Parameters

point

The point, in world space, for which the nearest point on the surface must be found

hit

The returned hit data in world space if a nearest point could be found, default otherwise

Returns

True if the racyast hit the surface, false otherwise

bool ClosestBackingSurfaceHit

( Vector3 point,

out SurfaceHit hit )

Convenience method wrapping a call to ISurface.ClosestSurfacePoint(in Vector3, out SurfaceHit, float) on the ISurfacePatch.BackingSurface of this interactable's SurfacePatch.

Parameters

point

The point, in world space, for which the nearest point on the surface must be found

hit

The returned hit data in world space if a nearest point could be found, default otherwise

Returns

True if the racyast hit the surface, false otherwise

void InjectAllPokeInteractable

( ISurfacePatch surfacePatch )

Sets all the required values for a PokeInteractable on a dynamically instantiated GameObject.

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

void InjectSurfacePatch

( ISurfacePatch surfacePatch )

Sets a surface patch for a dynamically instantiated GameObject.

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

PokeInteractable Class

Properties

Protected Functions

Member Functions

See Also