We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

    Show / Hide Table of Contents

    Class SimpleLineDataProvider

    A simple line with two points.

    Inheritance
    Object
    BaseMixedRealityLineDataProvider
    SimpleLineDataProvider
    Inherited Members
    BaseMixedRealityLineDataProvider.UnclampedWorldLengthSearchSteps
    BaseMixedRealityLineDataProvider.UnClampedWorldLength
    BaseMixedRealityLineDataProvider.LineStartClamp
    BaseMixedRealityLineDataProvider.LineEndClamp
    BaseMixedRealityLineDataProvider.LineTransform
    BaseMixedRealityLineDataProvider.Loops
    BaseMixedRealityLineDataProvider.TransformMode
    BaseMixedRealityLineDataProvider.RotationMode
    BaseMixedRealityLineDataProvider.FlipUpVector
    BaseMixedRealityLineDataProvider.OriginOffset
    BaseMixedRealityLineDataProvider.ManualUpVectorBlend
    BaseMixedRealityLineDataProvider.ManualUpVectors
    BaseMixedRealityLineDataProvider.VelocitySearchRange
    BaseMixedRealityLineDataProvider.Distorters
    BaseMixedRealityLineDataProvider.DistortionEnabled
    BaseMixedRealityLineDataProvider.DistortionMode
    BaseMixedRealityLineDataProvider.DistortionStrength
    BaseMixedRealityLineDataProvider.UniformDistortionStrength
    BaseMixedRealityLineDataProvider.FirstPoint
    BaseMixedRealityLineDataProvider.LastPoint
    BaseMixedRealityLineDataProvider.OnEnable()
    BaseMixedRealityLineDataProvider.LateUpdate()
    BaseMixedRealityLineDataProvider.GetNormalizedLengthFromWorldLength(Single, Int32)
    BaseMixedRealityLineDataProvider.GetVelocity(Single)
    BaseMixedRealityLineDataProvider.GetRotation(Single, LineRotationMode)
    BaseMixedRealityLineDataProvider.GetRotation(Int32, LineRotationMode)
    BaseMixedRealityLineDataProvider.GetPoint(Single)
    BaseMixedRealityLineDataProvider.GetUnClampedPoint(Single)
    BaseMixedRealityLineDataProvider.GetPoint(Int32)
    BaseMixedRealityLineDataProvider.SetPoint(Int32, Vector3)
    BaseMixedRealityLineDataProvider.GetClosestPoint(Vector3, Int32, Int32)
    BaseMixedRealityLineDataProvider.GetNormalizedLengthFromWorldPos(Vector3, Int32, Int32)
    BaseMixedRealityLineDataProvider.UpdateMatrix()
    BaseMixedRealityLineDataProvider.DrawUnselectedGizmosPreview()
    Namespace: Microsoft.MixedReality.Toolkit.Utilities
    Assembly: cs.temp.dll.dll
    Syntax
    public class SimpleLineDataProvider : BaseMixedRealityLineDataProvider

    Properties

    EndPoint

    The point where this line will end.

    Declaration
    public MixedRealityPose EndPoint { get; set; }
    Property Value
    Type Description
    MixedRealityPose

    PointCount

    The number of points this line has.

    Declaration
    public override int PointCount { get; }
    Property Value
    Type Description
    Int32
    Overrides
    BaseMixedRealityLineDataProvider.PointCount

    StartPoint

    The Starting point of this line.

    Declaration
    public MixedRealityPose StartPoint { get; }
    Property Value
    Type Description
    MixedRealityPose
    Remarks

    Always located at this GameObject's Transform.position

    Methods

    GetPointInternal(Int32)

    Get a point based on point index Point index will be pre-clamped

    Declaration
    protected override Vector3 GetPointInternal(int pointIndex)
    Parameters
    Type Name Description
    Int32 pointIndex
    Returns
    Type Description
    Vector3
    Overrides
    BaseMixedRealityLineDataProvider.GetPointInternal(Int32)

    GetPointInternal(Single)

    Get a point based on normalized distance along line Normalized distance will be pre-clamped

    Declaration
    protected override Vector3 GetPointInternal(float normalizedDistance)
    Parameters
    Type Name Description
    Single normalizedDistance
    Returns
    Type Description
    Vector3
    Overrides
    BaseMixedRealityLineDataProvider.GetPointInternal(Single)

    GetUnClampedWorldLengthInternal()

    Get the UnClamped world length of the line

    Declaration
    protected override float GetUnClampedWorldLengthInternal()
    Returns
    Type Description
    Single
    Overrides
    BaseMixedRealityLineDataProvider.GetUnClampedWorldLengthInternal()

    GetUpVectorInternal(Single)

    Gets the up vector at a normalized length along line (used for rotation)

    Declaration
    protected override Vector3 GetUpVectorInternal(float normalizedLength)
    Parameters
    Type Name Description
    Single normalizedLength
    Returns
    Type Description
    Vector3
    Overrides
    BaseMixedRealityLineDataProvider.GetUpVectorInternal(Single)

    SetPointInternal(Int32, Vector3)

    Sets the point at index.

    Declaration
    protected override void SetPointInternal(int pointIndex, Vector3 point)
    Parameters
    Type Name Description
    Int32 pointIndex
    Vector3 point
    Overrides
    BaseMixedRealityLineDataProvider.SetPointInternal(Int32, Vector3)
    Back to top Generated by DocFX