We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

Search Results for

    Show / Hide Table of Contents

    Class DockPosition

    Represents a position where a Dockable object can be docked. This component also adds a Collider and a Rigidbody, if they're not already present.

    Inheritance
    Object
    DockPosition
    Namespace: Microsoft.MixedReality.Toolkit.Experimental.UI
    Assembly: cs.temp.dll.dll
    Syntax
    public class DockPosition : MonoBehaviour

    Properties

    DockedObject

    The object that is currently docked in this position (can be null).

    Declaration
    public Dockable DockedObject { get; set; }
    Property Value
    Type Description
    Dockable

    IsOccupied

    True if this position is occupied, false otherwise.

    Declaration
    public bool IsOccupied { get; }
    Property Value
    Type Description
    Boolean

    Methods

    Awake()

    Ensure this object has a triggering collider, and ensure that this object doesn't block manipulations.

    Declaration
    public void Awake()

    Start()

    If an object was set to be docked to this at start up, ensure it's docked.

    Declaration
    public void Start()

    See Also

    Dock
    Dockable
    In This Article
    Back to top Generated by DocFX