Edit

Share via


BaseMixedRealityLineDataProvider Class

Definition

Base class that provides data about a line.

public ref class BaseMixedRealityLineDataProvider abstract : UnityEngine::MonoBehaviour
[UnityEngine.ExecuteAlways]
public abstract class BaseMixedRealityLineDataProvider : UnityEngine.MonoBehaviour
[<UnityEngine.ExecuteAlways>]
type BaseMixedRealityLineDataProvider = class
    inherit MonoBehaviour
Public MustInherit Class BaseMixedRealityLineDataProvider
Inherits MonoBehaviour
Inheritance
UnityEngine.MonoBehaviour
BaseMixedRealityLineDataProvider
Derived
Attributes
UnityEngine.ExecuteAlwaysAttribute

Remarks

Data to be consumed by other classes like the BaseMixedRealityLineRenderer

Constructors

BaseMixedRealityLineDataProvider()

Fields

UnclampedWorldLengthSearchSteps

Properties

Distorters

A list of distorters that apply to this line

DistortionEnabled

Enabled / disables all distorters used by line.

DistortionMode

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

DistortionStrength

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

FirstPoint

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

FlipUpVector

Reverses up vector when determining rotation along line

LastPoint

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

LineEndClamp

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

LineStartClamp

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

LineTransform

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

Loops

Controls whether this line loops

ManualUpVectorBlend

The weight of manual up vectors in Velocity rotation mode

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.

OriginOffset

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

PointCount

The number of points this line has.

RotationMode

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

TransformMode

Defines how a base line data provider will transform its points

UnClampedWorldLength
UniformDistortionStrength

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

VelocitySearchRange

Used in Velocity rotation mode.

Methods

DrawUnselectedGizmosPreview()
GetClosestPoint(Vector3, Int32, Int32)

Iterates along line until it finds the point closest to worldPosition

GetNormalizedLengthFromWorldLength(Single, Int32)

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

GetNormalizedLengthFromWorldPos(Vector3, Int32, Int32)

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

GetPoint(Int32)

Gets a point along the line at the specified index

GetPoint(Single)

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

GetPointInternal(Int32)

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

GetPointInternal(Single)

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

GetRotation(Int32, LineRotationMode)

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

GetRotation(Single, LineRotationMode)

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

GetUnClampedPoint(Single)

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

GetUnClampedWorldLengthInternal()

Get the UnClamped world length of the line

GetUpVectorInternal(Single)

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

GetVelocity(Single)

Gets the velocity along the line

LateUpdate()
OnEnable()
SetPoint(Int32, Vector3)

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

SetPointInternal(Int32, Vector3)

Sets the point at index.

UpdateMatrix()

Applies to