Class BaseMixedRealityLineDataProvider

Base class that provides data about a line.

Inheritance

Object

BaseMixedRealityLineDataProvider

BezierDataProvider

EllipseLineDataProvider

ParabolaLineDataProvider

RectangleLineDataProvider

SimpleLineDataProvider

SplineDataProvider

Namespace: Microsoft.MixedReality.Toolkit.Utilities

Assembly: cs.temp.dll.dll

Syntax

public abstract class BaseMixedRealityLineDataProvider : MonoBehaviour

Remarks

Data to be consumed by other classes like the BaseMixedRealityLineRenderer

Fields

UnclampedWorldLengthSearchSteps

Declaration

protected const int UnclampedWorldLengthSearchSteps = 10

Field Value

Type	Description
Int32

Properties

Distorters

A list of distorters that apply to this line

Declaration

public IReadOnlyList<Distorter> Distorters { get; }

Property Value

Type	Description
IReadOnlyList<Distorter>

DistortionEnabled

Enabled / disables all distorters used by line.

Declaration

public bool DistortionEnabled { get; set; }

Property Value

Type	Description
Boolean

DistortionMode

NormalizedLength mode uses the DistortionStrength curve for distortion strength, Uniform uses UniformDistortionStrength along entire line

Declaration

public DistortionMode DistortionMode { get; set; }

Property Value

Type	Description
DistortionMode

DistortionStrength

Curve that defines distortion strength over distance, only used when DistortionMode = NormalizedLength

Declaration

public AnimationCurve DistortionStrength { get; set; }

Property Value

Type	Description
AnimationCurve

FirstPoint

Returns world position of first point along line as defined by this data provider

Declaration

public Vector3 FirstPoint { get; set; }

Property Value

Type	Description
Vector3

FlipUpVector

Reverses up vector when determining rotation along line

Declaration

public bool FlipUpVector { get; set; }

Property Value

Type	Description
Boolean

LastPoint

Returns world position of last point along line as defined by this data provider

Declaration

public Vector3 LastPoint { get; set; }

Property Value

Type	Description
Vector3

LineEndClamp

Clamps the line's normalized end point. This setting will affect line renderers.

Declaration

public float LineEndClamp { get; set; }

Property Value

Type	Description
Single

LineStartClamp

Clamps the line's normalized start point. This setting will affect line renderers.

Declaration

public float LineStartClamp { get; set; }

Property Value

Type	Description
Single

LineTransform

Transform to use when translating points from local to world space. If null, this object's transform is used.

Declaration

public Transform LineTransform { get; set; }

Property Value

Type	Description
Transform

Loops

Controls whether this line loops

Declaration

public virtual bool Loops { get; set; }

Property Value

Type	Description
Boolean

Remarks

Some classes override this setting.

ManualUpVectorBlend

The weight of manual up vectors in Velocity rotation mode

Declaration

public float ManualUpVectorBlend { get; set; }

Property Value

Type	Description
Single

ManualUpVectors

These vectors are used with ManualUpVectorBlend to determine rotation along the line in Velocity rotation mode. Vectors are distributed along the normalized length of the line.

Declaration

public Vector3[] ManualUpVectors { get; set; }

Property Value

Type	Description
Vector3[]

OriginOffset

Local space offset to transform position. Used to determine rotation along line in RelativeToOrigin rotation mode

Declaration

public Vector3 OriginOffset { get; set; }

Property Value

Type	Description
Vector3

PointCount

The number of points this line has.

Declaration

public abstract int PointCount { get; }

Property Value

Type	Description
Int32

RotationMode

The rotation mode used in the GetRotation function. You can visualize rotations by checking Draw Rotations under Editor Settings.

Declaration

public LineRotationMode RotationMode { get; set; }

Property Value

Type	Description
LineRotationMode

TransformMode

Defines how a base line data provider will transform its points

Declaration

public LinePointTransformMode TransformMode { get; set; }

Property Value

Type	Description
LinePointTransformMode

UnClampedWorldLength

Declaration

public float UnClampedWorldLength { get; }

Property Value

Type	Description
Single

UniformDistortionStrength

Float value that defines distortion strength uniformly over distance, only used when DistortionMode = Uniform

Declaration

public float UniformDistortionStrength { get; set; }

