Meta Developers

API reference

Select your platform

No SDKs available

No versions available

CanvasGroupAlphaToggle

CanvasSizeConstraint

ColliderSizeConstraint

Debug

ActiveStateDebugTree

ActiveStateDebugTreeUI

ActiveStateDebugVisual

ActiveStateModel

ActiveStateNodeUIHorizontal

ActiveStateNodeUIVertical

FingerFeatureDebugVisual

FingerFeatureSkeletalDebugVisual

HandShapeDebugVisual

HandShapeSkeletalDebugVisual

IActiveStateModel

JointRotationDebugVisual

JointVelocityDebugVisual

TransformFeatureDebugVisual

TransformFeatureVectorDebugParentVisual

TransformFeatureVectorDebugVisual

TransformRecognizerDebugVisual

Fusion

AvatarBehaviourFusion

AvatarSpawnerFusion

CustomMatchmakingFusion

CustomNetworkObjectProvider

FusionBBEvents

FusionNetworkBootstrapper

LipSyncPhotonFix

PlayerNameTagFusion

PlayerNameTagSpawnerFusion

TransferOwnershipFusion

InteractableObjectLabel

Meta

BuildingBlocks

BuildingBlock

ControllerButtonsMapper

ButtonClickAction

InstallationRoutineCheckpoint

PassthroughProjectionSurfaceBuildingBlock

RoomMeshEvent

RunTimeUtils

SharedSpatialAnchorCore

SpatialAnchorCoreBuildingBlock

SpatialAnchorLoaderBuildingBlock

SpatialAnchorLocalStorageManagerBuildingBlock

SpatialAnchorSpawnerBuildingBlock

VariantCheckpoint

EnvironmentDepth

EnvironmentDepthManager

ImmersiveDebugger

InputActions

InputActionDefinition

SampleTelemetryEvents

MoveRelativeToTargetProvider

OVRChromaticAberration

OVRColocationSession

Data

OVRControllerDrivenHandPosesSample

OVRCustomFaceExtensions

OVRCustomSkeleton

OVRDebugHeadController

FaceExpressionsEnumerator

WeightProvider

OVRGLTFAccessor

OVRGLTFAnimatinonNode

OVRGLTFAnimationNodeMorphTargetHandler

OVRHandTrackingWideMotionModeSample

OVRHumanBodyBonesMappingsInterface

OVRInput

HapticsAmplitudeEnvelopeVibration

OVRControllerGamepadPC

OpenVRControllerDetails

GetSceneAnchorPosesJob

GetSpatialAnchorPosesJob

SetLocalSpaceTransformsJob

SetWorldSpaceTransformsJob

PassthroughCapabilities

TransformToUnitySpaceJob

TransformTrianglesJob

OVRMeshRenderer

IOVRMeshRendererDataProvider

MeshRendererData

OVRMixedRealityCaptureTest

OVRNodeStateProperties

OVROverlay

LayerTexture

OVROverlayCanvas

OVROverlayCanvasSettings

OVROverlayMeshGenerator

OVRPassthroughColorLut

OVRPassthroughLayer

OVRPermissionsRequester

RoomLayoutInformation

OVRSceneModelLoader

OVRSceneObjectTransformType

OVRScenePlane

OVRScenePlaneMeshFilter

OVRScenePrefabOverride

OVRSceneRoom

OVRSceneSampleController

OVRSceneVolume

OVRSceneVolumeMeshFilter

OVRScreenFade

OVRSemanticClassification

OVRSemanticLabels

OVRSharable

OVRSimultaneousHandsAndControllersSample

OVRSkeleton

IOVRSkeletonDataProvider

SkeletonPoseData

OVRSkeletonRenderer

IOVRSkeletonRendererDataProvider

OVRSpectatorModeDomeTest

OVRStorable

OVRSystemPerfMetrics

OVRSystemPerfMetricsTcpServer

TrackedKeyboardSetActiveEvent

TrackedKeyboardVisibilityChangedEvent

OVRTrackedKeyboardHands

TrackedKeyboardHandsVisibilityChangedEvent

OVRTrackedKeyboardSampleControls

OVRTracker

Frustum

OVRTriangleMesh

OVRUnityHumanoidSkeletonRetargeter

JointAdjustment

OVRHumanBodyBonesMappings

InteractorRootTransformOverride

