Class AREnvironmentProbe

A GameObject component to manage the reflection probe settings as the environment probe changes are applied.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
ARTrackable
ARTrackable<XREnvironmentProbe, AREnvironmentProbe>
AREnvironmentProbe
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.useGUILayout
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.name
Object.hideFlags
Namespace: UnityEngine.XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
[RequireComponent(typeof(ReflectionProbe))]
[DisallowMultipleComponent]
[DefaultExecutionOrder(-2147483646)]
public class AREnvironmentProbe : ARTrackable<XREnvironmentProbe, AREnvironmentProbe>

Properties

environmentTextureFilterMode

Specifies the texture filter mode to be used with the environment texture.

Declaration
public FilterMode environmentTextureFilterMode { get; set; }
Property Value
Type Description
FilterMode

The texture filter mode to be used with the environment texture.

extents

The extents of the environment probe. This is always half the size.

Declaration
public Vector3 extents { get; }
Property Value
Type Description
Vector3

nativePtr

A native pointer associated with this environment probe. The data pointed to by this pointer is implementation defined. While the lifetime is also implementation defined, it should be valid at least until the next frame.

Declaration
public IntPtr nativePtr { get; }
Property Value
Type Description
IntPtr

placementType

The placement type (for example, manual or automatic). If manual, this probe was created by AddEnvironmentProbe(Pose, Vector3, Vector3).

Declaration
public AREnvironmentProbePlacementType placementType { get; }
Property Value
Type Description
AREnvironmentProbePlacementType

size

The size (dimensions) of the environment probe.

Declaration
public Vector3 size { get; }
Property Value
Type Description
Vector3

textureDescriptor

The XRTextureDescriptor associated with this environment probe. This is used to generate the cubemap texture on the reflection probe component.

Declaration
public XRTextureDescriptor textureDescriptor { get; }
Property Value
Type Description
XRTextureDescriptor

Methods

OnAfterSetSessionRelativeData()

Invoked just after the session-relative data has been set. The GameObject's transform has already been updated. You may override this method to perform further updates specific to the derived trackable.

Declaration
protected override void OnAfterSetSessionRelativeData()
Overrides

ToString()

Generates a string representation of this AREnvironmentProbe.

Declaration
public override string ToString()
Returns
Type Description
string

A string representation of this AREnvironmentProbe.
Overrides
UnityEngine.Object.ToString()