Class Workspace
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
FaceMargin
Declaration
public const float FaceMargin = 0.025F
Field Value
HighlightMargin
Declaration
public const float HighlightMargin = 0.002F
Field Value
k_DoubleFaceMargin
Declaration
protected const float k_DoubleFaceMargin = 0.05F
Field Value
m_CustomStartingBounds
Declaration
protected Vector3? m_CustomStartingBounds
Field Value
m_LeftRayOrigin
Declaration
protected Transform m_LeftRayOrigin
Field Value
| Type |
Description |
| Transform |
|
m_MovePulse
Declaration
protected HapticPulse m_MovePulse
Field Value
m_RightRayOrigin
Declaration
protected Transform m_RightRayOrigin
Field Value
| Type |
Description |
| Transform |
|
m_WorkspaceUI
Declaration
protected WorkspaceUI m_WorkspaceUI
Field Value
MinBounds
Declaration
public static readonly Vector3 MinBounds
Field Value
Properties
actionMap
Declaration
public ActionMap actionMap { get; }
Property Value
Implements
contentBounds
Declaration
public Bounds contentBounds { get; set; }
Property Value
Implements
dynamicFaceAdjustment
If true, allow the front face of the workspace to dynamically adjust its angle when rotated
Declaration
public bool dynamicFaceAdjustment { set; }
Property Value
frontPanel
Declaration
public Transform frontPanel { get; }
Property Value
| Type |
Description |
| Transform |
|
Declaration
public bool ignoreActionMapInputLocking { get; }
Property Value
Implements
leftNode
Declaration
protected Node leftNode { get; set; }
Property Value
leftRayOrigin
Declaration
public Transform leftRayOrigin { protected get; set; }
Property Value
| Type |
Description |
| Transform |
|
minBounds
Declaration
public Vector3 minBounds { get; set; }
Property Value
outerBounds
Declaration
public Bounds outerBounds { get; }
Property Value
Implements
preventResize
If true, prevent the resizing of a workspace
Declaration
public bool preventResize { set; }
Property Value
rightNode
Declaration
protected Node rightNode { get; set; }
Property Value
rightRayOrigin
Declaration
public Transform rightRayOrigin { protected get; set; }
Property Value
| Type |
Description |
| Transform |
|
stencilRef
Declaration
public byte stencilRef { get; set; }
Property Value
Implements
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
vacuumBounds
Declaration
public Bounds vacuumBounds { get; }
Property Value
Implements
Methods
Close()
Declaration
Implements
OnBoundsChanged()
Declaration
protected virtual void OnBoundsChanged()
Declaration
protected void OnButtonClicked(Transform rayOrigin)
Parameters
| Type |
Name |
Description |
| Transform |
rayOrigin |
|
Declaration
protected void OnButtonHovered(Transform rayOrigin)
Parameters
| Type |
Name |
Description |
| Transform |
rayOrigin |
|
Declaration
protected virtual void OnCloseClicked(Transform rayOrigin)
Parameters
| Type |
Name |
Description |
| Transform |
rayOrigin |
|
OnDestroy()
Declaration
protected virtual void OnDestroy()
Declaration
protected virtual void OnResetClicked(Transform rayOrigin)
Parameters
| Type |
Name |
Description |
| Transform |
rayOrigin |
|
Declaration
public virtual void ProcessInput(ActionMapInput input, ConsumeControlDelegate consumeControl)
Parameters
Implements
SetUIHighlightsVisible(Boolean)
Declaration
public void SetUIHighlightsVisible(bool value)
Parameters
| Type |
Name |
Description |
| Boolean |
value |
|
Setup()
Declaration
public virtual void Setup()
Implements
Events
destroyed
Declaration
public event Action<IWorkspace> destroyed
Event Type
Implements
Explicit Interface Implementations
IFunctionalitySubscriber<IProvidesConnectInterfaces>.provider
Declaration
IProvidesConnectInterfaces IFunctionalitySubscriber<IProvidesConnectInterfaces>.provider { get; set; }
Returns
Implements
IFunctionalitySubscriber<IProvidesControlHaptics>.provider
Declaration
IProvidesControlHaptics IFunctionalitySubscriber<IProvidesControlHaptics>.provider { get; set; }
Returns
Implements
IFunctionalitySubscriber<IProvidesViewerScale>.provider
Declaration
IProvidesViewerScale IFunctionalitySubscriber<IProvidesViewerScale>.provider { get; set; }
Returns
Implements
IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider
Declaration
IProvidesFunctionalityInjection IFunctionalitySubscriber<IProvidesFunctionalityInjection>.provider { get; set; }
Returns
Implements
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.