RotationAxisConstraint Class

Definition

Namespace:

MixedReality.Toolkit.SpatialManipulation

Assembly:

MixedReality.Toolkit.SpatialManipulation.dll

Component for limiting the rotation axes for ObjectManipulator or BoundsControl components.

public class RotationAxisConstraint : MixedReality.Toolkit.SpatialManipulation.TransformConstraint

type RotationAxisConstraint = class
    inherit TransformConstraint

Public Class RotationAxisConstraint
Inherits TransformConstraint

Inheritance

UnityEngine.MonoBehaviour

TransformConstraint

RotationAxisConstraint

Remarks

The constraint system might be reworked in the future. In such a case, these existing components will be deprecated.

Constructors

Name	Description
RotationAxisConstraint()

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
ConstraintOnRotation	Constrain rotation about an axis
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)
UseLocalSpaceForConstraint	Gets or sets whether the constraints should be applied in local space of the object being manipulated or world space.

Methods

Name	Description
ApplyConstraint(MixedRealityTransform)	Removes rotation about given axis if its flag is found in ConstraintOnRotation
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. (Inherited from TransformConstraint)
Setup(MixedRealityTransform)	Called once before any constraints are computed. (Inherited from TransformConstraint)