Usages of IPortCandidate
Properties
| edgeCreator | in CreateEdgeInputMode | Gets or sets the ports-based edge creation callback. | |
| endPortCandidate | in CreateEdgeInputMode | Gets or sets the current candidate for the end point of the dragged edge to be created. | |
| startPortCandidate | in CreateEdgeInputMode | Gets or sets the candidate for the sourcePort of the edge to be created. | |
| portCandidate | in PortCandidateRenderTag | Gets the port candidate the renderer has to visualize. |
Method Return Values
| getEndPortCandidates (Point, boolean) | in CreateEdgeInputMode | Retrieves the end port candidates for a given location in world coordinates. | |
| getStartPortCandidate (Point) | in CreateEdgeInputMode | Finds the best matching start port candidate based on the given location. | |
| getStartPortCandidates (Point) | in CreateEdgeInputMode | Gets the start port candidates for the given location. | |
| resolveCandidates (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Returns an enumerable over the given candidates where no instance has DYNAMIC validity. | |
| selectClosestCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest VALID candidate given a number of IPortCandidates and a location in world coordinates. | |
| selectClosestEndCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest end candidate given a number of IPortCandidates and a location in world coordinates. | |
| selectClosestStartCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest candidate given a number of IPortCandidates and a location in world coordinates. | |
| selectStartPortCandidate (IEnumerable<IPortCandidate>, Point, boolean) | in CreateEdgeInputMode | Finds the best matching start port IPortCandidate for the given candidates at the provided location. | |
| getSourcePortCandidates (IInputModeContext) | in IEdgeReconnectionPortCandidateProvider | Returns all source port candidates that may be used for the edge. | |
| getTargetPortCandidates (IInputModeContext) | in IEdgeReconnectionPortCandidateProvider | Returns all source port candidates that may be used for the edge. | |
| getPortCandidateAt (IInputModeContext, Point) | in IPortCandidate | Returns a candidate that is derived from this instance that best fits the provided location. | |
| getAllSourcePortCandidates (IInputModeContext) | in IPortCandidateProvider | Returns all source port candidates that belong to the context of this provider. | |
| getAllTargetPortCandidates (IInputModeContext) | in IPortCandidateProvider | Returns all target port candidates that belong to the context of this provider. | |
| getSourcePortCandidates (IInputModeContext, IPortCandidate) | in IPortCandidateProvider | Returns all port candidates that apply for the provided opposite port candidate. | |
| getTargetPortCandidates (IInputModeContext, IPortCandidate) | in IPortCandidateProvider | Returns all port candidates that apply for the provided opposite port candidate. | |
| getPortCandidateAt (IInputModeContext, Point) | in PortCandidate | Returns a candidate that is derived from this instance that best fits the provided location. | |
| getAllSourcePortCandidates (IInputModeContext) | in PortCandidateProviderBase | Returns all source port candidates that belong to the context of this provider. | |
| getAllTargetPortCandidates (IInputModeContext) | in PortCandidateProviderBase | Returns all target port candidates that belong to the context of this provider. | |
| getPortCandidateAt (IInputModeContext, PortCandidate, Point) | in PortCandidateProviderBase | Callback method used by the ports created using the factory methods createCandidate. | |
| getPortCandidates (IInputModeContext) | in PortCandidateProviderBase | Creates an enumeration of possibly port candidates. | |
| getSourcePortCandidates (IInputModeContext, IPortCandidate) | in PortCandidateProviderBase | Returns all port candidates that apply for the provided opposite port candidate. | |
| getTargetPortCandidates (IInputModeContext, IPortCandidate) | in PortCandidateProviderBase | Returns all port candidates that apply for the provided opposite port candidate. | |
| createExistingPortCandidate (IPort) | in PortRelocationHandle | Factory method that creates the candidate for the existing port. | |
| filterCandidates (IInputModeContext, Point, IEnumerable<IPortCandidate>) | in PortRelocationHandle | Filters the given allCandidates to return the subset of candidates which are relevant at the given location. | |
| getClosestCandidate (IInputModeContext, Point, IEnumerable<IPortCandidate>) | in PortRelocationHandle | Finds the closest candidate from the given set of candidates. | |
| getPortCandidates (IInputModeContext, IEdge, boolean) | in PortRelocationHandle | Gets the possible candidates for the given edge. | |
| getPortCandidatesDuringMove (IInputModeContext, IEdge, boolean) | in PortRelocationHandle | Retrieves the port candidates during handleMove. | |
| resolveCandidate (IInputModeContext, IPortCandidate, Point) | in PortRelocationHandle | Tries to resolve a dynamic port candidate for the given location. |
Method Parameters
| CreateEdgeInputMode () | in CreateEdgeInputMode | Creates a new instance that will use the IGraph from the parentInputModeContext to create edges in. | |
| createEdge (IGraph, IPortCandidate, IPortCandidate) | in CreateEdgeInputMode | Called at the end of the edge creation process if both startPortCandidate and endPortCandidate have been set. | |
| getEndPortCandidateProvider (IPortCandidate, Point) | in CreateEdgeInputMode | Retrieves the IPortCandidateProvider instance that provides the possible candidates for the end of the edge given the current start candidate. | |
| getEndPortCandidateProvider (IPortCandidate, IPortOwner, Point) | in CreateEdgeInputMode | Retrieves the port candidate provider instance given a start port candidate and a possible ending item. | |
| measureDistance (IPortCandidate, Point) | in CreateEdgeInputMode | Measures the distance between a port candidate and a given location. | |
| onEndPortCandidateChanged (InputModeItemEventArgs<IPortCandidate>) | in CreateEdgeInputMode | Triggers the end-port-candidate-changed event. | |
| onStartPortCandidateChanged (InputModeItemEventArgs<IPortCandidate>) | in CreateEdgeInputMode | Triggers the start-port-candidate-changed event. | |
| resolveCandidates (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Returns an enumerable over the given candidates where no instance has DYNAMIC validity. | |
| selectClosestCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest VALID candidate given a number of IPortCandidates and a location in world coordinates. | |
| selectClosestEndCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest end candidate given a number of IPortCandidates and a location in world coordinates. | |
| selectClosestStartCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest candidate given a number of IPortCandidates and a location in world coordinates. | |
| selectStartPortCandidate (IEnumerable<IPortCandidate>, Point, boolean) | in CreateEdgeInputMode | Finds the best matching start port IPortCandidate for the given candidates at the provided location. | |
| startEdgeCreation (IPortCandidate, IPoint?) | in CreateEdgeInputMode | Synthetically starts the interactive edge creation process using the provided IPortCandidate as the start port. | |
| updateEndHighlight (IPortCandidate, IPortCandidate) | in CreateEdgeInputMode | Draws the highlight for the owner of the current endPortCandidate. | |
| updatePreviewEdgeEndPort (IPortCandidate) | in CreateEdgeInputMode | Updates the previewEdge to reflect the current end port candidate. | |
| updatePreviewEdgeStartPort (IPortCandidate) | in CreateEdgeInputMode | Updates the previewEdge to reflect the current start port candidate. | |
| create () | in IPortCandidateProvider | ||
| fromCandidates (IPortCandidate) | in IPortCandidateProvider | Creates an implementation of an IPortCandidateProvider that provides only the given port candidates. | |
| fromCandidates (IEnumerable<IPortCandidate>) | in IPortCandidateProvider | Creates an implementation of an IPortCandidateProvider that provides only the given port candidates. | |
| getSourcePortCandidates (IInputModeContext, IPortCandidate) | in IPortCandidateProvider | Returns all port candidates that apply for the provided opposite port candidate. | |
| getTargetPortCandidates (IInputModeContext, IPortCandidate) | in IPortCandidateProvider | Returns all port candidates that apply for the provided opposite port candidate. | |
| addExistingPorts (IPortOwner, IList<IPortCandidate>) | in PortCandidateProviderBase | Adds candidates for all existing ports of the owner to the provided list. | |
| getSourcePortCandidates (IInputModeContext, IPortCandidate) | in PortCandidateProviderBase | Returns all port candidates that apply for the provided opposite port candidate. | |
| getTargetPortCandidates (IInputModeContext, IPortCandidate) | in PortCandidateProviderBase | Returns all port candidates that apply for the provided opposite port candidate. | |
| filterCandidates (IInputModeContext, Point, IEnumerable<IPortCandidate>) | in PortRelocationHandle | Filters the given allCandidates to return the subset of candidates which are relevant at the given location. | |
| getClosestCandidate (IInputModeContext, Point, IEnumerable<IPortCandidate>) | in PortRelocationHandle | Finds the closest candidate from the given set of candidates. | |
| getPort (IInputModeContext, IPortCandidate, Point) | in PortRelocationHandle | Called during dragFinished to actually get the new port from the chosen candidate. | |
| resolveCandidate (IInputModeContext, IPortCandidate, Point) | in PortRelocationHandle | Tries to resolve a dynamic port candidate for the given location. | |
| setClosestCandidate (IPortCandidate) | in PortRelocationHandle | Updates the closest candidate for visual feedback. | |
| setPort (IInputModeContext, IEdge, boolean, IPortCandidate, Point) | in PortRelocationHandle | Triggered by dragFinished to actually change the port. | |
| setToPortCandidate (SimpleEdge, boolean, IPortCandidate) | in PortRelocationHandle | Updates the preview edge's visual appearance to reflect the new port candidate. | |
| updateHighlight (IPortCandidate, IPortCandidate) | in PortRelocationHandle | Draws the highlight for the owner of the current port candidate. |
Implementing Types
| PortCandidate | An IPortCandidate implementation which can be used for candidates at existing ports as well as for candidates at a given location. |