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
Implements
Inherited Members
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
[RequireComponent(typeof(ReflectionProbe))]
[DisallowMultipleComponent]
[DefaultExecutionOrder(-2147483646)]
public class AREnvironmentProbe : ARTrackable<XREnvironmentProbe, AREnvironmentProbe>, ITrackable

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

placementType

The placement type (for example, manual or automatic) for this AREnvironmentProbe. If manual, this probe was created by instantiating a GameObject with the AREnvironmentProbe component or by adding an AREnvironmentProbe with UnityEngine.GameObject.AddComponent<T>().

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

Implements