Usages of IPortCandidate
Properties
| edgeCreator | in CreateEdgeInputMode | Gets or sets the ports based edge creation callback. | |
| sourcePortCandidate | in CreateEdgeInputMode | Gets or sets the candidate for the sourcePort of the edge to be created. | |
| targetPortCandidate | in CreateEdgeInputMode | Gets or sets the current candidate for the targetPort of the edge to be created. |
Method Return Values
| getClosestCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest VALID candidate given a number of IPortCandidates and a location in world coordinates. | |
| getClosestSourceCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest candidate given a number of IPortCandidates and a location in world coordinates. | |
| getClosestTargetCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest target candidate given a number of IPortCandidates and a location in world coordinates. | |
| getSourcePortCandidate (IEnumerable<IPortCandidate>, Point, boolean) | in CreateEdgeInputMode | Finds the best matching source port IPortCandidate for the given candidates at the provided location. | |
| getSourcePortCandidates (Point) | in CreateEdgeInputMode | Gets the source port candidates for the given location. | |
| getTargetPortCandidates (Point, boolean) | in CreateEdgeInputMode | Retrieves the target port candidates for a given location in world coordinates. | |
| resolveCandidates (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Returns an enumerable over the given candidates where no instance has DYNAMIC validity. | |
| getPortCandidateAt (IInputModeContext, Point) | in DefaultPortCandidate | Returns a candidate that is derived from this instance that best fits 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. | |
| 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, DefaultPortCandidate, 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 inputModeContext to create edges in. | |
| createEdge (IGraph, IPortCandidate, IPortCandidate) | in CreateEdgeInputMode | Called at the end of the edge creation process if both sourcePortCandidate and targetPortCandidate have been set. | |
| doStartEdgeCreation (IPortCandidate, IPoint?) | in CreateEdgeInputMode | Synthetically starts the interactive edge creation process using the provided IPortCandidate as the source port. | |
| getClosestCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest VALID candidate given a number of IPortCandidates and a location in world coordinates. | |
| getClosestSourceCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest candidate given a number of IPortCandidates and a location in world coordinates. | |
| getClosestTargetCandidate (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Finds the closest target candidate given a number of IPortCandidates and a location in world coordinates. | |
| getSourcePortCandidate (IEnumerable<IPortCandidate>, Point, boolean) | in CreateEdgeInputMode | Finds the best matching source port IPortCandidate for the given candidates at the provided location. | |
| getTargetPortCandidateProvider (IPortCandidate, Point) | in CreateEdgeInputMode | Retrieves the IPortCandidateProvider instance that provides the possible candidates for the target of the edge given the current source candidate. | |
| lookupTargetPortCandidateProvider (IPortCandidate, IPortOwner, Point) | in CreateEdgeInputMode | Retrieves the port candidate provider instance given a source port candidate and a possible target item. | |
| measureDistance (IPortCandidate, Point) | in CreateEdgeInputMode | Measures the distance between a port candidate and a given location. | |
| onSourcePortCandidateChanged (ItemEventArgs<IPortCandidate>) | in CreateEdgeInputMode | Triggers the SourcePortCandidateChanged event. | |
| onTargetPortCandidateChanged (ItemEventArgs<IPortCandidate>) | in CreateEdgeInputMode | Triggers the TargetPortCandidateChanged event. | |
| resolveCandidates (IEnumerable<IPortCandidate>, Point) | in CreateEdgeInputMode | Returns an enumerable over the given candidates where no instance has DYNAMIC validity. | |
| updateDummyEdgeSourcePort (IPortCandidate) | in CreateEdgeInputMode | Updates the dummyEdge to reflect the current source port candidate. | |
| updateDummyEdgeTargetPort (IPortCandidate) | in CreateEdgeInputMode | Updates the dummyEdge to reflect the current target port candidate. | |
| updateTargetHighlight (IPortCandidate, IPortCandidate) | in CreateEdgeInputMode | Draws the highlight for the owner of the current targetPortCandidate. | |
| create () | in IPortCandidateProvider | Creates an implementation of the interface IPortCandidateProvider from the given definition. | |
| 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 dummy 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. |
Event Parameters
| SourcePortCandidateChanged | in CreateEdgeInputMode | ||
| TargetPortCandidateChanged | in CreateEdgeInputMode |
Implementing Types
| DefaultPortCandidate | An IPortCandidate implementation which can be used for candidates at existing ports as well as for candidates at a given location. |