Meta Developers

RayInteractor Class

Extends PointerInteractor< RayInteractor, RayInteractable >

Defines a raycast interaction suitable to use at both short and long ranges.

The origin and direction of the ray can be set by anything, but are typically associated with the motion of a Input.IController or Input.IHand. The interactable type for this interactor is RayInteractable.

Properties

Vector3 Origin[Get]

The position, in world space, from which the interactor's raycast will begin.

This position is derived from the Transform provided as _rayOrigin, which can be set either in the Unity Editor or programmatically using InjectRayOrigin(Transform).

Quaternion Rotation[Get]

The rotation, in world space, of the interactor's raycast.

This rotation is derived from the Transform provided as _rayOrigin, which can be set either in the Unity Editor or programmatically using InjectRayOrigin(Transform).

Vector3 Forward[Get]

The forward direction, in world space, of the interactor's raycast.

This is derived from the Transform provided as _rayOrigin, which can be set either in the Unity Editor or programmatically using InjectRayOrigin(Transform).

Vector3 End[Get]

The end position, in world space, of the interactor's raycast.

This is discovered as part of the raycast process and will lie on the hit RayInteractable if one was hit, or at <see cref="Origin"/> + <see cref="Forward"/> * <see cref="MaxRayLength"/> if nothing was hit.

float MaxRayLength[Get]

The maximum allowable length of the ray, in meters in world space.

RayInteractables intersected by the ray at points more distant from the Origin than this will be ignored.

SurfaceHit? CollisionInfo[Get]

If the most recent raycast hit a RayInteractable, information about that hit will be exposed here.

Otherwise, this property will be null.

Ray Ray[Get]

The ray which is used when raycasting for interaction.

This is derived from Origin and Forward.

override object CandidateProperties[Get]

Implementation of Interactor<TInteractor, TInteractable>.CandidateProperties; for details, please refer to the related documentation provided for that property.

Protected Functions

override void Awake ( )

override void Start ( )

override void DoPreprocess ( )

override RayInteractable ComputeCandidate ( )

override int ComputeCandidateTiebreaker

( RayInteractable a,

RayInteractable b )

override void InteractableSelected

( RayInteractable interactable )

override void InteractableUnselected

( RayInteractable interactable )

override void DoSelectUpdate ( )

virtual override Pose ComputePointerPose ( )

Member Functions

void InjectAllRayInteractor

( ISelector selector,

Transform rayOrigin )

Injects all required dependencies for a dynamically instantiated RayInteractor; effectively wraps InjectSelector(ISelector) and InjectRayOrigin(Transform).

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

void InjectSelector

( ISelector selector )

Sets an ISelector for a dynamically instantiated RayInteractor.

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

void InjectRayOrigin

( Transform rayOrigin )

Sets a Unity Transform representing the raycast origin and direction for a dynamically instantiated RayInteractor.

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

void InjectOptionalEqualDistanceThreshold

( float equalDistanceThreshold )

Sets the equal distance threshold for a dynamically instantiated RayInteractor.

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