Hook Member Details

Hook Member Details

Hook Public Fields

Hook Public Enumerations

Hook Constructors

New
	The Plain-Vanilla Constructor
Public Sub New()
Remarks:

Parameters:

New
	Reconstructs Hook from XML; ShownConnections Array to be added later, if it exists
Public Sub New(ByVal Nom As String, ByVal Owner As AtomicGraph, ByVal inX As Int32, ByVal inY As Int32, ByVal LigName As String, ByVal Col As Color, Optional ByVal ShownConnectionNames As String[]=Nothing)
Remarks:

Parameters:
	ByVal Nom As String ByVal Owner As AtomicGraph ByVal inX As Int32 ByVal inY As Int32 ByVal LigName As String ByVal Col As Color ByVal ShownConnectionNames As String[]

New
	Copy Constructor employed during Reiteration and Insertion on Verso
Public Sub New(ByVal CopyHook As Hook, ByVal Owner As AtomicGraph)
Remarks:

Parameters:
	ByVal CopyHook As Hook ByVal Owner As AtomicGraph

New
	Instantiates a Hook belonging to a Spot
Public Sub New(ByVal ForSpot As Spot)
Remarks:

Parameters:
	ByVal ForSpot As Spot

New
	Instantiates a Hook belonging to a Dot
Public Sub New(ByVal OnDot As Dot, ByVal Loc As Point, Optional ByVal IsMitosisHook As Boolean=False)
Remarks:

Parameters:
	ByVal OnDot As Dot ByVal Loc As Point ByVal IsMitosisHook As Boolean

Hook Public Properties

DotColor
	Color information about this Hook's Ligature	Category: Appearance
Public Property DotColor() As DotColor
Remarks:

IndexParameters:

Return Value:
	DotColor

DotColorHEX
	Hexadecimal of Color information about this Line of Identity	Category: Appearance
Public ReadOnly Property DotColorHEX() As String
Remarks:

IndexParameters:

Return Value:
	String

FromXMLConnectionCount
	When Recreating from XML, holds Count of Hooks with shown connections to this Hook for later translation to References	Category: Behavior
Public ReadOnly Property FromXMLConnectionCount() As Int32
Remarks:

IndexParameters:

Return Value:
	Int32

FromXMLConnectionNames
	When Recreating from XML, holds Names of Hooks with shown connections to this Hook for later translation to References	Category: Behavior
Public Property FromXMLConnectionNames() As String[]
Remarks:

IndexParameters:

Return Value:
	String[]

GlobalIndex
	Absolute number of this Hook in the over-all Inventory for this EG Construction	Category: Behavior
Public Property GlobalIndex() As Int32
Remarks:

IndexParameters:

Return Value:
	Int32

IndexOnOwner
	Number of this Hook relative to Hooks in the OwnerGraph	Category: Behavior
Public Property IndexOnOwner() As Int32
Remarks:

IndexParameters:

Return Value:
	Int32

Inventory
	Reference to the inventory of Objects in this Graph-construction	Category: Behavior
Public Property Inventory() As Inventory
Remarks:

IndexParameters:

Return Value:
	Inventory

IsConnectedTo
	Hooks (if any) in this Ligature to which this Hook is Visibly Connected	Category: Appearance
Public Property IsConnectedTo() As HookCollection
Remarks:

IndexParameters:

Return Value:
	HookCollection

IsExtant
	True means this Hook is not part of a deleted Graph	Category: Behavior
Public Property IsExtant() As Boolean
Remarks:

IndexParameters:

Return Value:
	Boolean

Ligature
	The Ligature of which this Hook is part	Category: Behavior
Public Property Ligature() As Ligature
Remarks:

IndexParameters:

Return Value:
	Ligature

Location
	The position of this Hook within its OwnerGraph	Category: Layout
Public Property Location() As Point
Remarks:

IndexParameters:

Return Value:
	Point

MapsNewHook
	When this Hook is copied, MapsNewHook is the MOST RECENT Hook Copied from it	Category: Behavior
Public Property MapsNewHook() As Hook
Remarks:

IndexParameters:

Return Value:
	Hook

MapsOldHook
	Where this Hook is part of a Copy, MapsOldHook is the Hook on the Original to which it corresponds	Category: Behavior
Public Property MapsOldHook() As Hook
Remarks:

IndexParameters:

Return Value:
	Hook

Name
	The Name used in code to identify this Hook	Category: Behavior
Public Property Name() As String
Remarks:

IndexParameters:

Return Value:
	String

OwnerDot
	OwnerGraph, but giving access to its features as a Line of Identity, when it is a Dot	Category: Behavior
Public ReadOnly Property OwnerDot() As Dot
Remarks:

IndexParameters:

Return Value:
	Dot

OwnerGraph
	The Spot or Line of Identity to which this Hook Belongs	Category: Behavior
