Class SphereInteractionCaster

Implementation of InteractionCasterBase that performs a sphere cast with a set radius to find valid targets.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

InteractionCasterBase

SphereInteractionCaster

Implements

IInteractionCaster

Inherited Members

InteractionCasterBase.isInitialized

InteractionCasterBase.castOrigin

InteractionCasterBase.effectiveCastOrigin

InteractionCasterBase.enableStabilization

InteractionCasterBase.positionStabilization

InteractionCasterBase.angleStabilization

InteractionCasterBase.aimTarget

InteractionCasterBase.OnValidate()

InteractionCasterBase.Awake()

InteractionCasterBase.OnDestroy()

InteractionCasterBase.UpdateInternalData()

InteractionCasterBase.InitializeStabilization()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Interaction.Toolkit.Interactors.Casters

Assembly: Unity.XR.Interaction.Toolkit.dll

Syntax

[DisallowMultipleComponent]
[AddComponentMenu("XR/Interactors/Sphere Interaction Caster", 22)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/api/UnityEngine.XR.Interaction.Toolkit.Interactors.Casters.SphereInteractionCaster.html")]
public class SphereInteractionCaster : InteractionCasterBase, IInteractionCaster

Properties

castRadius

Radius of the sphere cast.

Declaration

public float castRadius { get; set; }

Property Value

Type	Description
float

physicsLayerMask

Gets or sets layer mask used for limiting sphere cast and sphere overlap targets.

Declaration

public LayerMask physicsLayerMask { get; set; }

Property Value

Type	Description
LayerMask

physicsTriggerInteraction

Determines whether the cast sphere overlap will hit triggers.

Declaration

public QueryTriggerInteraction physicsTriggerInteraction { get; set; }

Property Value

Type	Description
QueryTriggerInteraction

Remarks

When set to UseGlobal, the value of Queries Hit Triggers (queriesHitTriggers) in Edit > Project Settings > Physics will be used.

Methods

InitializeCaster()

Tries to initialize the caster.

Declaration

protected override bool InitializeCaster()

Returns

Type	Description
bool	Returns true if successful or already initialized.

Overrides

InteractionCasterBase.InitializeCaster()

OnDisable()

See MonoBehaviour.

Declaration

protected virtual void OnDisable()

OnEnable()

See MonoBehaviour.

Declaration

protected virtual void OnEnable()

TryGetColliderTargets(XRInteractionManager, List<Collider>)

Gets an unsorted list of collider targets

Declaration

public override bool TryGetColliderTargets(XRInteractionManager interactionManager, List<Collider> targets)

Parameters

Type	Name	Description
XRInteractionManager	interactionManager	XR Interaction manager reference
List<Collider>	targets	List of target colliders to populate.

Returns

Type	Description
bool	Returns true if collider targets were found.

Overrides

InteractionCasterBase.TryGetColliderTargets(XRInteractionManager, List<Collider>)

Implements

IInteractionCaster