Class QuantityColorGuide

Namespace

Hi.Coloring

Assembly

HiMech.dll

A color guide that maps numeric quantities to colors using a range color rule.

public class QuantityColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide, IGetRangeColorRule

Inheritance

object

QuantityColorGuide

Implements

IColorGuide

IMakeXmlSource

IGetColorGuide

IGetRangeColorRule

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)

Constructors

QuantityColorGuide()

Initializes a new instance of the QuantityColorGuide class.

public QuantityColorGuide()

QuantityColorGuide(string, RangeColorRule)

Initializes a new instance of the QuantityColorGuide class with specified quantity key and range color rule.

public QuantityColorGuide(string quantityKey, RangeColorRule rangeColorRule)

Parameters

quantityKey string

The key used to retrieve quantity values.

rangeColorRule RangeColorRule

The rule that maps numeric values to colors.

QuantityColorGuide(XElement)

Initializes a new instance of the QuantityColorGuide class from XML.

public QuantityColorGuide(XElement src)

Parameters

src XElement

The XML element containing the color guide data.

Properties

QuantityKey

Gets or sets the key used to retrieve the quantity value.

public string QuantityKey { get; set; }

Property Value

string

RangeColorRule

Gets or sets the rule that maps numeric values to colors.

public RangeColorRule RangeColorRule { get; set; }

Property Value

RangeColorRule

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

GetColorGuide()

Get IColorGuide.

public IColorGuide GetColorGuide()

Returns

IColorGuide

IColorGuide

GetRangeColorRule()

Gets the range color rule.

public RangeColorRule GetRangeColorRule()

Returns

RangeColorRule

The range color rule.

MakeXmlSource(string, string, bool)

Creates an XML representation of the object. This method may also generate additional resources such as related files.

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.

Reg(XFactory)

Registers this type's deserializer with the given XFactory and chains Reg(factory) on dependents. Idempotent.

public static void Reg(XFactory factory = null)

Parameters

factory XFactory

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

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