GoDiagram Win Reference
GoLayoutForceDirected Class Members
Properties  Methods  Events


The following tables list the members exposed by GoLayoutForceDirected.

Public Constructors
 NameDescription
Public ConstructorGoLayoutForceDirected ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyArrangementSpacingGets or sets the space between which ArrangeConnectedGraphs will position the connected graphs that together compose the network.  
Public PropertyCommentsGets 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 PropertyDefaultCommentElectricalChargeGets or sets the value returned by ElectricalCharge.  
Public PropertyDefaultCommentSpringLengthGets or sets the value returned by SpringLength.  
Public PropertyDefaultElectricalChargeGets or sets the value returned by ElectricalCharge.  
Public PropertyDefaultGravitationalMassGets or sets the value returned by GravitationalMass.  
Public PropertyDefaultSpringLengthGets or sets the value returned by SpringLength.  
Public PropertyDefaultSpringStiffnessGets or sets the value returned by SpringStiffness.  
Public PropertyEpsilonGets or sets approximately how far some node must move in order for the iterations to continue.  
Public PropertyInfinityDistanceGets or sets a threshold for the distance beyond which the electrical charge forces may be ignored.  
Public PropertyMaxIterationsGets or sets the maximum number of iterations to perform when doing the force directed auto layout.  
Public PropertySetsPortSpotsGets 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 PropertyViewGets 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 MethodCreateNetworkAllocate a GoLayoutForceDirectedNetwork.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodDisposeOverloaded.  (Inherited from System.ComponentModel.Component)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodLayoutNodesAndLinksUpdates the physical location of "real" nodes and links to reflect the layout.  
Public MethodPerformLayoutOverridden. Performs force-directed auto-layout.  
Public MethodRaiseProgressOverloaded. Call OnProgress with an appropriate GoLayoutProgressEventArgs. (Inherited from Northwoods.Go.Layout.GoLayout)
Public MethodToString (Inherited from System.ComponentModel.Component)
Top
Protected Methods
 NameDescription
Protected MethodAddCommentsFind associated objects to be positioned along with the GoLayoutForceDirectedNode.GoLayoutGenericNetwork.Node<N,L,Y>.GoObject.  
Protected MethodArrangeConnectedGraphsDuring a clustered layout, position each separate graph network so that they do not overlap each other.  
Protected MethodComputeClusterLayoutIterationsDetermine how many additional force-directed layout iterations should occur for this clustered network.  
Protected MethodElectricalChargeReturns 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 MethodElectricalFieldXReturns 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 MethodElectricalFieldYReturns 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 MethodFinalize (Inherited from System.ComponentModel.Component)
Protected MethodGetNodeDistanceReturns 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 MethodGetService (Inherited from System.ComponentModel.Component)
Protected MethodGravitationalFieldXThe 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 MethodGravitationalFieldYThe 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 MethodGravitationalMassThe 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 MethodIsFixedThis 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 MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodNeedsClusterLayoutDetermines whether a clustering layout should be done before the regular force-directed layout.  
Protected MethodOnProgressInvoke all Progress event handlers. (Inherited from Northwoods.Go.Layout.GoLayout)
Protected MethodRemoveNetworkOverridden. Set Network to null.  
Protected MethodSpringLengthReturns 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 MethodSpringStiffnessReturns 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 MethodUpdatePositionsPeforms one iteration of the ForceDirected algorithm and updates the positions of the GoLayoutForceDirectedNodes (but not the document's nodes).  
Top
Public Events
 NameDescription
Public EventProgressThe 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

Reference

GoLayoutForceDirected Class
Northwoods.Go.Layout Namespace

 

 


© 2015. Northwoods Software Corporation. All Rights Reserved.

Send Feedback