Method RemoveEnvironmentProbe

RemoveEnvironmentProbe(TrackableId)

Overridden by the provider to remove the environment probe matching the trackable ID from the AR session.

Declaration

public virtual bool RemoveEnvironmentProbe(TrackableId trackableId)

Parameters

Type	Name	Description
TrackableId	trackableId	Trackable ID of the environment probe to be removed from the AR session.

Returns

Type	Description
bool	true whether the environment probe is found in the current AR session and will be removed. Otherwise, false.

Remarks

You can use this method to remove both manually placed and automatically placed environment probes if the implementation supports such removals. Providers should implement this method to remove environment probes of the allowed types and to throw a System.NotSupportedException for removals of environment probes of disallowed types.

Exceptions

Type	Condition
NotSupportedException	Thrown in the default implementation.