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)

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.

GetRgb(object)

Get rgb bystep.

public Vec3d GetRgb(object step)

Parameters

step object

step

Returns

Vec3d

rgb

GetRgbWithPriority(object, out Vec3d, out double)

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

public void GetRgbWithPriority(object step, out Vec3d rgb, out double attachmentPriority)

Parameters

step object

step

rgb Vec3d

rgb

attachmentPriority double

priority

MakeXmlSource(string, string)

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)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

Returns

XElement

An XML element representing the object's state