WaitUntilKeyboardVisible

OVRVirtualKeyboardInputFieldTextHandler

OVRVirtualKeyboardSampleControls

OVRVirtualKeyboardSampleInputHandler

OVRWaitCursor

Oculus

Interaction

ActiveStateFingerVisual

ActiveStateUnityEventWrapper

AutoMoveTowardsTarget

AutoMoveTowardsTargetProvider

Axis1DFingerUseAPI

Axis1DPrioritySelector

AxisData

Axis1DSwitch

Axis2DActiveState

BecomeChildOfTargetOnStart

BestHoverInteractorGroup

BestSelectInteractorGroup

Body

BoundsExtensions

CandidateComparer

CandidatePositionComparer

CollisionInteractionRegistry

Collisions

ConditionalHideAttribute

ConeUtils

ConicalFrustum

ControllerActiveState

ControllerAxis2D

ControllerOffset

ControllerPointerPose

ControllerRayVisual

ControllerSelector

Cylinder

DPadUnityEventWrapper

InteractorGroupDebugTreeUI

InteractorGroupNodeUI

WaterSprayNozzleTransformer

Deprecated

DeprecatedPrefab

DisableRaycaster

DistanceGrabInteractable

DistanceGrabInteractor

DistanceReticles

DistantInteractionLineRendererVisual

DistantInteractionLineVisual

DistantInteractionPolylineVisual

DistantInteractionTubeVisual

TeleportReticleDrawer

DistantCandidateComputer

DistantPointDetector

DistantPointDetectorFrustums

DotGridProperties

Editor

VerifyScenePackageDependencies

PreprocessBuild

FingerFeatureStateProviderRef

FingerPinchValue

FirstHoverInteractorGroup

FloatConstraint

FollowTarget

FollowTargetProvider

GameObjectActiveState

SphereGrabSurfaceData

PoseMeasureParameters

GrabAPI

ControllerPinchInjector

FingerRawPinchInjector

GrabStrengthIndicator

HandFingerMaskGenerator

HandPokeLimiterVisual

HandPokeOvershootGlow

HandRayInteractorCursorVisual

HandTrackingConfidenceProvider

IndexPinchSafeReleaseSelector

IReadOnlyHandSkeleton

IReadOnlyHandSkeletonJointList

ReadOnlyHandJointPoses

Constants

Controller

ControllerAnimatedHand

ControllerButtonUsageActiveState

ControllerDataAsset

ControllerDataSourceConfig

ControllerHandDataSource

DefaultHandSkeletonProvider

FromHandPrefabDataSource

Hand

HandDataAsset

HandDataSourceConfig

HandFilterParameterBlock

IControllerDataModifier

ICopyFrom

IDataSource

IHand

IHandSkeletonProvider

IHmd

IOneEuroFilter

IReadOnlyHandSkeleton

IReadOnlyHandSkeletonJointList

ITrackingToWorldTransformer

JointRotationHistoryHand

JointsRadiusFeature

LastKnownGoodHand

OneEuroFilter

OneEuroFilterPropertyBlock

ReadOnlyHandJointPoses

ShadowHand

ShadowHandExtensions

SkeletonJointsCache

SyntheticControllerInHand

SyntheticHand

UnityXR

FromOpenXRHandDataSource

OpenXRHandDataAsset

Constants

FromUnityXRHandDataSource

Visuals

ControllerVisual

InspectorButtonAttribute

Interactable

InteractableColorVisual

ColorState

InteractableDebugVisual

InteractableGroup

InteractableGroupView

InteractableRegistry

InteractableSet

Enumerator

InteractableStateChangeArgs

InteractableTriggerBroadcaster

InteractableUnityEventWrapper

Interactor

InteractorActiveState

InteractorDebugVisual

InteractorGroup

InteractorStateChangeArgs

InteractorUnityEventWrapper

JointDeltaProviderRef

AnimatedSnapTurnVisuals

CapsuleLocomotionHandler

ILocomotionEventBroadcaster

ILocomotionEventHandler

LocomotionAxisTurnerInteractable

LocomotionAxisTurnerInteractor

LocomotionComfortVignetteSetting

LocomotionEvent

LocomotionEventsConnection

LocomotionGate

GateSection

LocomotionModeEventArgs

LocomotionGateUnityEventWrapper

LocomotionSeatedSetting

