Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

SpatialMappingBase.OnBeginSurfaceEviction

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

protected function OnBeginSurfaceEviction(shouldBeActiveWhileRemoved: bool, surface: VR.WSA.SpatialMappingBase.Surface): void;
protected void OnBeginSurfaceEviction(bool shouldBeActiveWhileRemoved, VR.WSA.SpatialMappingBase.Surface surface);

Description

This method is called when the system notifies the spatial mapping component that a surface has been removed.

The system will notify the spatial mapping component when a surface has been removed from the physical environment. The component must determine what to do with the corresponding surface GameObject. Classes that derived from SpatialMappingBase must implement this method.