Class FuncDiscreteColorGuide

Namespace

Hi.Coloring

Assembly

HiMech.dll

A color guide that uses a function to get an ID value and gives each ID its own color: the hue IdHues names for the ID when it names one, else the color GetDiscreteRgb(int, double, double) gives it. The value is an identity, not a magnitude: the same ID always gets the same color, and there is no range to configure.

public class FuncDiscreteColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide

Inheritance

object

FuncDiscreteColorGuide

Implements

IColorGuide

IMakeXmlSource

IGetColorGuide

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

KindNameUtil.KindName(object)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Remarks

The guide exists only at runtime: MakeXmlSource(string, string, bool) returns null, so the guide is never written to a file.

Constructors

FuncDiscreteColorGuide(Func<object, double?>)

Initializes a new instance of the FuncDiscreteColorGuide class with one color per ID by GetDiscreteRgb(int, double, double): a tool ID, a file number.

public FuncDiscreteColorGuide(Func<object, double?> valueFunc)

Parameters

valueFunc Func<object, double?>

The function to get the ID value for coloring.

FuncDiscreteColorGuide(Func<object, double?>, IReadOnlyDictionary<int, double>)

Initializes a new instance of the FuncDiscreteColorGuide class with a hue per ID: the leaves of a color tree, whose hues the tree names.

public FuncDiscreteColorGuide(Func<object, double?> valueFunc, IReadOnlyDictionary<int, double> idHues)

Parameters

valueFunc Func<object, double?>

The function to get the ID value for coloring.

idHues IReadOnlyDictionary<int, double>

The HSL hue, 0 to 1, of each ID the table names; an ID it does not name is colored by GetDiscreteRgb(int, double, double). Null for one color per ID without a table. Kept by reference and only read: a host that changes the hues builds a new guide with a new table.

Properties

IdHues

Gets the HSL hue, 0 to 1, of each ID the guide names a hue for — the leaves of a color tree, by their ids — as the guide was built with it; null when every ID is colored by GetDiscreteRgb(int, double, double) alone. A host tells a guide built for one table from a guide built for another by this reference.

public IReadOnlyDictionary<int, double> IdHues { get; }

Property Value

IReadOnlyDictionary<int, double>

ValueFunc

Gets the function that extracts the ID value from the input object for coloring.

public Func<object, double?> ValueFunc { get; }

Property Value

Func<object, double?>

Methods

GetColorGuide()

Get IColorGuide.

public IColorGuide GetColorGuide()

Returns

IColorGuide

IColorGuide

GetIdRgb(double?)

Gets the color of an ID value under this guide's hue table.

public vec3d_t GetIdRgb(double? value)

Parameters

value double?

The ID value.

Returns

vec3d_t

The hue IdHues names for the ID, at full saturation and half lightness (HslToRgb(double, double, double)), when value is an integer in the int range the table names; else GetRgb(double?): one color per ID, and NoValueGreen for null, NaN, a fraction or a value outside the range.

GetRgb(double?)

Gets the color of an ID value.

public static vec3d_t GetRgb(double? value)

Parameters

value double?

The ID value. Any integer is an ID, 0 and negative ones included.

Returns

vec3d_t

GetDiscreteRgb(int, double, double) of the ID; NoValueGreen if value is null, NaN, not an integer, or outside the int range.

MakeXmlSource(string, string, bool)

Returns null: the guide is runtime-only and is never written to a file.

public XElement MakeXmlSource(string baseDirectory, string relFile, bool exhibitionOnly)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

exhibitionOnly bool

if true, the extended file creation is suppressed.

Returns

XElement

An XML element representing the object's state

Remarks

For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file.

TryGetRgb(object, out vec3d_t)

Get rgb bystep.

public bool TryGetRgb(object step, out vec3d_t rgb)

Parameters

step object

step

rgb vec3d_t

rgb, when the method returns true

Returns

bool

True when this guide has a colour for step; false when it has none

Remarks

Always returns true, with the color GetIdRgb(double?) gives the step's ID: a step without an ID value gets NoValueGreen, never a false answer, which would be drawn white.

TryGetRgbWithPriority(object, out vec3d_t, out double)

Get color with the showing priority if the showing area overlapped by shrinking. Only effect on CubeTree.

public bool TryGetRgbWithPriority(object step, out vec3d_t rgb, out double attachmentPriority)

Parameters

step object

step

rgb vec3d_t

rgb, when the method returns true

attachmentPriority double

priority. Larger one takes priority. Set on either answer.

Returns

bool

True when this guide has a colour for step; false when it has none and the caller applies its own default

Remarks

Always returns true, with the color TryGetRgb(object, out vec3d_t) gives. The priority is always NaN: an ID has no magnitude to rank by.