Table of Contents

Class CompiledStepColorTree.Leaf

Namespace
Hi.MachiningProcs
Assembly
HiNc.dll

A leaf of a compiled tree.

public sealed record CompiledStepColorTree.Leaf : IEquatable<CompiledStepColorTree.Leaf>
Inheritance
CompiledStepColorTree.Leaf
Implements
Inherited Members
Extension Methods

Constructors

Leaf(int, string, int, double, string, int, string)

A leaf of a compiled tree.

public Leaf(int Id, string Name, int Lane, double Hue, string ValueKey, int ValueIndex, string ShortName = null)

Parameters

Id int

The leaf's id, the value of the tree's step property for its steps.

Name string

The leaf's name as authored.

Lane int

The leaf's lane in a chart: the first leaf of the tree has the highest, the last 0.

Hue double

The HSL hue of the leaf's color, 0 to 1.

ValueKey string

The key of the step property shown for its steps; null for none.

ValueIndex int

The index of ValueKey in Keys; −1 for none.

ShortName string

The short name a chart prints on the leaf's lane, as authored; null or empty for none (ShortName).

Properties

Hue

The HSL hue of the leaf's color, 0 to 1.

public double Hue { get; init; }

Property Value

double

Id

The leaf's id, the value of the tree's step property for its steps.

public int Id { get; init; }

Property Value

int

Lane

The leaf's lane in a chart: the first leaf of the tree has the highest, the last 0.

public int Lane { get; init; }

Property Value

int

Name

The leaf's name as authored.

public string Name { get; init; }

Property Value

string

ShortName

The short name a chart prints on the leaf's lane, as authored; null or empty for none (ShortName).

public string ShortName { get; init; }

Property Value

string

ValueIndex

The index of ValueKey in Keys; −1 for none.

public int ValueIndex { get; init; }

Property Value

int

ValueKey

The key of the step property shown for its steps; null for none.

public string ValueKey { get; init; }

Property Value

string