Dockable Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Experimental.UI

Assembly:: Microsoft.MixedReality.Toolkit.SDK.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Add a Dockable component to any object that has a Dockable and an ObjectManipulator or ManipulationHandler to make it dockable in Docks. That allows this object to be used as part of a palette, shelf or navigation bar together with other objects.

public ref class Dockable : UnityEngine::MonoBehaviour

[UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Dock/Dockable")]
public class Dockable : UnityEngine.MonoBehaviour

[<UnityEngine.AddComponentMenu("Scripts/MRTK/Experimental/Dock/Dockable")>]
type Dockable = class
    inherit MonoBehaviour

Public Class Dockable
Inherits MonoBehaviour

Inheritance: UnityEngine.MonoBehaviour
Dockable

Attributes: UnityEngine.AddComponentMenuAttribute

Constructors

Dockable()

Properties

CanDock	True if this object can currently be docked, false otherwise.
CanUndock	True if this object can currently be undocked, false otherwise.

Methods

Dock(DockPosition)	Docks this object in a given DockPosition.
Undock()	Undocks this Dockable from the current DockPosition where it is docked.
Update()	Updates the transform and state of this object every frame, depending on manipulations and docking state.

Applies to