Class SnappingModule

Inheritance

SnappingModule

Inherited Members

ScriptableSettings<SnappingModule>.instance

ScriptableSettings<SnappingModule>.CreateAndLoad()

ScriptableSettingsBase<SnappingModule>.s_Instance

ScriptableSettingsBase<SnappingModule>.OnEnable()

ScriptableSettingsBase<SnappingModule>.Save(String)

ScriptableSettingsBase<SnappingModule>.GetFilePath()

ScriptableSettingsBase.k_PathExceptionMessage

ScriptableSettingsBase.GetInstanceByType(Type)

ScriptableSettingsBase.OnLoaded()

Namespace: UnityEditor.Experimental.EditorVR.Modules

Syntax

[MainMenuItem("Snapping", "Settings", "Select snapping modes", null)]
public sealed class SnappingModule : ScriptableSettings<SnappingModule>, IDelayedInitializationModule, IModuleBehaviorCallbacks, IModule, IUsesViewerScale, IFunctionalitySubscriber<IProvidesViewerScale>, ISettingsMenuProvider, ISerializePreferences, IStandardIgnoreList, IUsesSceneRaycast, IFunctionalitySubscriber<IProvidesSceneRaycast>, IFunctionalitySubscriber, IProvidesSnapping, IFunctionalityProvider

Properties

groundSnappingEnabled

Declaration

public bool groundSnappingEnabled { get; set; }

Property Value

Type	Description
Boolean

ignoreList

Declaration

public List<GameObject> ignoreList { set; }

Property Value

Type	Description
List<GameObject>

Implements

IStandardIgnoreList.ignoreList

initializationOrder

Declaration

public int initializationOrder { get; }

Property Value

Type	Description
Int32

Implements

IDelayedInitializationModule.initializationOrder

rayOrigin

Declaration

public Transform rayOrigin { get; }

Property Value

Type	Description
Transform

Implements

ISettingsMenuProvider.rayOrigin

settingsMenuInstance

Declaration

public GameObject settingsMenuInstance { set; }

Property Value

Type	Description
GameObject

Implements

ISettingsMenuProvider.settingsMenuInstance

settingsMenuPrefab

Declaration

public GameObject settingsMenuPrefab { get; }

Property Value

Type	Description
GameObject

Implements

ISettingsMenuProvider.settingsMenuPrefab

shutdownOrder

Declaration

public int shutdownOrder { get; }

Property Value

Type	Description
Int32

Implements

IDelayedInitializationModule.shutdownOrder

Methods

ClearSnappingState(Transform)

Declaration

public void ClearSnappingState(Transform rayOrigin)

Parameters

Type	Name	Description
Transform	rayOrigin

Implements

IProvidesSnapping.ClearSnappingState(Transform)

ConnectSubscriber(Object)

Declaration

public void ConnectSubscriber(object obj)

Parameters

Type	Name	Description
Object	obj

Implements

IFunctionalityProvider.ConnectSubscriber(Object)

DirectSnap(Transform, Transform, ref Vector3, ref Quaternion, Vector3, Quaternion)

Declaration

public bool DirectSnap(Transform rayOrigin, Transform transform, ref Vector3 position, ref Quaternion rotation, Vector3 targetPosition, Quaternion targetRotation)

Parameters

Type	Name	Description
Transform	rayOrigin
Transform	transform
Vector3	position
Quaternion	rotation
Vector3	targetPosition
Quaternion	targetRotation

Returns

Type	Description
Boolean

Implements

IProvidesSnapping.DirectSnap(Transform, Transform, ref Vector3, ref Quaternion, Vector3, Quaternion)

Initialize()

Declaration

public void Initialize()

Implements

IDelayedInitializationModule.Initialize()

LoadModule()

Declaration

public void LoadModule()

Implements

IModule.LoadModule()

LoadProvider()

Declaration

public void LoadProvider()

Implements

IFunctionalityProvider.LoadProvider()

ManipulatorSnap(Transform, Transform[], ref Vector3, ref Quaternion, Vector3, AxisFlags, PivotMode)

Declaration

public bool ManipulatorSnap(Transform rayOrigin, Transform[] transforms, ref Vector3 position, ref Quaternion rotation, Vector3 delta, AxisFlags constraints, PivotMode pivotMode)

Parameters

Type	Name	Description
Transform	rayOrigin
Transform[]	transforms
Vector3	position
Quaternion	rotation
Vector3	delta
AxisFlags	constraints
PivotMode	pivotMode

Returns

Type	Description
Boolean

Implements

IProvidesSnapping.ManipulatorSnap(Transform, Transform[], ref Vector3, ref Quaternion, Vector3, AxisFlags, PivotMode)

OnBehaviorAwake()

Declaration

public void OnBehaviorAwake()

Implements

IModuleBehaviorCallbacks.OnBehaviorAwake()

OnBehaviorDestroy()

Declaration

public void OnBehaviorDestroy()

Implements

IModuleBehaviorCallbacks.OnBehaviorDestroy()

OnBehaviorDisable()

Declaration

public void OnBehaviorDisable()

Implements

IModuleBehaviorCallbacks.OnBehaviorDisable()

OnBehaviorEnable()

Declaration

public void OnBehaviorEnable()

Implements

IModuleBehaviorCallbacks.OnBehaviorEnable()

OnBehaviorStart()

Declaration

public void OnBehaviorStart()

Implements

IModuleBehaviorCallbacks.OnBehaviorStart()

OnBehaviorUpdate()

Declaration

public void OnBehaviorUpdate()

Implements

IModuleBehaviorCallbacks.OnBehaviorUpdate()

OnDeserializePreferences(Object)

Declaration

public void OnDeserializePreferences(object obj)

Parameters

Type	Name	Description
Object	obj

OnSerializePreferences()

Declaration

public object OnSerializePreferences()

Returns

Type	Description
Object

Shutdown()

Declaration

public void Shutdown()

Implements

IDelayedInitializationModule.Shutdown()

UnloadModule()

Declaration

public void UnloadModule()

Implements

IModule.UnloadModule()

UnloadProvider()

Declaration

public void UnloadProvider()

Implements

IFunctionalityProvider.UnloadProvider()

Explicit Interface Implementations

IFunctionalitySubscriber<IProvidesSceneRaycast>.provider

Declaration

IProvidesSceneRaycast IFunctionalitySubscriber<IProvidesSceneRaycast>.provider { get; set; }

Returns

Type	Description
IProvidesSceneRaycast

Implements

IFunctionalitySubscriber<TProvider>.provider

IFunctionalitySubscriber<IProvidesViewerScale>.provider

Declaration

IProvidesViewerScale IFunctionalitySubscriber<IProvidesViewerScale>.provider { get; set; }

Returns

Type	Description
IProvidesViewerScale

Implements

IFunctionalitySubscriber<TProvider>.provider

Extension Methods

UsesSceneRaycastMethods.Raycast(IUsesSceneRaycast, Ray, out RaycastHit, out GameObject, Single, List<GameObject>)

UsesViewerScaleMethods.GetViewerScale(IUsesViewerScale)

UsesViewerScaleMethods.SetViewerScale(IUsesViewerScale, Single)