LocomotionTunneling

LocomotionTurnSliderSetting

LocomotionTurnerInteractable

LocomotionTurnerInteractor

LocomotionTurnerInteractorEventsWrapper

LocomotionTurnerInteractorVisual

LocomotorSound

MenuToggler

PlayerLocomotor

SlideLocomotionBroadcaster

StepLocomotionBroadcaster

TeleportArcGravity

TeleportArcVisual

TeleportCandidateComputer

TeleportHit

TeleportInteractable

TeleportInteractor

TeleportProceduralArcVisual

TurnArrowVisuals

TurnLocomotionBroadcaster

TurnerEventBroadcaster

VirtualActiveState

WallPenetrationTunneling

WristAngleActiveState

MAction

MaterialPropertyBlockEditor

MaterialPropertyColor

MaterialPropertyFloat

MaterialPropertyVector

MinMaxPair

MonoBehaviourStartExtensions

MoveAtSourceProvider

MoveFromTarget

MoveFromTargetProvider

MoveRelativeToTarget

MoveTowardsTarget

MoveTowardsTargetProvider

MultiAction

ObjectPull

ObjectPullProvider

OneGrabFreeTransformer

OneGrabPhysicsJointTransformer

OneGrabRotateTransformer

OneGrabRotateConstraints

OneGrabSphereTransformer

OneGrabTranslateTransformer

OneGrabTranslateConstraints

PointableCanvasEventArgs

PointableCanvasMesh

PointableCanvasModule

PointableCanvasUnityEventWrapper

PointableDebugGizmos

PointableDebugVisual

PointableElement

PointableUnityEventWrapper

PositionPinningConfig

RecoilAssistConfig

PokeInteractableVisual

PokeInteractor

PolylineRenderer

PoseDetection

ColliderContainsHandJointActiveState

Debug

ActiveStateDebugTree

ActiveStateDebugTreeUI

ActiveStateDebugVisual

ActiveStateModel

ActiveStateNodeUIHorizontal

ActiveStateNodeUIVertical

FingerFeatureDebugVisual

FingerFeatureSkeletalDebugVisual

HandShapeDebugVisual

HandShapeSkeletalDebugVisual

IActiveStateModel

JointRotationDebugVisual

JointVelocityDebugVisual

TransformFeatureDebugVisual

TransformFeatureVectorDebugParentVisual

TransformFeatureVectorDebugVisual

TransformRecognizerDebugVisual

FeatureStateDescription

FeatureStateProvider

FingerFeatureConfigBuilder

AbductionStateBuilder

OpenCloseStateBuilder

OppositionStateBuilder

FingerFeatureProperties

FingerFeatureStateProvider

FingerStateThresholds

FingerFeatureStateThreshold

FingerFeatureStateThresholds

FingerFeatureThresholds

FingerShapes

HmdOffset

IFeatureStateThreshold

IFeatureStateThresholds

IFeatureThresholds

IFingerFeatureStateProvider

IJointDeltaProvider

ITransformFeatureStateProvider

JointDeltaConfig

JointDeltaProvider

JointDistanceActiveState

JointRotationActiveState

JointRotationFeatureConfig

JointRotationFeatureConfigList

JointRotationFeatureState

JointVelocityActiveState

JointVelocityFeatureConfig

JointVelocityFeatureConfigList

JointVelocityFeatureState

FingerFeatureConfigList

ShapeRecognizerActiveState

TransformConfig

TransformFeatureConfigBuilder

TrueFalseStateBuilder

TransformFeatureConfigList

TransformFeatureProperties

TransformFeatureStateCollection

TransformStateInfo

TransformFeatureStateProvider

TransformFeatureStateThreshold

TransformFeatureStateThresholds

TransformFeatureThresholds

TransformFeatureValueProvider

TransformProperties

TransformJointData

TransformRecognizerActiveState

RandomSampleConsensus

RayInteractable

RayInteractor

RayCandidateProperties

RayInteractorCursorVisual

RayInteractorDebugGizmos

RayInteractorPinchVisual

RectTransformBoundsClipperDriver

RigidbodyKinematicLocker

RigidbodyKinematicLockerExtension

RingBuffer

RoundedBoxProperties

Samples

AnchoredWorldSpaceDistanceScaler

AnimatorOverrideLayerWeigth

ArcAffordanceController

