Class RgbSeed

Namespace

Hi.Coloring

Assembly

HiGeom.dll

A simple object contains RGB value.

public class RgbSeed : IGetRgb, IMakeXmlSource

Inheritance

object

RgbSeed

Implements

IGetRgb

IMakeXmlSource

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>)

XmlUtil.MakeXmlSourceToFile(IMakeXmlSource, string, bool)

XmlUtil.MakeXmlSourceToFileRef(IMakeXmlSource, string, string, bool)

XmlUtil.SaveToByteArrayAsync(IMakeXmlSource, string)

ColorUtil.GetGloomyColor(object, double, double)

KindNameUtil.KindName(object)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

RgbSeed()

Ctor.

public RgbSeed()

RgbSeed(vec3d_t)

Ctor.

public RgbSeed(vec3d_t rgb)

Parameters

rgb vec3d_t

RGB

RgbSeed(XElement)

Ctor.

public RgbSeed(XElement src)

Parameters

src XElement

XML

Properties

Rgb

RGB; null while the seed has not been given a colour (the parameterless ctor), which TryGetRgb(out vec3d_t) reports as “no colour”.

public vec3d_t? Rgb { get; set; }

Property Value

vec3d_t?

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

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 (or Default when factory is null). Idempotent.

public static void Reg(XFactory? factory = null)

Parameters

factory XFactory

TryGetRgb(out vec3d_t)

Get RGB.

public bool TryGetRgb(out vec3d_t rgb)

Parameters

rgb vec3d_t

RGB, when the method returns true

Returns

bool

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