Class XRBaseInteractableEditor

Custom editor for an XRBaseInteractable.

Inheritance
Object
BaseInteractionEditor
XRBaseInteractableEditor
ARBaseGestureInteractableEditor
BaseTeleportationInteractableEditor
XRGrabInteractableEditor
Inherited Members
Namespace: UnityEditor.XR.Interaction.Toolkit
Syntax
public class XRBaseInteractableEditor : BaseInteractionEditor

Fields

m_Activated

of the backing activated.

Declaration
protected SerializedProperty m_Activated
Field Value
Type Description
SerializedProperty

m_Colliders

of the backing colliders.

Declaration
protected SerializedProperty m_Colliders
Field Value
Type Description
SerializedProperty

m_CustomReticle

of the backing customReticle.

Declaration
protected SerializedProperty m_CustomReticle
Field Value
Type Description
SerializedProperty

m_Deactivated

of the backing deactivated.

Declaration
protected SerializedProperty m_Deactivated
Field Value
Type Description
SerializedProperty

m_FirstHoverEntered

of the backing firstHoverEntered.

Declaration
protected SerializedProperty m_FirstHoverEntered
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_LastHoverExited

of the backing lastHoverExited.

Declaration
protected SerializedProperty m_LastHoverExited
Field Value
Type Description
SerializedProperty

m_OnActivate

of the backing onActivate.

Declaration
protected SerializedProperty m_OnActivate
Field Value
Type Description
SerializedProperty

m_OnActivateCalls

of the persistent calls backing onActivate.

Declaration
protected SerializedProperty m_OnActivateCalls
Field Value
Type Description
SerializedProperty

m_OnDeactivate

of the backing onDeactivate.

Declaration
protected SerializedProperty m_OnDeactivate
Field Value
Type Description
SerializedProperty

m_OnDeactivateCalls

of the persistent calls backing onDeactivate.

Declaration
protected SerializedProperty m_OnDeactivateCalls
Field Value
Type Description
SerializedProperty

m_OnFirstHoverEntered

of the backing onFirstHoverEntered.

Declaration
protected SerializedProperty m_OnFirstHoverEntered
Field Value
Type Description
SerializedProperty

m_OnFirstHoverEnteredCalls

of the persistent calls backing onFirstHoverEntered.

Declaration
protected SerializedProperty m_OnFirstHoverEnteredCalls
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_OnLastHoverExited

of the backing onLastHoverExited.

Declaration
protected SerializedProperty m_OnLastHoverExited
Field Value
Type Description
SerializedProperty

m_OnLastHoverExitedCalls

of the persistent calls backing onLastHoverExited.

Declaration
protected SerializedProperty m_OnLastHoverExitedCalls
Field Value
Type Description
SerializedProperty

m_OnSelectCanceled

of the backing onSelectCanceled.

Declaration
protected SerializedProperty m_OnSelectCanceled
Field Value
Type Description
SerializedProperty

m_OnSelectCanceledCalls

of the persistent calls backing onSelectCanceled.

Declaration
protected SerializedProperty m_OnSelectCanceledCalls
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

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
See Also

DrawInteractableEvents()

Draw the Interactable Events foldout.

Declaration
protected virtual void DrawInteractableEvents()
See Also

DrawInteractableEventsNested()

Draw the nested contents of the Interactable Events foldout.

Declaration
protected virtual void DrawInteractableEventsNested()
See Also

DrawInteractionManagement()

Draw the property fields related to interaction management.

Declaration
protected virtual void DrawInteractionManagement()

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 XRBaseInteractable.

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

The object to upgrade.
Remarks

Assumes On Select Exited should be migrated to Select Exited even though it will now be invoked even when canceled. On Select Canceled is skipped since it can't be migrated.

MigrateEvents(Object[])

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

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

An array of all the objects to upgrade.
Remarks

Assumes On Select Exited should be migrated to Select Exited even though it will now be invoked even when canceled. On Select Canceled is skipped since it can't be migrated.

OnEnable()

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

Declaration
protected virtual void OnEnable()