Class Dockable

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.

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

Properties

CanDock

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

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

CanUndock

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

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

Methods

Dock(DockPosition)

Docks this object in a given DockPosition.

Declaration
public void Dock(DockPosition position)
Parameters
Type Name Description
DockPosition position

The DockPosition where we'd like to dock this object.

Undock()

Undocks this Dockable from the current DockPosition where it is docked.

Declaration
public void Undock()

Update()

Updates the transform and state of this object every frame, depending on manipulations and docking state.

Declaration
public void Update()

See Also