Public Property OwnerGraph() As AtomicGraph
Remarks:

IndexParameters:

Return Value:
	AtomicGraph

OwnerName
	String representation of OwnerGraph.Name	Category: Behavior
Public ReadOnly Property OwnerName() As String
Remarks:

IndexParameters:

Return Value:
	String

OwnerSpot
	OwnerGraph, but giving access to its features as a Spot, when it is a Spot	Category: Behavior
Public ReadOnly Property OwnerSpot() As Spot
Remarks:

IndexParameters:

Return Value:
	Spot

Visible
	True means that Hook Location is to be shown on its LI	Category: Appearance
Public Property Visible() As Boolean
Remarks:

IndexParameters:

Return Value:
	Boolean

VisibleNumber
	True means that the Hook Name-Number will be shown on the Dot's ParentGraph	Category: Appearance
Public Property VisibleNumber() As Boolean
Remarks:

IndexParameters:

Return Value:
	Boolean

XFract
	X coordinate of this Hook's Location expressed as a fraction of OwnerGraph's Width	Category: Layout
Public ReadOnly Property XFract() As Double
Remarks:

IndexParameters:

Return Value:
	Double

YFract
	Y coordinate of this Hook's Location expressed as a fraction of OwnerGraph's Height	Category: Layout
Public ReadOnly Property YFract() As Double
Remarks:

IndexParameters:

Return Value:
	Double

Hook Public Methods

AddConnectionHook
	Adds a given Hook to the IsConnectedTo Collection of this Hook
Public Sub AddConnectionHook(ByVal H As Hook)
Remarks:

Parameters:
	ByVal H As Hook
Return Value:
	Void

GetCurrentInventoryHooksIndex
	Reads current Index of this Object in the Inventory; this may differ from IndexInInventory, which is the Index in CutsHistoric
Public Function GetCurrentInventoryHooksIndex() As Int32
Remarks:

Parameters:

Return Value:
	Int32

IsAncestrallyLocatedIn
	Returns True iff the OwnerGraph of this Hook is a descendent in the graph-tree of a given Graph
Public Function IsAncestrallyLocatedIn(ByVal G As ProtoGraph) As Boolean
Remarks:

Parameters:
	ByVal G As ProtoGraph
Return Value:
	Boolean

IsConnectedToDot
	Returns True iff this Hook is directly connected to a Hook of a given Dot
Public Function IsConnectedToDot(ByVal D As Dot) As Boolean
Remarks:

Parameters:
	ByVal D As Dot
Return Value:
	Boolean

IsInLigature
	Returns True iff this Hook belongs to a given Ligature
Public Function IsInLigature(ByVal L As Ligature) As Boolean
Remarks:

Parameters:
	ByVal L As Ligature
Return Value:
	Boolean

IsLocatedOnEnd1SideOf
	Returns True iff this Hook is between a given Point on OwnerDot and OwnerDot's End1
Public Function IsLocatedOnEnd1SideOf(ByVal P As Point) As Boolean
Remarks:

Parameters:
	ByVal P As Point
Return Value:
	Boolean

ToString
	Gives a String representation of this Hook
Public Overrides Function ToString() As String
Remarks:

Parameters:

Return Value:
	String

XMLElement
	Produces an XML element for this Hook
Public Function XMLElement() As String
Remarks:

Parameters:

Return Value:
	String

Hook Public Events

LigatureChanged
	Occurs when the Ligature to which this Hook belongs changes.
Public Event LigatureChanged(ByVal sender As Hook, ByVal NewLig As Ligature, ByVal OldLig As Ligature)
Event Data:
	The event handler receives two arguments of Type Ligature
EventHandler Parameters:
	ByVal sender As Hook ByVal NewLig As Ligature ByVal OldLig As Ligature

LocationChanged
	Occurs when the Location on its Owner of this Hook changes.
Public Event LocationChanged(ByVal sender As Object, ByVal NewVal As Point)
Event Data:
	The event handler receives arguments of Type Object and Point
EventHandler Parameters:
	ByVal sender As Object ByVal NewVal As Point

OwnerGraphChanged
	Occurs when the OwnerGraph of this Hook changes.
Public Event OwnerGraphChanged(ByVal sender As Hook, ByVal NewParent As AtomicGraph, ByVal OldParent As AtomicGraph)
Event Data:
	The event handler receives two arguments of Type AtomicGraph
EventHandler Parameters:
	ByVal sender As Hook ByVal NewParent As AtomicGraph ByVal OldParent As AtomicGraph

VisibleChanged
	Occurs when the Visible Property of this Hook changes.
Public Event VisibleChanged(ByVal sender As Object, ByVal NewVal As Boolean)
Event Data:
	The event handler receives arguments of Type Object and Boolean
EventHandler Parameters:
	ByVal sender As Object ByVal NewVal As Boolean