PokeInteractor Class

This point is specifically on the PokeInteractable.SurfacePatch itself (as opposed to the ISurfacePatch.BackingSurface). This point is primarily used in visualizations, for example to display a highlight which "follows" the tip of a poking finger across the surface of a pokable button.

Because this point is on the ISurfacePatch.BackingSurface, it is sometimes but not always different from ClosestPoint. The distance between these two points can be used for visualization purposes (to control the intensity or direction of a highlight), for cancellation purposes, etc.

Conceptually, this can be thought of as a sphere which follows the fingertip of a tracked hand, centering itself beneath the fingernail.

Note: while the set for this property is public, it should be considered an internal API; manually overriding the value of this from outside poke interaction logic is not supported. Because PokeInteractables typically have no physical representation, it is common for users to unintentionally poke through them because there is nothing to physically stop the user's hand. Handling this gracefully is a large part of the value PokeInteractor provides, one of the most fundamental pieces of which is determining whether or not it has happened. This property specifies that.

Conceptually, this can be thought of as half the width of a fingertip, from the center of the fingernail to the edge of the finger.

IsPassedSurface is a nuanced value with behavior affected and controlled by many circumstances and settings (see PokeInteractable.RecoilAssistConfig or the poke interaction documentation for details), and its changes do not always map to readily-observable values in obvious ways. This behavior is the result of intentional design choices, but it can disrupt what might otherwise seem like safe assumptions about the connection between two states: for example, there are some circumstances where IsPassedSurface can become false while Origin is still past the surface of the interactable. Thus, when implementing behavior that depends upon multiple seemingly related happenstances (such as IsPassedSurface becoming true and IInteractorView.State becoming InteractorState.Select), you should always check all relevant conditions even if they are always expected to co-occur.

Articulated buttons, such as the "big red button" or the keys on a physical keyboard, translate in space when they are interacted with. PokeInteractables which simulate this behavior also simulate this translation, causing the conceptual surface of the button (though not necessarily the data in its PokeInteractable.SurfacePatch) to move as well. Certain poke interaction calculations, such as whether or not a nearby interactor can hover an articulated button which is already being pushed, can be impacted this conceptual translation, so this method is used to retrieve that information for those calculations.

Always positive. This simply wraps SurfaceUtils.ComputeDepth(ISurfacePatch, Vector3, float), which should simply be invoked directly in new code.

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

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

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

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

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

Sets a time provider for a dynamically instantiated PokeInteractor. This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.