UxrGrabManager.GetClosestGrabbableObject Method (UxrAvatar, UxrHandSide, UxrGrabbableObject, Int32, IEnumerable(UxrGrabbableObject))

Gets the closest grabbable object that can be grabbed by an UxrAvatar using the given hand.

Namespace: UltimateXR.Manipulation
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

C#

public bool GetClosestGrabbableObject(
	UxrAvatar avatar,
	UxrHandSide handSide,
	out UxrGrabbableObject grabbableObject,
	out int grabPoint,
	IEnumerable<UxrGrabbableObject> candidates = null
)

Parameters

avatar

Type: UltimateXR.Avatar.UxrAvatar
Avatar to check

handSide

Type: UltimateXR.Core.UxrHandSide
Whether to check the left hand or right hand

grabbableObject

Type: UltimateXR.Manipulation.UxrGrabbableObject
Returns the closest grabbable object or null if none was found

grabPoint

Type: System.Int32
Returns the grab point that can be grabbed

candidates (Optional)

Type: System.Collections.Generic.IEnumerable(UxrGrabbableObject)
List of grabbable objects to process or null to process all current enabled grabbable objects

Return Value

Type: Boolean
Whether a grabbable object was found

See Also

Reference

UxrGrabManager Class
GetClosestGrabbableObject Overload
UltimateXR.Manipulation Namespace