docs.unity3d.com
    Show / Hide Table of Contents

    Class XRBaseInteractorEditor

    Custom editor for an XRBaseInteractor.

    Inheritance
    Object
    BaseInteractionEditor
    XRBaseInteractorEditor
    ARGestureInteractorEditor
    XRBaseControllerInteractorEditor
    XRSocketInteractorEditor
    Inherited Members
    BaseInteractionEditor.knownSerializedPropertyNames
    BaseInteractionEditor.OnInspectorGUI()
    BaseInteractionEditor.InitializeKnownSerializedPropertyNames()
    BaseInteractionEditor.GetDerivedSerializedPropertyNames()
    BaseInteractionEditor.DrawDerivedProperties()
    BaseInteractionEditor.DrawScript()
    Namespace: UnityEditor.XR.Interaction.Toolkit
    Syntax
    public class XRBaseInteractorEditor : BaseInteractionEditor

    Fields

    m_AttachTransform

    of the backing attachTransform.

    Declaration
    protected SerializedProperty m_AttachTransform
    Field Value
    Type Description
    SerializedProperty

    m_HoverEntered

    of the backing hoverEntered.

    Declaration
    protected SerializedProperty m_HoverEntered
    Field Value
    Type Description
    SerializedProperty

    m_HoverExited

    of the backing hoverExited.

    Declaration
    protected SerializedProperty m_HoverExited
    Field Value
    Type Description
    SerializedProperty

    m_InteractionLayerMask

    of the backing interactionLayerMask.

    Declaration
    protected SerializedProperty m_InteractionLayerMask
    Field Value
    Type Description
    SerializedProperty

    m_InteractionManager

    of the backing interactionManager.

    Declaration
    protected SerializedProperty m_InteractionManager
    Field Value
    Type Description
    SerializedProperty

    m_OnHoverEntered

    of the backing onHoverEntered.

    Declaration
    protected SerializedProperty m_OnHoverEntered
    Field Value
    Type Description
    SerializedProperty

    m_OnHoverEnteredCalls

    of the persistent calls backing onHoverEntered.

    Declaration
    protected SerializedProperty m_OnHoverEnteredCalls
    Field Value
    Type Description
    SerializedProperty

    m_OnHoverExited

    of the backing onHoverExited.

    Declaration
    protected SerializedProperty m_OnHoverExited
    Field Value
    Type Description
    SerializedProperty

    m_OnHoverExitedCalls

    of the persistent calls backing onHoverExited.

    Declaration
    protected SerializedProperty m_OnHoverExitedCalls
    Field Value
    Type Description
    SerializedProperty

    m_OnSelectEntered

    of the backing onSelectEntered.

    Declaration
    protected SerializedProperty m_OnSelectEntered
    Field Value
    Type Description
    SerializedProperty

    m_OnSelectEnteredCalls

    of the persistent calls backing onSelectEntered.

    Declaration
    protected SerializedProperty m_OnSelectEnteredCalls
    Field Value
    Type Description
    SerializedProperty

    m_OnSelectExited

    of the backing onSelectExited.

    Declaration
    protected SerializedProperty m_OnSelectExited
    Field Value
    Type Description
    SerializedProperty

    m_OnSelectExitedCalls

    of the persistent calls backing onSelectExited.

    Declaration
    protected SerializedProperty m_OnSelectExitedCalls
    Field Value
    Type Description
    SerializedProperty

    m_SelectEntered

    of the backing selectEntered.

    Declaration
    protected SerializedProperty m_SelectEntered
    Field Value
    Type Description
    SerializedProperty

    m_SelectExited

    of the backing selectExited.

    Declaration
    protected SerializedProperty m_SelectExited
    Field Value
    Type Description
    SerializedProperty

    m_StartingSelectedInteractable

    of the backing startingSelectedInteractable.

    Declaration
    protected SerializedProperty m_StartingSelectedInteractable
    Field Value
    Type Description
    SerializedProperty

    Methods

    DrawBeforeProperties()

    This method is automatically called by DrawInspector() to draw the section of the custom inspector before DrawProperties(). By default, this draws the read-only Script property.

    Declaration
    protected virtual void DrawBeforeProperties()

    DrawCoreConfiguration()

    Draw the core group of property fields. These are the main properties that appear before any other spaced section in the inspector.

    Declaration
    protected virtual void DrawCoreConfiguration()

    DrawEvents()

    This method is automatically called by DrawInspector() to draw the event properties. Override this method to customize the events shown in the Inspector. This is typically the method overridden when a derived behavior adds additional serialized event properties that should be displayed in the Inspector.

    Declaration
    protected virtual void DrawEvents()

    DrawInspector()

    This method is automatically called by OnInspectorGUI() to draw the custom inspector. Override this method to customize the inspector as a whole.

    Declaration
    protected override void DrawInspector()
    Overrides
    BaseInteractionEditor.DrawInspector()
    See Also
    DrawBeforeProperties()
    DrawProperties()
    DrawDerivedProperties()
    DrawEvents()

    DrawInteractionManagement()

    Draw the property fields related to interaction management.

    Declaration
    protected virtual void DrawInteractionManagement()

    DrawInteractorEvents()

    Draw the Interactor Events foldout.

    Declaration
    protected virtual void DrawInteractorEvents()
    See Also
    DrawInteractorEventsNested()

    DrawInteractorEventsNested()

    Draw the nested contents of the Interactor Events foldout.

    Declaration
    protected virtual void DrawInteractorEventsNested()
    See Also
    DrawInteractorEvents()

    DrawProperties()

    This method is automatically called by DrawInspector() to draw the property fields. Override this method to customize the properties shown in the Inspector. This is typically the method overridden when a derived behavior adds additional serialized properties that should be displayed in the Inspector.

    Declaration
    protected virtual void DrawProperties()

    IsDeprecatedEventsInUse()

    Get whether deprecated events are in use.

    Declaration
    protected virtual bool IsDeprecatedEventsInUse()
    Returns
    Type Description
    Boolean

    Returns true if deprecated events are in use. Otherwise, returns false.

    MigrateEvents(SerializedObject)

    Migrate the persistent listeners from the deprecated properties to the new events on an XRBaseInteractor.

    Declaration
    protected virtual void MigrateEvents(SerializedObject serializedObject)
    Parameters
    Type Name Description
    SerializedObject serializedObject

    The object to upgrade.

    MigrateEvents(Object[])

    Migrate the persistent listeners from the deprecated properties to the new events on an XRBaseInteractor.

    Declaration
    public void MigrateEvents(Object[] targets)
    Parameters
    Type Name Description
    Object[] targets

    An array of all the objects to upgrade.

    OnEnable()

    This function is called when the object becomes enabled and active.

    Declaration
    protected virtual void OnEnable()
    Back to top
    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