Class PlainColorGuide

Namespace

Hi.Coloring

Assembly

HiMech.dll

A color guide that provides a constant color value.

public class PlainColorGuide : IColorGuide, IMakeXmlSource, IGetColorGuide

Inheritance

object

PlainColorGuide

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)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

PlainColorGuide()

Initializes a new instance of the PlainColorGuide class.

public PlainColorGuide()

PlainColorGuide(XElement)

Initializes a new instance of the PlainColorGuide class from XML.

public PlainColorGuide(XElement src)

Parameters

src XElement

The XML element containing the color guide data.

Properties

Rgb

Gets or sets the RGB color value.

public Vec3d Rgb { get; set; }

Property Value

Vec3d

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

GetColorGuide()

Get IColorGuide.

public IColorGuide GetColorGuide()

Returns

IColorGuide

IColorGuide

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