Method AddEnvironmentProbe
AddEnvironmentProbe(Pose, Vector3, Vector3)
Creates a new environment probe at pose with scale and size
if supported by the subsystem. Use the descriptor's
supportsManualPlacement property to determine support for this feature. If successful, a new
GameObject with an AREnvironmentProbe is created
immediately; however, the provider might not report the environment probe as added until a future frame. Check the
status of the probe by inspecting its
pending property.
Declaration
[Obsolete("Add an environment probe using AddComponent<AREnvironmentProbe>(). (2020-10-06)")]
public AREnvironmentProbe AddEnvironmentProbe(Pose pose, Vector3 scale, Vector3 size)Parameters
| Type | Name | Description |
|---|---|---|
| Pose | pose | The position and rotation at which to create the new environment probe. |
| Vector3 | scale | The scale of the new environment probe. |
| Vector3 | size | The size (dimensions) of the new environment probe. |
Returns
| Type | Description |
|---|---|
| AREnvironmentProbe | A new AREnvironmentProbe if successful, otherwise |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Thrown if this manager is not enabled |
| InvalidOperationException | Thrown if this manager has no subsystem. |
| NotSupportedException | Thrown if manual placement is not supported by this subsystem.
Check for support on the descriptor's
|