BoundsHandleInteractable Class

Definition

Namespace:: MixedReality.Toolkit.SpatialManipulation

Assembly:: MixedReality.Toolkit.SpatialManipulation.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.

An interactable for the handles of a BoundsControl. Scale handles subclass this to implement custom occlusion + reorientation logic.

[UnityEngine.AddComponentMenu("MRTK/Spatial Manipulation/Bounds Handle Interactable")]
public class BoundsHandleInteractable : MixedReality.Toolkit.StatefulInteractable, MixedReality.Toolkit.ISnapInteractable

[<UnityEngine.AddComponentMenu("MRTK/Spatial Manipulation/Bounds Handle Interactable")>]
type BoundsHandleInteractable = class
    inherit StatefulInteractable
    interface ISnapInteractable

Public Class BoundsHandleInteractable
Inherits StatefulInteractable
Implements ISnapInteractable

Inheritance: UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable

MRTKBaseInteractable

StatefulInteractable
BoundsHandleInteractable

Attributes: UnityEngine.AddComponentMenuAttribute

Implements: ISnapInteractable

Constructors

Name	Description
BoundsHandleInteractable()

Properties

Name	Description
BoundsControlRoot	Reference to the BoundsControl that is associated with this handle.
FlattenVector	The vector/direction along which the bounds should be flattened. Set by the box visuals script; it controls which handles are hidden when the bounds are flattened to a 2D/slate shape. Has no effect if/when IsFlattened is false!
HandleTransform	Called by interactors to query which exact transform on an interactable should be considered the snappable affordance.
HandleType	This handle's handle type.
IsFlattened	Whether the parent bounds is flattened or not. If true, FlattenVector is used to determine which axis to flatten along (and, accordingly, which handles to hide!)
IsOccluded	Is this handle currently occluded or hidden? Some handles are designed to occlude themselves in certain bounding box orientations and perspectives.
MaintainGlobalSize	Should the handle maintain its global size, even as the object changes size?

Methods

Name	Description
Awake()	A Unity event function that is called when an enabled script instance is being loaded.
HideOnStartup()	Obsolete. Occludes the handle so it is not initially visible when it should start disabled.
LateUpdate()	A Unity event function that is called every frame after normal update functions, if this object is enabled.
OnSelectEntered(SelectEnterEventArgs)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.OnSelectEntered(UnityEngine.XR.Interaction.Toolkit.SelectEnterEventArgs)
OnSelectExited(SelectExitEventArgs)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.OnSelectExited(UnityEngine.XR.Interaction.Toolkit.SelectExitEventArgs)
Start()	A Unity event function that is called on the frame when a script is enabled just before any of the update methods are called the first time.

Applies to