Edit

Share via


MixedRealityLineRenderer Class

Definition

Implements Unity's built in line renderer component, and applies the line data to it.

public ref class MixedRealityLineRenderer : Microsoft::MixedReality::Toolkit::Utilities::BaseMixedRealityLineRenderer
[UnityEngine.AddComponentMenu("Scripts/MRTK/Core/MixedRealityLineRenderer")]
[UnityEngine.RequireComponent(typeof(UnityEngine.LineRenderer))]
public class MixedRealityLineRenderer : Microsoft.MixedReality.Toolkit.Utilities.BaseMixedRealityLineRenderer
[<UnityEngine.AddComponentMenu("Scripts/MRTK/Core/MixedRealityLineRenderer")>]
[<UnityEngine.RequireComponent(typeof(UnityEngine.LineRenderer))>]
type MixedRealityLineRenderer = class
    inherit BaseMixedRealityLineRenderer
Public Class MixedRealityLineRenderer
Inherits BaseMixedRealityLineRenderer
Inheritance
UnityEngine.MonoBehaviour
MixedRealityLineRenderer
Attributes
UnityEngine.AddComponentMenuAttribute UnityEngine.RequireComponentAttribute

Constructors

MixedRealityLineRenderer()

Fields

lineDataSource (Inherited from BaseMixedRealityLineRenderer)

Properties

ColorOffset

Normalized offset for color gradient

(Inherited from BaseMixedRealityLineRenderer)
FadeLineAnimationTime

The amount the pointer line will fade if fadeLineBrightnessOnEnable is true"

FadeLineBrightnessOnEnable

Sets whether the ray line will animate to a lower brightness level on enable of this component

FadeLinePercentage

The amount the pointer line will fade if FadeLineBrightnessOnEnable is true"

LineColor

Color gradient applied to line's normalized length

(Inherited from BaseMixedRealityLineRenderer)
LineDataSource

The data provider component that provides the positioning source information for the LineRenderer.

(Inherited from BaseMixedRealityLineRenderer)
LineMaterial
LineStepCount

Number of steps to interpolate along line in Interpolated step mode

(Inherited from BaseMixedRealityLineRenderer)
LineWidth (Inherited from BaseMixedRealityLineRenderer)
PointDistributionMode

Method for distributing rendered points along line.

(Inherited from BaseMixedRealityLineRenderer)
Positions

Gets the LineRenderer points

RoundedCaps
RoundedEdges
StepMode

Method for gathering points along line. Interpolated uses normalized length. FromSource uses line's base points. (FromSource may not look right for all LineDataProvider types.)

(Inherited from BaseMixedRealityLineRenderer)
WidthMultiplier (Inherited from BaseMixedRealityLineRenderer)
WidthOffset

Normalized offset for width curve

(Inherited from BaseMixedRealityLineRenderer)

Methods

GetColor(Single)

Get the Color along the normalized length of the line.

(Inherited from BaseMixedRealityLineRenderer)
GetNormalizedPointAlongLine(Int32)

Gets the normalized distance along the line path (range 0 to 1) going the given number of steps provided

(Inherited from BaseMixedRealityLineRenderer)
GetWidth(Single)

Get the width of the line along the normalized length of the line.

(Inherited from BaseMixedRealityLineRenderer)
OnDrawGizmos() (Inherited from BaseMixedRealityLineRenderer)
UpdateLine()

Executes every Unity LateUpdate(). Any property updates or frame updates should occur here to update the line data source.

Applies to