Class MultipleRayInputModule

A BaseInputModule designed for mouse / keyboard / controller input.

Inheritance
Object
RayInputModule
MultipleRayInputModule
Inherited Members
Namespace: UnityEditor.Experimental.EditorVR.Modules
Syntax
public class MultipleRayInputModule : RayInputModule, IUsesViewerScale, IFunctionalitySubscriber<IProvidesViewerScale>, IUsesPointer, IUsesConnectInterfaces, IFunctionalitySubscriber<IProvidesConnectInterfaces>, IProvidesAddRaycastSource, IProvidesIsHoveringOverUI, IUsesFunctionalityInjection, IFunctionalitySubscriber<IProvidesFunctionalityInjection>, IFunctionalitySubscriber, IProvidesBlockUIInteraction, IProvidesUIEvents, IProvidesGetRayEventData, IFunctionalityProvider
Remarks

Input module for working with, mouse, keyboard, or controller.

Properties

eventCamera

Declaration
public Camera eventCamera { get; set; }
Property Value
Type Description
Camera

forceModuleActive

Force this module to be active.

Declaration
public bool forceModuleActive { get; set; }
Property Value
Type Description
Boolean
Remarks

If there is no module active with higher priority (ordered in the inspector) this module will be forced active even if valid enabling conditions are not met.

inputActionsPerSecond

Number of keyboard / controller inputs allowed per second.

Declaration
public float inputActionsPerSecond { get; set; }
Property Value
Type Description
Single

layerMask

Declaration
public LayerMask layerMask { get; set; }
Property Value
Type Description
LayerMask

preProcessRaycastSource

Declaration
public Action<Transform> preProcessRaycastSource { set; }
Property Value
Type Description
Action<Transform>

Methods

ActivateModule()

See BaseInputModule.

Declaration
public override void ActivateModule()

AddRaycastSource(IProxy, Node, Transform, Func<IRaycastSource, Boolean>)

Declaration
public void AddRaycastSource(IProxy proxy, Node node, Transform rayOrigin, Func<IRaycastSource, bool> validationCallback = null)
Parameters
Type Name Description
IProxy proxy
Node node
Transform rayOrigin
Func<IRaycastSource, Boolean> validationCallback

Awake()

Declaration
protected override void Awake()
Overrides

ConnectSubscriber(Object)

Declaration
public void ConnectSubscriber(object obj)
Parameters
Type Name Description
Object obj
Implements

DeactivateModule()

See BaseInputModule.

Declaration
public override void DeactivateModule()

GetCurrentFocusedGameObject()

Declaration
protected GameObject GetCurrentFocusedGameObject()
Returns
Type Description
GameObject

GetPointerEventData(Transform)

Declaration
public RayEventData GetPointerEventData(Transform rayOrigin)
Parameters
Type Name Description
Transform rayOrigin
Returns
Type Description
RayEventData

IsHoveringOverUI(Transform)

Declaration
public bool IsHoveringOverUI(Transform rayOrigin)
Parameters
Type Name Description
Transform rayOrigin
Returns
Type Description
Boolean
Implements

IsModuleSupported()

Declaration
public override bool IsModuleSupported()
Returns
Type Description
Boolean

LoadProvider()

Declaration
public void LoadProvider()
Implements

OnDestroy()

Declaration
protected override void OnDestroy()

Process()

Declaration
public override void Process()

ProcessMouseEvent()

Declaration
protected void ProcessMouseEvent()

ProcessMouseEvent(Int32)

Process all mouse events.

Declaration
protected void ProcessMouseEvent(int id)
Parameters
Type Name Description
Int32 id

ProcessMousePress(RayInputModule.MouseButtonRayEventData)

Calculate and process any mouse button state changes.

Declaration
protected void ProcessMousePress(RayInputModule.MouseButtonRayEventData data)
Parameters
Type Name Description
RayInputModule.MouseButtonRayEventData data

ProcessTouchPress(RayEventData, Boolean, Boolean)

This method is called by Unity whenever a touch event is processed. Override this method with a custom implementation to process touch events yourself.

Declaration
protected void ProcessTouchPress(RayEventData pointerEvent, bool pressed, bool released)
Parameters
Type Name Description
RayEventData pointerEvent

Event data relating to the touch event, such as position and ID to be passed to the touch event destination object.
Boolean pressed

This is true for the first frame of a touch event, and false thereafter. This can therefore be used to determine the instant a touch event occurred.
Boolean released

This is true only for the last frame of a touch event.
Remarks

This method can be overridden in derived classes to change how touch press events are handled.

SendMoveEventToSelectedObject()

Calculate and send a move event to the current selected object.

Declaration
protected bool SendMoveEventToSelectedObject()
Returns
Type Description
Boolean

If the move event was used by the selected object.

SendSubmitEventToSelectedObject()

Calculate and send a submit event to the current selected object.

Declaration
protected bool SendSubmitEventToSelectedObject()
Returns
Type Description
Boolean

If the submit event was used by the selected object.

SendUpdateEventToSelectedObject()

Declaration
protected bool SendUpdateEventToSelectedObject()
Returns
Type Description
Boolean

SetUIBlockedForRayOrigin(Transform, Boolean)

Declaration
public void SetUIBlockedForRayOrigin(Transform rayOrigin, bool blocked)
Parameters
Type Name Description
Transform rayOrigin
Boolean blocked
Implements

ShouldActivateModule()

Declaration
public override bool ShouldActivateModule()
Returns
Type Description
Boolean

ShutDown()

Declaration
public void ShutDown()

UnloadProvider()

Declaration
public void UnloadProvider()
Implements

UpdateModule()

Declaration
public override void UpdateModule()

Explicit Interface Implementations

IFunctionalitySubscriber<IProvidesConnectInterfaces>.provider

Declaration
IProvidesConnectInterfaces IFunctionalitySubscriber<IProvidesConnectInterfaces>.provider { get; set; }
Returns
Type Description
IProvidesConnectInterfaces
Implements

IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider

Declaration
IProvidesFunctionalityInjection IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider { get; set; }
Returns
Type Description
IProvidesFunctionalityInjection
Implements

Extension Methods