docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BuildSurfaceAction

    Creates a surface plane from the entity's plane data

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    TransformAction
    BuildSurfaceAction
    Implements
    IMatchLossHandler
    IMatchAcquireHandler
    IMatchUpdateHandler
    IAction
    ISimulatable
    IUsesMARSTrackableData<MRPlane>
    IUsesCameraOffset
    IFunctionalitySubscriber<IProvidesCameraOffset>
    IFunctionalitySubscriber
    IRequiresTraits
    Inherited Members
    TransformAction.OnDisable()
    TransformAction.ResetOnLoss
    TransformAction.OnMatchLoss(QueryResult)
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.MARS.Actions
    Assembly: Unity.MARS.dll
    Syntax
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.mars@1.6/manual/ReferenceGuideActions.html#match-action-matchaction")]
    [MonoBehaviourComponentMenu(typeof(BuildSurfaceAction), "Action/Build Surface")]
    [MovedFrom("Unity.MARS")]
    public class BuildSurfaceAction : TransformAction, IMatchLossHandler, IMatchAcquireHandler, IMatchUpdateHandler, IAction, ISimulatable, IUsesMARSTrackableData<MRPlane>, IUsesCameraOffset, IFunctionalitySubscriber<IProvidesCameraOffset>, IFunctionalitySubscriber, IRequiresTraits

    Properties

    LocalPlaneOffset

    Offsets the created plane in local space. Offset in Y axis to clarify depth ordering.

    Declaration
    public Vector3 LocalPlaneOffset { get; set; }
    Property Value
    Type Description
    Vector3

    Methods

    Awake()

    Awake is called when the script instance is being loaded.

    Declaration
    protected override void Awake()
    Overrides
    TransformAction.Awake()

    GetRequiredTraits()

    Get the TraitRequirements that are required by this object

    Declaration
    public TraitRequirement[] GetRequiredTraits()
    Returns
    Type Description
    TraitRequirement[]

    The required traits

    OnMatchAcquire(QueryResult)

    Called when a query match has been found

    Declaration
    public void OnMatchAcquire(QueryResult queryResult)
    Parameters
    Type Name Description
    QueryResult queryResult

    Data associated with this event

    OnMatchUpdate(QueryResult)

    Called when a query match's data has updated

    Declaration
    public void OnMatchUpdate(QueryResult queryResult)
    Parameters
    Type Name Description
    QueryResult queryResult

    Data associated with this event

    Implements

    IMatchLossHandler
    IMatchAcquireHandler
    IMatchUpdateHandler
    IAction
    ISimulatable
    IUsesMARSTrackableData<T>
    IUsesCameraOffset
    Unity.XRTools.ModuleLoader.IFunctionalitySubscriber<TProvider>
    Unity.XRTools.ModuleLoader.IFunctionalitySubscriber
    IRequiresTraits

    Extension Methods

    IUsesMARSTrackableDataGenericMethods.AddData<T>(IUsesMARSTrackableData<T>, int, T)
    IUsesMARSTrackableDataGenericMethods.AddOrUpdateData<T>(IUsesMARSTrackableData<T>, T)
    IUsesMARSTrackableDataGenericMethods.GetCollection<T>(IUsesMARSTrackableData<T>)
    IUsesMARSTrackableDataGenericMethods.GetIdValue<T>(IUsesMARSTrackableData<T>, int)
    IUsesMARSTrackableDataGenericMethods.RegisterProcessingJob<T>(IUsesMARSTrackableData<T>, ProcessingJobType)
    IUsesMARSTrackableDataGenericMethods.RemoveData<T>(IUsesMARSTrackableData<T>, T)
    IUsesMARSTrackableDataGenericMethods.UnregisterProcessingJob<T>(IUsesMARSTrackableData<T>, ProcessingJobType)
    CameraOffsetExtensions.PoseToCameraSpace(IUsesCameraOffset, Pose, Vector3)
    IUsesCameraOffsetMethods.ApplyInverseOffsetToDirection(IUsesCameraOffset, Vector3)
    IUsesCameraOffsetMethods.ApplyInverseOffsetToPose(IUsesCameraOffset, Pose)
    IUsesCameraOffsetMethods.ApplyInverseOffsetToPosition(IUsesCameraOffset, Vector3)
    IUsesCameraOffsetMethods.ApplyInverseOffsetToRotation(IUsesCameraOffset, Quaternion)
    IUsesCameraOffsetMethods.ApplyOffsetToDirection(IUsesCameraOffset, Vector3)
    IUsesCameraOffsetMethods.ApplyOffsetToPose(IUsesCameraOffset, Pose)
    IUsesCameraOffsetMethods.ApplyOffsetToPosition(IUsesCameraOffset, Vector3)
    IUsesCameraOffsetMethods.ApplyOffsetToRotation(IUsesCameraOffset, Quaternion)
    IUsesCameraOffsetMethods.GetCameraOffsetMatrix(IUsesCameraOffset)
    IUsesCameraOffsetMethods.GetCameraPositionOffset(IUsesCameraOffset)
    IUsesCameraOffsetMethods.GetCameraScale(IUsesCameraOffset)
    IUsesCameraOffsetMethods.GetCameraYawOffset(IUsesCameraOffset)
    IUsesCameraOffsetMethods.SetCameraPositionOffset(IUsesCameraOffset, Vector3)
    IUsesCameraOffsetMethods.SetCameraScale(IUsesCameraOffset, float)
    IUsesCameraOffsetMethods.SetCameraYawOffset(IUsesCameraOffset, float)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)