Class PlaneGenerationModule

Module used to generate planes for a synthetic environment

Inheritance
object
PlaneGenerationModule
Implements
IModule
IFunctionalitySubscriber<IProvidesPlaneFinding>
IFunctionalitySubscriber
Inherited Members
Namespace: UnityEditor.MARS.Data.Synthetic
Assembly: Unity.MARS.Editor.dll
Syntax
[MovedFrom("Unity.MARS")]
public class PlaneGenerationModule : IModule, IUsesPlaneFinding, IFunctionalitySubscriber<IProvidesPlaneFinding>, IFunctionalitySubscriber

Properties

provider

The functionality provider

Declaration
public IProvidesPlaneFinding provider { get; set; }
Property Value
Type Description
IProvidesPlaneFinding

Methods

ExtractPlanes(PlaneExtractionSettings)

Run planes extraction from the PlanesExtractionManager

Declaration
public static void ExtractPlanes(PlaneExtractionSettings settings)
Parameters
Type Name Description
PlaneExtractionSettings settings

Settings to use when running extraction

SavePlanesFromSimulation(GameObject)

Save all plane data from the current simulation to the synthetic environment

Declaration
public void SavePlanesFromSimulation(GameObject environmentRoot)
Parameters
Type Name Description
GameObject environmentRoot

Root game object for the synthetic environment

TryDestroyPreviousPlanes(GameObject, string, UndoBlock)

Try to destroy game objects in the synthetic environment that have the GeneratedPlanesRoot component

Declaration
public static bool TryDestroyPreviousPlanes(GameObject environmentRoot, string confirmDestroyDialogTitle, UndoBlock undoBlock)
Parameters
Type Name Description
GameObject environmentRoot

Synthetic environment root game object
string confirmDestroyDialogTitle

Confirmation dialog title
UndoBlock undoBlock

Undo block used for editing action
Returns
Type Description
bool

True if planes were destroyed

Implements

Unity.XRTools.ModuleLoader.IModule
Unity.XRTools.ModuleLoader.IFunctionalitySubscriber<TProvider>
Unity.XRTools.ModuleLoader.IFunctionalitySubscriber