GoDigram for .NET Framework and .NET Core
Northwoods.Go.Layout Namespace / GoLayoutForceDirected Class
Properties Methods Events


In This Topic
    GoLayoutForceDirected Class Members
    In This Topic

    The following tables list the members exposed by GoLayoutForceDirected.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets or sets the space between which ArrangeConnectedGraphs will position the connected graphs that together compose the network.  
    Public PropertyGets or sets whether AddComments should find all Northwoods.Go.GoBalloon comments whose anchors are nodes represented in the Network and add GoLayoutForceDirectedNodes representing those balloon comments as nodes in the network.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets the current iteration count, valid during a call to PerformLayout.  
    Public PropertyGets or sets the value returned by ElectricalCharge.  
    Public PropertyGets or sets the value returned by SpringLength.  
    Public PropertyGets or sets the value returned by ElectricalCharge.  
    Public PropertyGets or sets the value returned by GravitationalMass.  
    Public PropertyGets or sets the value returned by SpringLength.  
    Public PropertyGets or sets the value returned by SpringStiffness.  
    Public PropertyGets or sets the Northwoods.Go.GoDocument that the layout will be performed on. (Inherited from Northwoods.Go.Layout.GoLayout)
    Public Property Gets or sets approximately how far some node must move in order for the iterations to continue.  
    Public Property Gets or sets a threshold for the distance beyond which the electrical charge forces may be ignored.  
    Public Property Gets or sets the maximum number of iterations to perform when doing the force directed auto layout.  
    Public PropertyGets or sets the GoLayoutForceDirectedNetwork that the layout will be performed on.  
    Public Property Gets or sets the random number generator used to give an initial push between objects that are located at the same position.  
    Public PropertyGets or sets whether the Northwoods.Go.GoPort.Northwoods.Go.GoPort.FromSpot and Northwoods.Go.GoPort.ToSpot of every single-port node should be set to GoObject.NoSpot.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets or sets the Northwoods.Go.GoView whose thread is used to run document-updating code and Progress events. (Inherited from Northwoods.Go.Layout.GoLayout)
    Top
    Protected Properties
    Public Methods
     NameDescription
    Public MethodAllocate a GoLayoutForceDirectedNetwork.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public Method (Inherited from System.MarshalByRefObject)
    Public Method Updates the physical location of "real" nodes and links to reflect the layout.  
    Public MethodOverridden.  Performs force-directed auto-layout.  
    Public MethodOverloaded.  (Inherited from Northwoods.Go.Layout.GoLayout)
    Public Method (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodFind associated objects to be positioned along with the GoLayoutForceDirectedNode.GoLayoutGenericNetwork.Node<N,L,Y>.GoObject.  
    Protected Method During a clustered layout, position each separate graph network so that they do not overlap each other.  
    Protected Method Determine how many additional force-directed layout iterations should occur for this clustered network.  
    Protected MethodOverloaded.  (Inherited from System.ComponentModel.Component)
    Protected MethodReturns the charge of the point representing the GoLayoutForceDirectedNode node. A node L and a node V are acted upon by a force of magnitude (ElectricalCharge(L) * ElectricalCharge(V)) / (GetNodeDistance(L,V) * GetNodeDistance(L,V)). A node L is acted upon by forces in the X and Y directions of magnitude ElectricalFieldX(L.position) * ElectricalCharge(L) and ElectricalFieldY(L.position) * ElectricalCharge(L).  
    Protected MethodReturns the electrical field in the X direction acting on a node at the logical point PointF xy. A node L is acted upon by a force in the X direction of magnitude ElectricalFieldX(L.position) * ElectricalCharge(L).  
    Protected MethodReturns the electrical field in the Y direction acting on a node at the logical point PointF xy. A node L is acted upon by a force in the Y direction of magnitude ElectricalFieldY(L.position) * ElectricalCharge(L).  
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected Method Returns the distance between two nodes. The default implementation considers the shortest distance between the two nodes. If the nodes correspond to top-level Go objects, the width and height of the GoObject is factored into the distance between the nodes. If the nodes do not correspond to top-level Go objects, then the nodes implicitly have a width and height of zero, and the distance is calculated.  
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodThe function GravitationalFieldX returns the gravitational field in the X direction acting on a node at the logical point PointF xy. A node L is acted upon by a force in the X direction of magnitude GravitationalFieldX(L.position) * GravitationalMass(L).  
    Protected MethodThe function GravitationalFieldY returns the gravitational field in the Y direction acting on a node at the logical point PointF xy. A node L is acted upon by a force in the Y direction of magnitude GravitationalFieldY(L.position) * GravitationalMass(L).  
    Protected MethodThe function GravitationalMass returns the mass of the point representing the GoLayoutForceDirectedNode node. A node L is acted upon by forces in the X and Y directions of magnitude GravitationalFieldX(L.position) * GravitationalMass(L) and GravitationalFieldY(L.position) * GravitationalMass(L).  
    Protected MethodThis predicate returns true if the node should not be moved by the layout algorithm but still have an effect on nearby and connected nodes. The default implementation returns GoLayoutForceDirectedNode.IsFixed.  
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected Method Determines whether a clustering layout should be done before the regular force-directed layout.  
    Protected Method Invoke all Progress event handlers. (Inherited from Northwoods.Go.Layout.GoLayout)
    Protected MethodOverridden. Set Network to null.  
    Protected MethodReturns the length of the spring representing the GoLayoutForceDirectedLink link. The to and from nodes of a link L are acted upon by a force of magnitude SpringStiffness(L) * (GetNodeDistance(L.from, L.to) - SpringLength(L)).  
    Protected MethodReturns the stiffness of the spring representing the GoLayoutForceDirectedLink link. The to and from nodes of link L are acted upon by a force of magnitude SpringStiffness(L) * (GetNodeDistance(L.from, L.to) - SpringLength(L)).  
    Protected MethodPeforms one iteration of the ForceDirected algorithm and updates the positions of the GoLayoutForceDirectedNodes (but not the document's nodes).  
    Top
    Public Events
     NameDescription
    Public Event (Inherited from System.ComponentModel.Component)
    Public EventThe Progress event is raised at various times during the PerformLayout routine to indicate progress. In particular, a Progress event should be raised at the start of the layout with a progress of 0.0 and at the end of the layout with a progress of 1.0. Other calls with progress values should be layout routine specific. (Inherited from Northwoods.Go.Layout.GoLayout)
    Top
    See Also