FixedDistanceConstraint Class

Definition

Namespace:

MixedReality.Toolkit.SpatialManipulation

Assembly:

MixedReality.Toolkit.SpatialManipulation.dll

Component for setting the min/max scale values for ObjectManipulator or BoundsControl.

public class FixedDistanceConstraint : MixedReality.Toolkit.SpatialManipulation.TransformConstraint

type FixedDistanceConstraint = class
    inherit TransformConstraint

Public Class FixedDistanceConstraint
Inherits TransformConstraint

Inheritance

UnityEngine.MonoBehaviour

TransformConstraint

FixedDistanceConstraint

Remarks

MRTK's constraint system might be redesigned in the near future. When this occurs, the old constraint components will be deprecated.

Constructors

Name	Description
FixedDistanceConstraint()

Fields

Name	Description
InitialWorldPose	The initial world pose before any manipulations. (Inherited from TransformConstraint)
WorldPoseOnManipulationStart	The world pose of the object when the manipulation began. (Inherited from TransformConstraint)

Properties

Name	Description
ConstraintTransform	Transform to fix distance to. Defaults to the head.
ConstraintType	Get flags that describe the type of transformations this constraint applies to.
ExecutionPriority	Execution order priority of this constraint. Lower numbers will be executed before higher numbers. (Inherited from TransformConstraint)
HandType	Whether this constraint applies to one hand manipulation, two hand manipulation or both (Inherited from TransformConstraint)
ProximityType	Whether this constraint applies to near manipulation, far manipulation or both (Inherited from TransformConstraint)

Methods

Name	Description
ApplyConstraint(MixedRealityTransform)	Constrains position such that the distance between pose and the ConstraintTransform does not change from manipulation start
OnDisable()	A Unity event function that is called when the script component has been disabled. (Inherited from TransformConstraint)
OnEnable()	A Unity event function that is called when the script component has been enabled. (Inherited from TransformConstraint)
OnManipulationStarted(MixedRealityTransform)	Called when manipulation starts on the attached object.
Setup(MixedRealityTransform)	Called once before any constraints are computed. (Inherited from TransformConstraint)