SelectionResult

List of all (de)selected objects and wires during a picking or selection operation.

Constructors

SelectionResult

public SelectionResult(Document document, PointF? point)

Construct an empty selection result.

Parameters:

document (Document)
point (PointF?)

Properties

DeselectedCount

public int DeselectedCount { get; }

Gets the number of objects that were deselected by this operation.

DeselectedObjectCount

public int DeselectedObjectCount { get; }

DeselectedWireCount

public int DeselectedWireCount { get; }

Document

public Document Document { get; }

Gets the document this selection esult is tied to.

InletUnderPick

public Guid InletUnderPick { get; }

Gets the Instance ID of the parameter whose inlet was underneath the pick location. If no inlet was picked this will return Guid.Empty.

Kind

public Pick Kind { get; }

Gets the pick kind.

ObjectUnderPick

public Guid ObjectUnderPick { get; }

Gets the Instance ID of the object underneath the pick location. If no object was picked this will return Guid.Empty.

OutletUnderPick

public Guid OutletUnderPick { get; }

Gets the Instance ID of the parameter whose inlet was underneath the pick location. If no outlet was picked this will return Guid.Empty.

Point

public PointF? Point { get; }

Gets the origin point, if any, for this pick.

SelectedCount

public int SelectedCount { get; }

Gets the number of objects that were selected by this operation. This is not the same as the total number of selected objects.

SelectedObjectCount

public int SelectedObjectCount { get; }

SelectedWireCount

public int SelectedWireCount { get; }

WireUnderPick

public WireEnds WireUnderPick { get; }

Gets the Instance IDs of the source and target parameters of the wire underneath the pick location. If no wire was picked this will return WireEnds.Empty.

Methods

Merge

public void Merge(SelectionResult other)

Merge the selected and deselected states of another result into this one.

Parameters:

other (SelectionResult)

SetPickedInlet

public void SetPickedInlet(IParameter obj)

Set the parameter inlet directly under the pick.

Parameters:

obj (IParameter)

SetPickedObject

public void SetPickedObject(IDocumentObject obj, bool foreGroundObject)

Set the object directly under the pick.

Parameters:

obj (IDocumentObject)
foreGroundObject (bool)

SetPickedOutlet

public void SetPickedOutlet(IParameter obj)

Set the parameter outlet directly under the pick.

Parameters:

obj (IParameter)

SetPickedWire

public void SetPickedWire(WireEnds wire)

Set the wire directly under the pick.

Parameters:

wire (WireEnds)

UnsetIfNotOnGroupBorder

public void UnsetIfNotOnGroupBorder()

If this selection result points to a GroupObject, but the picking point is not on the group dragging boundary, unset the result.