Struct PinRecord

Namespace

Hi.Disp

Assembly

HiDisp.dll

One named anchor of a rendered frame: where it landed on the canvas, how deep, and whether it is visible. Positions are canvas pixels with a top-left origin, y down; they may lie outside the canvas.

public readonly record struct PinRecord : IEquatable<PinRecord>

Implements

IEquatable<PinRecord>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

MaskUtil.GetMaskedValue<T>(T, T, bool)

MaskUtil.SetMask<T>(ref T, T, bool)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

PinRecord(string, double, double, double, int, PinFlags)

One named anchor of a rendered frame: where it landed on the canvas, how deep, and whether it is visible. Positions are canvas pixels with a top-left origin, y down; they may lie outside the canvas.

public PinRecord(string Name, double X, double Y, double Depth, int PickID, PinFlags Flags)

Parameters

Name string

The pin name given to PinDrawing.

X double

Anchor x in canvas pixels.

Y double

Anchor y in canvas pixels, y down.

Depth double

GL window depth clamped to [0, 1]; 0 is nearest. Comparable within one engine only.

PickID int

The picking id current when the pin was displayed.

Flags PinFlags

Flag bits.

Properties

AlwaysOnTop

The pin was displayed always-on-top.

public bool AlwaysOnTop { get; }

Property Value

bool

Depth

GL window depth clamped to [0, 1]; 0 is nearest. Comparable within one engine only.

public double Depth { get; init; }

Property Value

double

Flags

Flag bits.

public PinFlags Flags { get; init; }

Property Value

PinFlags

IsVisible

On the canvas and not occluded.

public bool IsVisible { get; }

Property Value

bool

Name

The pin name given to PinDrawing.

public string Name { get; init; }

Property Value

string

Occluded

Scene geometry hides the anchor.

public bool Occluded { get; }

Property Value

bool

OnCanvas

The anchor lies inside the canvas.

public bool OnCanvas { get; }

Property Value

bool

PickID

The picking id current when the pin was displayed.

public int PickID { get; init; }

Property Value

int

X

Anchor x in canvas pixels.

public double X { get; init; }

Property Value

double

Y

Anchor y in canvas pixels, y down.

public double Y { get; init; }

Property Value

double