docs.unity3d.com
    Show / Hide Table of Contents

    Class PlaneGenerationModule

    Module used to generate planes for a synthetic environment

    Inheritance
    Object
    PlaneGenerationModule
    Namespace: UnityEditor.MARS.Data.Synthetic
    Syntax
    public class PlaneGenerationModule : IModule, IUsesPlaneFinding, IFunctionalitySubscriber<IProvidesPlaneFinding>

    Properties

    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
    Boolean

    True if planes were destroyed

    Extension Methods

    IUsesPlaneFindingMethods.GetPlanes(IUsesPlaneFinding, List<MRPlane>)
    IUsesPlaneFindingMethods.SubscribePlaneAdded(IUsesPlaneFinding, Action<MRPlane>)
    IUsesPlaneFindingMethods.UnsubscribePlaneAdded(IUsesPlaneFinding, Action<MRPlane>)
    IUsesPlaneFindingMethods.SubscribePlaneUpdated(IUsesPlaneFinding, Action<MRPlane>)
    IUsesPlaneFindingMethods.UnsubscribePlaneUpdated(IUsesPlaneFinding, Action<MRPlane>)
    IUsesPlaneFindingMethods.SubscribePlaneRemoved(IUsesPlaneFinding, Action<MRPlane>)
    IUsesPlaneFindingMethods.UnsubscribePlaneRemoved(IUsesPlaneFinding, Action<MRPlane>)
    IUsesPlaneFindingMethods.StopDetectingPlanes(IUsesPlaneFinding)
    IUsesPlaneFindingMethods.StartDetectingPlanes(IUsesPlaneFinding)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023