Property Value

Type	Description
Single

VelocitySearchRange

Used in Velocity rotation mode.

Declaration

public float VelocitySearchRange { get; set; }

Property Value

Type	Description
Single

Remarks

Smaller values are more accurate but more expensive

Methods

DrawUnselectedGizmosPreview()

Declaration

protected virtual void DrawUnselectedGizmosPreview()

GetClosestPoint(Vector3, Int32, Int32)

Iterates along line until it finds the point closest to worldPosition

Declaration

public Vector3 GetClosestPoint(Vector3 worldPosition, int resolution = 5, int maxIterations = 5)

Parameters

Type	Name	Description
Vector3	worldPosition
Int32	resolution
Int32	maxIterations

Returns

Type	Description
Vector3

GetNormalizedLengthFromWorldLength(Single, Int32)

Returns a normalized length corresponding to a world length Useful for determining LineStartClamp / LineEndClamp values

Declaration

public float GetNormalizedLengthFromWorldLength(float worldLength, int searchResolution = 10)

Parameters

Type	Name	Description
Single	worldLength
Int32	searchResolution

Returns

Type	Description
Single

GetNormalizedLengthFromWorldPos(Vector3, Int32, Int32)

Iterates along line until it finds the length closest to worldposition.

Declaration

public float GetNormalizedLengthFromWorldPos(Vector3 worldPosition, int resolution = 5, int maxIterations = 5)

Parameters

Type	Name	Description
Vector3	worldPosition
Int32	resolution
Int32	maxIterations

Returns

Type	Description
Single

GetPoint(Int32)

Gets a point along the line at the specified index

Declaration

public Vector3 GetPoint(int pointIndex)

Parameters

Type	Name	Description
Int32	pointIndex

Returns

Type	Description
Vector3

GetPoint(Single)

Gets a point along the line at the specified normalized length.

Declaration

public Vector3 GetPoint(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Vector3

GetPointInternal(Int32)

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

Declaration

protected abstract Vector3 GetPointInternal(int pointIndex)

Parameters

Type	Name	Description
Int32	pointIndex

Returns

Type	Description
Vector3

GetPointInternal(Single)

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

Declaration

protected abstract Vector3 GetPointInternal(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Vector3

GetRotation(Int32, LineRotationMode)

Gets the rotation of a point along the line at the specified index

Declaration

public Quaternion GetRotation(int pointIndex, LineRotationMode lineRotationMode = LineRotationMode.None)

Parameters

Type	Name	Description
Int32	pointIndex
LineRotationMode	lineRotationMode

Returns

Type	Description
Quaternion

GetRotation(Single, LineRotationMode)

Gets the rotation of a point along the line at the specified length

Declaration

public Quaternion GetRotation(float normalizedLength, LineRotationMode lineRotationMode = LineRotationMode.None)

Parameters

Type	Name	Description
Single	normalizedLength
LineRotationMode	lineRotationMode

Returns

Type	Description
Quaternion

GetUnClampedPoint(Single)

Gets a point along the line at the specified length without using LineStartClamp or LineEndClamp

Declaration

public Vector3 GetUnClampedPoint(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Vector3

GetUnClampedWorldLengthInternal()

Get the UnClamped world length of the line

Declaration

protected abstract float GetUnClampedWorldLengthInternal()

Returns

Type	Description
Single

GetUpVectorInternal(Single)

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

Declaration

protected virtual Vector3 GetUpVectorInternal(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Vector3

GetVelocity(Single)

Gets the velocity along the line

Declaration

public Vector3 GetVelocity(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Vector3

LateUpdate()

Declaration

protected virtual void LateUpdate()

OnEnable()

Declaration

protected virtual void OnEnable()

SetPoint(Int32, Vector3)

Sets a point in the line This function is not guaranteed to have an effect

Declaration

public void SetPoint(int pointIndex, Vector3 point)

Parameters

Type	Name	Description
Int32	pointIndex
Vector3	point

SetPointInternal(Int32, Vector3)

Sets the point at index.

Declaration

protected abstract void SetPointInternal(int pointIndex, Vector3 point)

Parameters

Type	Name	Description
Int32	pointIndex
Vector3	point

UpdateMatrix()

Declaration

public void UpdateMatrix()