ListSnapPoseDelegateRoundedBoxVisual

LocomotionTutorialAnimationUnityEventWrapper

LocomotionTutorialProgressTracker

LocomotionTutorialTurnVisual

LookAtTarget

ManipulatorAffordanceController

OneGrabScaleTransformer

OneGrabScaleConstraints

OpacityFromAnimatedTransformController

PalmMenu

DominantHandGameObjectFilter

MatchNonDominantPalmWorldSpaceTransform

PalmMenuExample

PalmMenuExampleButtonHandlers

PanelWithManipulatorsBorderAffordanceController

PanelWithManipulatorsStateSignaler

SecondaryInteractorConnection

SecondaryInteractorFilter

SectionAttribute

SelectorDebugVisual

SelectorUnityEventWrapper

SequentialSlotsProvider

ShoulderEstimatePosition

SkeletonDebugGizmos

SnapInteractable

SnapInteractor

SnapInteractorFollowVisual

SurfaceSnapPoseDelegate

ControllerPoseInputDevice

HandPoseInputDevice

IPoseInputDevice

IThrowVelocityCalculator

IVelocityCalculator

RANSACVelocity

TimedPose

RANSACVelocityCalculator

ReleaseVelocityInformation

StandardVelocityCalculator

BufferingParams

TransformSample

VelocityCalculatorUtilMethods

ToggleDeselect

TogglerActiveState

TouchHandGrabInteractable

TouchHandGrabInteractor

TouchHandGrabInteractorVisual

TouchShadowHand

GrabTouchInfo

TransformExtensions

TransformFeatureStateProviderRef

TransformTrackingToWorldTransformer

TwoGrabFreeTransformer

TwoGrabFreeConstraints

TwoGrabFreeState

TwoGrabPlaneTransformer

TwoGrabPlaneConstraints

TwoGrabPlaneState

TwoGrabRotateTransformer

TwoGrabRotateConstraints

MeshGenerationSettings

UpdateCanvasSortingOrder

UnityInfo

UnityXR

FromUnityXRHmdDataSource

UpdateDriverAfterDataSource

UpdateDriverGroup

UseFingerControllerAPI

OperationResultExtensions

PbrMaterialDefinition

ProcessPort

RectSizeConstraint

RoomMeshAnchor

RoundedBoxUIProperties

RoundedBoxVideoController

SharedSpatialAnchorErrorHandler

SkinnedRoundedBoxMesh

SwipeGesture

UpdateRoundedBoxAnchorConstraint

GrabPoseFinder Class

Utility class used by the grab interactors to find the best matching pose from a provided list of HandGrabPoses in an object.

Member Enumerations

Enumeration FindResult

NotFound

NotCompatible

Found

Properties

bool UsesHandPose[Get]

Member Functions

GrabPoseFinder

( List< HandGrabPose > handGrabPoses,

Transform relativeTo )

bool SupportsHandedness

( Handedness handedness )

bool FindBestPose

( in Pose userPose,

in Pose offset,

float handScale,

Handedness handedness,

PoseMeasureParameters scoringModifier,

ref HandGrabResult result )

Finds the best valid hand-pose at this HandGrabInteractable.

Remember that a HandGrabPoses can actually have a whole surface the user can snap to.

Parameters

userPose

Pose to compare to the snap point in world coordinates.

offset

Offset from the Pose for accurate scoring

handScale

The scale of the tracked hand.

handedness

The handedness of the tracked hand.

scoringModifier

Parameters indicating how to score the different poses.

result

The resultant best pose found.

Returns

True if a good pose was found

Static Member Functions

static bool FindInterpolationRange

( float relativeHandScale,

List< HandGrabPose > grabPoses,

out HandGrabPose from,

out HandGrabPose to,

out float t )

Finds the two nearest HandGrabPose to interpolate from given a scale.

The result can require an unclamped interpolation (t can be bigger than 1 or smaller than 0).

Parameters

relativeHandScale

The user scale relative to the target

grabPoses

The list of grab poses to interpolate from

from

The HandGrabInteractable with nearest scale recorder that is smaller than the provided one

The HandGrabInteractable with nearest scale recorder that is bigger than the provided one

The progress between from and to variables at which the desired scale resides

Returns

The HandGrabPose near under and over the scale, and the interpolation factor between them.

Did you find this page helpful?