|
Ligature Public Methods
|
AddAllHookEventHandlers
|
|
Adds EventHandlers for all Hooks of this Ligature |
Public Sub AddAllHookEventHandlers()
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Void |
|
|
AddEventHandlersForHook
|
|
Adds EventHandlers for a given Hook for events monitored in this Ligature |
Public Sub AddEventHandlersForHook(ByVal H As Hook)
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
H
As
Hook
|
Return Value:
|
|
Void |
|
|
BreakVisibleConnection
|
|
Overload; This breaks a visible connection between Hooks given a reference to the Connection |
Public Sub BreakVisibleConnection(ByVal VisiCon As LigConnection)
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
VisiCon
As
LigConnection
|
Return Value:
|
|
Void |
|
|
BreakVisibleConnection
|
|
Overload; This eliminates the visible connection between 2 so-connected Hooks in this Ligature |
Public Sub BreakVisibleConnection(ByVal H1 As Hook, ByVal H2 As Hook)
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
H1
As
Hook
ByVal
H2
As
Hook
|
Return Value:
|
|
Void |
|
|
ClaimAtomForHook
|
|
Assures that the Atom to which a given Hook belongs is part of this Ligature |
Public Sub ClaimAtomForHook(ByVal H As Hook)
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
H
As
Hook
|
Return Value:
|
|
Void |
|
|
ClaimHooks
|
|
Adds the Hooks of HH to this Ligature, then Claims them and thier Atoms, changing their Properties appropriately |
Public Sub ClaimHooks(ByVal HH As HookCollection)
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
HH
As
HookCollection
|
Return Value:
|
|
Void |
|
|
ClaimHooks
|
|
Registers this Ligature as Ligature for all its Hooks, and assures that their Atoms are in this Ligature |
Public Sub ClaimHooks()
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Void |
|
|
CorrectHookConnectionCollections
|
|
Checks each Hook in this Ligature to be sure its extant Connections include it as a Connection; if Connections Collection includes a Hook NOT in this Lig, removes that reference |
Public Sub CorrectHookConnectionCollections()
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Void |
|
|
DeleteAllVisibleConnections
|
|
Deletes all visible connections between Hooks in this Ligature |
Public Sub DeleteAllVisibleConnections()
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Void |
|
|
DrawHookConnections
|
|
Used within a Paint Event Handler to draw the visible connections of this Ligature |
Public Sub DrawHookConnections(ByVal GraphInWhich As ContainerGraph, ByVal e As PaintEventArgs)
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
GraphInWhich
As
ContainerGraph
ByVal
e
As
PaintEventArgs
|
Return Value:
|
|
Void |
|
|
DrawHookConnections
|
|
|
Public Sub DrawHookConnections(ByVal GraphInWhich As ContainerGraph)
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
GraphInWhich
As
ContainerGraph
|
Return Value:
|
|
Void |
|
|
DrawSVGHookConnectionsLig
|
|
Supplies XML code for visible Hook Connections in an SVG graphic |
Public Function DrawSVGHookConnectionsLig(ByVal GraphInWhich As ContainerGraph) As String
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
GraphInWhich
As
ContainerGraph
|
Return Value:
|
|
String |
|
|
EncapsulateScope
|
|
Returns a Collection of Graphs containing all Hooks in this Ligature; if this Array were placed on a ConjunctiveEG, that Graph would become the Scope of this Ligature, and if any member of this Array could be left outside that ConjunctiveEG, it would NO LONGER be the Scope |
Public Function EncapsulateScope() As ProtoGraphCollection
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
ProtoGraphCollection |
|
|
GetCurrentInventoryLigaturesIndex
|
|
Reads current Index of this Object in the Inventory; this may differ from IndexFixed, which is the Index in CutsHistoric |
Public Function GetCurrentInventoryLigaturesIndex() As Int32
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Int32 |
|
|
GetHooksForContainer
|
|
Returns Collection of Hooks belonging to this Ligature and in Dots located immediately on the area of a given ContainerGraph |
Public Function GetHooksForContainer(ByVal CGraph As ContainerGraph) As HookCollection
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
CGraph
As
ContainerGraph
|
Return Value:
|
|
HookCollection |
|
|
GetScopeCore
|
|
Computes and returns the ScopeCore of this Ligature |
Public Function GetScopeCore() As ProtoGraphCollection
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
ProtoGraphCollection |
|
|
GetScopeCoreIn
|
|
Computes and passes the ScopeCore of this Ligature in a ProtoGraph G; if Ligature has Hooks outside G, it is a Collection whose only member is G and Function Returns False (else True); if non-comparable, Returns False and passes empty ProtoGraphCollection |
Public Function GetScopeCoreIn(ByVal G As ProtoGraph, ByRef ScopeCoreIn As ProtoGraphCollection) As Boolean
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
G
As
ProtoGraph
ByRef
ScopeCoreIn
As
ProtoGraphCollection
|
Return Value:
|
|
Boolean |
|
|
GetScopeIn
|
|
Computes and passes the Scope of this Ligature in a ProtoGraph G; if Ligature has Hooks outside G, it is G, Function Returns False (else True); if non-comparable, Returns Nothing |
Public Function GetScopeIn(ByVal G As ProtoGraph, ByRef ScopeIn As ProtoGraph) As Boolean
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
G
As
ProtoGraph
ByRef
ScopeIn
As
ProtoGraph
|
Return Value:
|
|
Boolean |
|
|
HookArrayToString
|
|
Produces a String describing a Hook Array |
Public Shared Function HookArrayToString(ByVal H As Hook[]) As String
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
H
As
Hook[]
|
Return Value:
|
|
String |
|
|
HookColorChangeOnReitFor
|
|
Where Reiteree is being Reiterated, this tests whether this Ligature's Hooks in the Copy must change color, may change color, or must remain the same color (or is irrelevant) |
Public Function HookColorChangeOnReitFor(ByVal Reiteree As ProtoGraph) As LigatureColorChange
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
Reiteree
As
ProtoGraph
|
Return Value:
|
|
LigatureColorChange |
|
|
HooksAlreadyHaveConnectionHere
|
|
Tests whether 2 given Hooks already are shown as visibly connected in this Ligarure |
Public Function HooksAlreadyHaveConnectionHere(ByVal H1 As Hook, ByVal H2 As Hook) As Boolean
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
H1
As
Hook
ByVal
H2
As
Hook
|
Return Value:
|
|
Boolean |
|
|
IncludesHook
|
|
Returns True iff a given Hook belongs to this Ligature |
Public Function IncludesHook(ByVal H As Hook) As Boolean
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
H
As
Hook
|
Return Value:
|
|
Boolean |
|
|
JoinLigatures
|
|
Overload; Merges a second Ligature with a given Ligature |
Public Shared Function JoinLigatures(ByRef Lig1 As Ligature, ByVal Lig2 As Ligature) As Ligature
|
Remarks:
|
|
|
Parameters:
|
|
ByRef
Lig1
As
Ligature
ByVal
Lig2
As
Ligature
|
Return Value:
|
|
Ligature |
|
|
JoinLigatures
|
|
Overload; Merges a second Ligature with this Ligature |
Public Function JoinLigatures(ByVal Lig2 As Ligature) As Ligature
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
Lig2
As
Ligature
|
Return Value:
|
|
Ligature |
|
|
SetAllElementsColor
|
|
Sets the Color of all Dots and Hooks belonging to this Ligature to its Color |
Public Sub SetAllElementsColor()
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Void |
|
|
SetScope
|
|
Runs SetScope on a given Ligature, computing Scope (which is GLB of the Atoms in that Ligature in the Graph-Tree) and ScopeCore of that Ligature |
Public Shared Function SetScope(ByVal Lig As Ligature) As ProtoGraph
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
Lig
As
Ligature
|
Return Value:
|
|
ProtoGraph |
|
|
SetScope
|
|
Computes Scope (which is GLB of the Atoms in this Ligature in the Graph-Tree) and ScopeCore of this Ligature |
Public Function SetScope() As ProtoGraph
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
ProtoGraph |
|
|
ShowLineConnectionsX
|
|
This is diagnostic; for visible connection matters, see ContainerGraph_Paint, for a start |
Public Sub ShowLineConnectionsX()
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Void |
|
|
ToString
|
|
Returns a String (on one Line) Representing the Ligature |
Public Overrides Function ToString() As String
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
String |
|
|
UpdateConnectedSpots
|
|
Updates the ConnectedSpots Collection for this Ligature |
Public Function UpdateConnectedSpots() As SpotCollection
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
SpotCollection |
|
|
UpdateConnectedSpots
|
|
Updates the ConnectedSpots Collection for a given Ligature |
Public Shared Function UpdateConnectedSpots(ByVal ForLig As Ligature) As SpotCollection
|
Remarks:
|
|
|
Parameters:
|
|
ByVal
ForLig
As
Ligature
|
Return Value:
|
|
SpotCollection |
|
|
UpdateConnectionsBetweenHooks
|
|
Updates list of Visible Connections between Hooks of this Ligature |
Public Sub UpdateConnectionsBetweenHooks()
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
Void |
|
|
XMLElement
|
|
Generates an XML element for this Ligature |
Public Function XMLElement() As String
|
Remarks:
|
|
|
Parameters:
|
|
|
Return Value:
|
|
String |
|
|
|
|