Class ColorScaleBar

Namespace

Hi.Disp.Flag

Assembly

HiDisp.dll

ColorScaleBar. For Covering mode.

public class ColorScaleBar : IDisplayee, IExpandToBox3d

Inheritance

object

ColorScaleBar

Implements

IDisplayee

IExpandToBox3d

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

ColorScaleBar(double, double, Func<double, Vec3d>, string, string)

Initializes a new instance of the ColorScaleBar class.

public ColorScaleBar(double floor, double ceiling, Func<double, Vec3d> rgbFunc, string tag, string unit)

Parameters

floor double

The minimum value for the color scale.

ceiling double

The maximum value for the color scale.

rgbFunc Func<double, Vec3d>

The function that converts a value to an RGB color.

tag string

The tag text for the color scale bar.

unit string

The unit text for the color scale values.

Properties

Ceiling

Gets or sets the maximum value for the color scale.

public double Ceiling { get; set; }

Property Value

double

Floor

Gets or sets the minimum value for the color scale.

public double Floor { get; set; }

Property Value

double

LengthW

Gets the width length of the color scale bar.

public static int LengthW { get; }

Property Value

int

OffsetH

Gets the vertical offset of the color scale bar.

public static double OffsetH { get; }

Property Value

double

OffsetW

Gets the horizontal offset of the color scale bar.

public static double OffsetW { get; }

Property Value

double

RgbFunc

Gets or sets the function that converts a value to an RGB color.

public Func<double, Vec3d> RgbFunc { get; set; }

Property Value

Func<double, Vec3d>

Tag

Gets or sets the tag text for the color scale bar.

public string Tag { get; set; }

Property Value

string

Unit

Gets or sets the unit text for the color scale values.

public string Unit { get; set; }

Property Value

string

Methods

Display(Bind)

Display function called in DispEngine rendering loop.

public void Display(Bind bind)

Parameters

bind Bind

Bind with DispEngine. See Bind.

Display(Bind, double, double, Func<double, Vec3d>, string, string)

Displays the color scale bar on the specified binding context.

public static void Display(Bind bind, double floor, double ceiling, Func<double, Vec3d> rgbFunc, string tag, string unit)

Parameters

bind Bind

The binding context to display on.

floor double

The minimum value for the color scale.

ceiling double

The maximum value for the color scale.

rgbFunc Func<double, Vec3d>

The function that converts a value to an RGB color.

tag string

The tag text for the color scale bar.

unit string

The unit text for the color scale values.

ExpandToBox3d(Box3d)

Expands the destination box. This function is usually used to compute the bounding box of elements.

public void ExpandToBox3d(Box3d dst)

Parameters

dst Box3d

Destination box