Class BaseMixedRealityLineRenderer

Base class for Mixed Reality Line Renderers.

Inheritance

Object

BaseMixedRealityLineRenderer

MeshLineRenderer

MixedRealityLineRenderer

ParticleSystemLineRenderer

StripMeshLineRenderer

Implements

MonoBehaviour

Namespace: Microsoft.MixedReality.Toolkit.Utilities

Assembly: cs.temp.dll.dll

Syntax

public abstract class BaseMixedRealityLineRenderer : MonoBehaviour, MonoBehaviour

Fields

lineDataSource

Declaration

protected BaseMixedRealityLineDataProvider lineDataSource

Field Value

Type	Description
BaseMixedRealityLineDataProvider

lineDataSource

Declaration

protected BaseMixedRealityLineDataProvider lineDataSource

Field Value

Type	Description
BaseMixedRealityLineDataProvider

Properties

ColorOffset

Normalized offset for color gradient

Declaration

public float ColorOffset { get; set; }

Property Value

Type	Description
Single

ColorOffset

Normalized offset for color gradient

Declaration

public float ColorOffset { get; set; }

Property Value

Type	Description
Single

LineColor

Color gradient applied to line's normalized length

Declaration

public Gradient LineColor { get; set; }

Property Value

Type	Description
Gradient

LineColor

Color gradient applied to line's normalized length

Declaration

public Gradient LineColor { get; set; }

Property Value

Type	Description
Gradient

LineDataSource

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

Declaration

public BaseMixedRealityLineDataProvider LineDataSource { get; set; }

Property Value

Type	Description
BaseMixedRealityLineDataProvider

LineDataSource

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

Declaration

public BaseMixedRealityLineDataProvider LineDataSource { get; set; }

Property Value

Type	Description
BaseMixedRealityLineDataProvider

LineStepCount

Number of steps to interpolate along line in Interpolated step mode

Declaration

public int LineStepCount { get; set; }

Property Value

Type	Description
Int32

LineStepCount

Number of steps to interpolate along line in Interpolated step mode

Declaration

public int LineStepCount { get; set; }

Property Value

Type	Description
Int32

LineWidth

Declaration

public AnimationCurve LineWidth { get; set; }

Property Value

Type	Description
AnimationCurve

LineWidth

Declaration

public AnimationCurve LineWidth { get; set; }

Property Value

Type	Description
AnimationCurve

PointDistributionMode

Method for distributing rendered points along line.

Declaration

public PointDistributionMode PointDistributionMode { get; set; }

Property Value

Type	Description
PointDistributionMode

PointDistributionMode

Method for distributing rendered points along line.

Declaration

public PointDistributionMode PointDistributionMode { get; set; }

Property Value

Type	Description
PointDistributionMode

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.)

Declaration

public StepMode StepMode { get; set; }

Property Value

Type	Description
StepMode

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.)

Declaration

public StepMode StepMode { get; set; }

Property Value

Type	Description
StepMode

WidthMultiplier

Declaration

public float WidthMultiplier { get; set; }

Property Value

Type	Description
Single

WidthMultiplier

Declaration

public float WidthMultiplier { get; set; }

Property Value

Type	Description
Single

WidthOffset

Normalized offset for width curve

Declaration

public float WidthOffset { get; set; }

Property Value

Type	Description
Single

WidthOffset

Normalized offset for width curve

Declaration

public float WidthOffset { get; set; }

Property Value

Type	Description
Single

Methods

GetColor(Single)

Get the Color along the normalized length of the line.

Declaration

protected virtual Color GetColor(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Color

GetColor(Single)

Get the Color along the normalized length of the line.

Declaration

protected virtual Color GetColor(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Color

GetNormalizedPointAlongLine(Int32)

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

Declaration

protected virtual float GetNormalizedPointAlongLine(int stepNum)

Parameters

Type	Name	Description
Int32	stepNum	Number of steps to take "walking" along the curve

Returns

Type	Description
Single

GetNormalizedPointAlongLine(Int32)

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

Declaration

protected virtual float GetNormalizedPointAlongLine(int stepNum)

Parameters

Type	Name	Description
Int32	stepNum	Number of steps to take "walking" along the curve

Returns

Type	Description
Single

GetWidth(Single)

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

Declaration

protected virtual float GetWidth(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Single

GetWidth(Single)

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

Declaration

protected virtual float GetWidth(float normalizedLength)

Parameters

Type	Name	Description
Single	normalizedLength

Returns

Type	Description
Single

UpdateLine()

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

Declaration

protected abstract void UpdateLine()

UpdateLine()

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

Declaration

protected abstract void UpdateLine()

Implements

MonoBehaviour