mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class TransformConstraint

    Base class for all constraints

    Inheritance
    Object
    TransformConstraint
    FaceUserConstraint
    FixedDistanceConstraint
    FixedRotationToUserConstraint
    FixedRotationToWorldConstraint
    MaintainApparentSizeConstraint
    MinMaxScaleConstraint
    MoveAxisConstraint
    RotationAxisConstraint
    Namespace: Microsoft.MixedReality.Toolkit.UI
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class TransformConstraint : MonoBehaviour

    Fields

    worldPoseOnManipulationStart

    Declaration
    protected MixedRealityPose worldPoseOnManipulationStart
    Field Value
    Type Description
    MixedRealityPose

    Properties

    ConstraintType

    Declaration
    public abstract TransformFlags ConstraintType { get; }
    Property Value
    Type Description
    TransformFlags

    HandType

    Whether this constraint applies to one hand manipulation, two hand manipulation or both

    Declaration
    public ManipulationHandFlags HandType { get; set; }
    Property Value
    Type Description
    ManipulationHandFlags

    ProximityType

    Whether this constraint applies to near manipulation, far manipulation or both

    Declaration
    public ManipulationProximityFlags ProximityType { get; set; }
    Property Value
    Type Description
    ManipulationProximityFlags

    TargetTransform

    Transform that we intend to apply constraints to

    Declaration
    public Transform TargetTransform { get; set; }
    Property Value
    Type Description
    Transform

    Methods

    ApplyConstraint(ref MixedRealityTransform)

    Abstract method for applying constraints to transforms during manipulation

    Declaration
    public abstract void ApplyConstraint(ref MixedRealityTransform transform)
    Parameters
    Type Name Description
    MixedRealityTransform transform

    Initialize(MixedRealityPose)

    Intended to be called on manipulation started

    Declaration
    public virtual void Initialize(MixedRealityPose worldPose)
    Parameters
    Type Name Description
    MixedRealityPose worldPose

    Start()

    Declaration
    public virtual void Start()
    In This Article
    • Fields
      • worldPoseOnManipulationStart
    • Properties
      • ConstraintType
      • HandType
      • ProximityType
      • TargetTransform
    • Methods
      • ApplyConstraint(ref MixedRealityTransform)
      • Initialize(MixedRealityPose)
      • Start()
    Back to top Generated by DocFX