Class Workspace | Unity Reflect | 1.0.0-preview.11
docs.unity3d.com
    Show / Hide Table of Contents

    Class Workspace

    Inheritance
    Object
    Workspace
    MiniWorldWorkspace
    Namespace: UnityEditor.Experimental.EditorVR.Workspaces
    Syntax
    public abstract class Workspace : MonoBehaviour, IWorkspace, IVacuumable, ICustomActionMap, IProcessInput, IInstantiateUI, IUsesStencilRef, IUsesConnectInterfaces, IFunctionalitySubscriber<IProvidesConnectInterfaces>, IUsesViewerScale, IFunctionalitySubscriber<IProvidesViewerScale>, IUsesControlHaptics, IFunctionalitySubscriber<IProvidesControlHaptics>, IRayToNode, IUsesFunctionalityInjection, IFunctionalitySubscriber<IProvidesFunctionalityInjection>, IFunctionalitySubscriber

    Fields

    DefaultBounds

    Declaration
    public static readonly Vector3 DefaultBounds
    Field Value
    Type Description
    Vector3

    FaceMargin

    Declaration
    public const float FaceMargin = 0.025F
    Field Value
    Type Description
    Single

    HighlightMargin

    Declaration
    public const float HighlightMargin = 0.002F
    Field Value
    Type Description
    Single

    k_DoubleFaceMargin

    Declaration
    protected const float k_DoubleFaceMargin = 0.05F
    Field Value
    Type Description
    Single

    m_CustomStartingBounds

    Declaration
    protected Vector3? m_CustomStartingBounds
    Field Value
    Type Description
    Nullable<Vector3>

    m_LeftRayOrigin

    Declaration
    protected Transform m_LeftRayOrigin
    Field Value
    Type Description
    Transform

    m_MovePulse

    Declaration
    protected HapticPulse m_MovePulse
    Field Value
    Type Description
    HapticPulse

    m_RightRayOrigin

    Declaration
    protected Transform m_RightRayOrigin
    Field Value
    Type Description
    Transform

    m_WorkspaceUI

    Declaration
    protected WorkspaceUI m_WorkspaceUI
    Field Value
    Type Description
    WorkspaceUI

    MinBounds

    Declaration
    public static readonly Vector3 MinBounds
    Field Value
    Type Description
    Vector3

    Properties

    actionMap

    Declaration
    public ActionMap actionMap { get; }
    Property Value
    Type Description
    ActionMap
    Implements
    ICustomActionMap.actionMap

    contentBounds

    Declaration
    public Bounds contentBounds { get; set; }
    Property Value
    Type Description
    Bounds
    Implements
    IWorkspace.contentBounds

    dynamicFaceAdjustment

    If true, allow the front face of the workspace to dynamically adjust its angle when rotated

    Declaration
    public bool dynamicFaceAdjustment { set; }
    Property Value
    Type Description
    Boolean

    frontPanel

    Declaration
    public Transform frontPanel { get; }
    Property Value
    Type Description
    Transform

    ignoreActionMapInputLocking

    Declaration
    public bool ignoreActionMapInputLocking { get; }
    Property Value
    Type Description
    Boolean
    Implements
    ICustomActionMap.ignoreActionMapInputLocking

    leftNode

    Declaration
    protected Node leftNode { get; set; }
    Property Value
    Type Description
    Node

    leftRayOrigin

    Declaration
    public Transform leftRayOrigin { protected get; set; }
    Property Value
    Type Description
    Transform

    minBounds

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

    outerBounds

    Declaration
    public Bounds outerBounds { get; }
    Property Value
    Type Description
    Bounds
    Implements
    IWorkspace.outerBounds

    preventResize

    If true, prevent the resizing of a workspace

    Declaration
    public bool preventResize { set; }
    Property Value
    Type Description
    Boolean

    rightNode

    Declaration
    protected Node rightNode { get; set; }
    Property Value
    Type Description
    Node

    rightRayOrigin

    Declaration
    public Transform rightRayOrigin { protected get; set; }
    Property Value
    Type Description
    Transform

    stencilRef

    Declaration
    public byte stencilRef { get; set; }
    Property Value
    Type Description
    Byte
    Implements
    IUsesStencilRef.stencilRef

    topPanel

    Declaration
    public Transform topPanel { get; }
    Property Value
    Type Description
    Transform

    topPanelDividerOffset

    (-1 to 1) ranged value that controls the separator mask's X-offset placement A value of zero will leave the mask in the center of the workspace

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

    vacuumBounds

    Declaration
    public Bounds vacuumBounds { get; }
    Property Value
    Type Description
    Bounds
    Implements
    IVacuumable.vacuumBounds

    Methods

    Close()

    Declaration
    public void Close()
    Implements
    IWorkspace.Close()

    OnBoundsChanged()

    Declaration
    protected virtual void OnBoundsChanged()

    OnButtonClicked(Transform)

    Declaration
    protected void OnButtonClicked(Transform rayOrigin)
    Parameters
    Type Name Description
    Transform rayOrigin

    OnButtonHovered(Transform)

    Declaration
    protected void OnButtonHovered(Transform rayOrigin)
    Parameters
    Type Name Description
    Transform rayOrigin

    OnCloseClicked(Transform)

    Declaration
    protected virtual void OnCloseClicked(Transform rayOrigin)
    Parameters
    Type Name Description
    Transform rayOrigin

    OnDestroy()

    Declaration
    protected virtual void OnDestroy()

    OnResetClicked(Transform)

    Declaration
    protected virtual void OnResetClicked(Transform rayOrigin)
    Parameters
    Type Name Description
    Transform rayOrigin

    ProcessInput(ActionMapInput, ConsumeControlDelegate)

    Declaration
    public virtual void ProcessInput(ActionMapInput input, ConsumeControlDelegate consumeControl)
    Parameters
    Type Name Description
    ActionMapInput input
    ConsumeControlDelegate consumeControl
    Implements
    IProcessInput.ProcessInput(ActionMapInput, ConsumeControlDelegate)

    SetUIHighlightsVisible(Boolean)

    Declaration
    public void SetUIHighlightsVisible(bool value)
    Parameters
    Type Name Description
    Boolean value

    Setup()

    Declaration
    public virtual void Setup()
    Implements
    IWorkspace.Setup()

    Events

    destroyed

    Declaration
    public event Action<IWorkspace> destroyed
    Event Type
    Type Description
    Action<IWorkspace>
    Implements
    IWorkspace.destroyed

    Explicit Interface Implementations

    IFunctionalitySubscriber<IProvidesConnectInterfaces>.provider

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

    IFunctionalitySubscriber<IProvidesControlHaptics>.provider

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

    IFunctionalitySubscriber<IProvidesViewerScale>.provider

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

    IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider

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

    Extension Methods

    IInstantiateUIMethods.InstantiateUI(IInstantiateUI, GameObject, Transform, Boolean, Transform)
    IUsesFunctionalityInjectionMethods.InjectFunctionality(IUsesFunctionalityInjection, List<Object>)
    IUsesFunctionalityInjectionMethods.InjectFunctionalitySingle(IUsesFunctionalityInjection, Object)
    IUsesFunctionalityInjectionMethods.InjectPreparedFunctionality(IUsesFunctionalityInjection, List<Object>)
    UsesConnectInterfacesMethods.ConnectInterfaces(IUsesConnectInterfaces, Object, Object)
    UsesConnectInterfacesMethods.DisconnectInterfaces(IUsesConnectInterfaces, Object, Object)
    UsesControlHapticsMethods.Pulse(IUsesControlHaptics, Node, HapticPulse, Single, Single)
    UsesControlHapticsMethods.StopPulses(IUsesControlHaptics, Node)
    UsesViewerScaleMethods.GetViewerScale(IUsesViewerScale)
    UsesViewerScaleMethods.SetViewerScale(IUsesViewerScale, Single)
    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