Class FramePins

Namespace

Hi.Disp

Assembly

HiDisp.dll

The pin table of one rendered frame, handed to FrameReady together with the pixels. Records are sorted by name and every displayed pin is listed, visible or not; filter with Visible.

public sealed class FramePins

Inheritance

object

FramePins

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

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)

Properties

ByName

Records keyed by name (names are unique within a frame).

public IReadOnlyDictionary<string, PinRecord> ByName { get; }

Property Value

IReadOnlyDictionary<string, PinRecord>

Empty

The table of a frame that carried no pins. PixelsChanged is true.

public static FramePins Empty { get; }

Property Value

FramePins

FrameSerial

Increments once per transported frame of the engine.

public long FrameSerial { get; }

Property Value

long

Height

Frame height in pixels.

public int Height { get; }

Property Value

int

Pins

All records of the frame, sorted by name.

public IReadOnlyList<PinRecord> Pins { get; }

Property Value

IReadOnlyList<PinRecord>

PinsChanged

The pin table differs from the previously transported frame.

public bool PinsChanged { get; }

Property Value

bool

PixelsChanged

The pixels differ from the previously transported frame.

public bool PixelsChanged { get; }

Property Value

bool

ProjDepth

Projection depth D of the engine: one pixel unit of z is 1/D of window depth.

public double ProjDepth { get; }

Property Value

double

Visible

The records whose anchor is on the canvas and not occluded.

public IEnumerable<PinRecord> Visible { get; }

Property Value

IEnumerable<PinRecord>

Width

Frame width in pixels.

public int Width { get; }

Property Value

int