Meta Developers

MR Utility Kit v68 Reference Guide

Unity

Select your SDK

Overview

FindSpawnPositions

ICustomAnchorPrefabSpawner Interface

Defines methods for custom selection, scaling, and alignment of prefabs.

Overview

Public Member Functions

GameObject	CustomPrefabSelection ( MRUKAnchor anchor, List< GameObject > prefabs ) Selects a prefab based on custom logic.
Vector3	CustomPrefabScaling ( Vector3 localScale ) Scales a prefab based on custom logic.
Vector2	CustomPrefabScaling ( Vector2 localScale ) Scales a prefab based on custom logic.
Vector3	CustomPrefabAlignment ( Bounds anchorVolumeBounds, Bounds? prefabBounds ) Aligns a prefab to an anchor's volume, based on custom logic.
Vector3	CustomPrefabAlignment ( Rect anchorPlaneRect, Bounds? prefabBounds ) Aligns a prefab to an anchor's plane rect, based on custom logic.

Details

Detailed Description

Extend the AnchorPrefabSpawner class and override the methods offered by this interface implementing any custom logic.

Member Functions

GameObject Meta.XR.MRUtilityKit.ICustomAnchorPrefabSpawner.CustomPrefabSelection ( MRUKAnchor anchor, List< GameObject > prefabs )
Selects a prefab based on custom logic. Parameters anchor The anchor info to use. prefabs The list of prefabs to select from. Can be null. Returns The selected prefab. This method is intended to be overridden in a class that extends AnchorPrefabSpawner with custom logic for selecting a prefab. It will be called whenever the PrefabSelection of an AnchorPrefabGroup is set to Custom.

Vector3 Meta.XR.MRUtilityKit.ICustomAnchorPrefabSpawner.CustomPrefabScaling ( Vector3 localScale )
Scales a prefab based on custom logic. Parameters localScale The local scale of the prefab. Returns The scaled local scale of the prefab. This method is intended to be overridden in a class that extends AnchorPrefabSpawner with custom logic for scaling a prefab. If not overridden, it throws a NotImplementedException.

Vector2 Meta.XR.MRUtilityKit.ICustomAnchorPrefabSpawner.CustomPrefabScaling ( Vector2 localScale )
Scales a prefab based on custom logic. Parameters localScale The local scale of the prefab. Returns The scaled local scale of the prefab. This method is intended to be overridden a class that extends AnchorPrefabSpawner with custom logic for scaling a prefab. If not overridden, it throws a NotImplementedException.

Vector3 Meta.XR.MRUtilityKit.ICustomAnchorPrefabSpawner.CustomPrefabAlignment ( Bounds anchorVolumeBounds, Bounds? prefabBounds )
Aligns a prefab to an anchor's volume, based on custom logic. Parameters anchorVolumeBounds The volume bounds of the anchor. prefabBounds The bounds of the prefab. Returns The local position of the prefab defined as the difference between the anchor's pivot and the prefab's pivot. This method is intended to be overridden a class that extends AnchorPrefabSpawner with custom logic for aligning a prefab. If not overridden, it throws a NotImplementedException.

Vector3 Meta.XR.MRUtilityKit.ICustomAnchorPrefabSpawner.CustomPrefabAlignment
( Bounds anchorVolumeBounds,
Bounds? prefabBounds )

Aligns a prefab to an anchor's volume, based on custom logic.

Parameters

anchorVolumeBounds

The volume bounds of the anchor.

prefabBounds

The bounds of the prefab.

Returns

The local position of the prefab defined as the difference between the anchor's pivot and the prefab's pivot.

This method is intended to be overridden a class that extends AnchorPrefabSpawner with custom logic for aligning a prefab. If not overridden, it throws a NotImplementedException.

Vector3 Meta.XR.MRUtilityKit.ICustomAnchorPrefabSpawner.CustomPrefabAlignment ( Rect anchorPlaneRect, Bounds? prefabBounds )
Aligns a prefab to an anchor's plane rect, based on custom logic. Parameters anchorPlaneRect The volume bounds of the anchor. prefabBounds The bounds of the prefab. Returns The local position of the prefab defined as the difference between the anchor's pivot and the prefab's pivot. This method is intended to be overridden a class that extends AnchorPrefabSpawner with custom logic for aligning a prefab. If not overridden, it throws a NotImplementedException.

Vector3 Meta.XR.MRUtilityKit.ICustomAnchorPrefabSpawner.CustomPrefabAlignment
( Rect anchorPlaneRect,
Bounds? prefabBounds )

Aligns a prefab to an anchor's plane rect, based on custom logic.