Class ForceDirectedLayout

This method is called for each vertex in the network, when comments is true. The standard behavior is to look for Nodes whose Part.category is "Comment" and that refer to the LayoutVertex.node. By default this method will not be called unless you set comments to true.

You may want to override this method in order to customize how any associated objects are found and how a new ForceDirectedVertex and ForceDirectedEdge may be added to the network to represent the (balloon?) comment. This method sets the new vertex's ForceDirectedVertex.charge to the value of defaultCommentElectricalCharge, and sets the new edge's ForceDirectedEdge.length to the value of defaultCommentSpringLength.

Parameters:

{LayoutVertex} v

This calls the commitNodes and commitLinks methods, the latter only if isRouting is true. You should not call this method -- it is a "protected virtual" method. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

This is called by commitLayout. This is only called if Layout.isRouting is true. See also commitNodes. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

This is called by commitLayout. See also commitLinks. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

If there is no Layout.network, this calls makeNetwork to create a ForceDirectedNetwork from the given collection of Parts. This removes any reflexive edges in the network, since they should be ignored.

For each vertex this calls and remembers the result of electricalCharge as the ForceDirectedVertex.charge and the result of gravitationalMass as the ForceDirectedVertex.mass.

For each edge this calls and remembers the result of springStiffness as the ForceDirectedEdge.stiffness and the result of springLength as the ForceDirectedEdge.length.

This then iterates, updating the position of each vertex according to the forces upon it, until reaching maxIterations or until no vertex moves more than about epsilonDistance.

Finally this calls Layout.updateParts to commit the Node positions from the vertex positions. Layout.updateParts calls commitLayout within a transaction.

Parameters:

{Diagram|Group|Iterable.} coll

A Diagram or a Group or a collection of Parts

Parameters:

{ForceDirectedVertex} v

Returns:

{number}

Used to define an external electrical field at a point independent of the vertex charges. A vertex L is acted upon by a force in the X direction of magnitude electricalFieldX(L.center.x, L.center.y) * electricalCharge(L). Please read the Introduction page on Extensions for how to override methods and how to call this base method.

Parameters:

{number} x

{number} y

Returns:

{number} the default implementation returns zero.

Used to define an external electrical field at a point independent of the vertex charges. A vertex L is acted upon by a force in the Y direction of magnitude electricalFieldY(L.center.x, L.center.y) * electricalCharge(L). Please read the Introduction page on Extensions for how to override methods and how to call this base method.

Parameters:

{number} x

{number} y

Returns:

{number} the default implementation returns zero.

Used to define an external gravitational field at a point independent of the vertex masses. A vertex L is acted upon by a force in the X direction of magnitude gravitationalFieldX(L.center.x, L.center.y) * gravitationalMass(L). Please read the Introduction page on Extensions for how to override methods and how to call this base method.

Parameters:

{number} x

{number} y

Returns:

{number} the default implementation returns zero.

Used to define an external gravitational field at a point independent of the vertex masses. A vertex L is acted upon by a force in the Y direction of magnitude gravitationalFieldY(L.center.x, L.center.y) * gravitationalMass(L). Please read the Introduction page on Extensions for how to override methods and how to call this base method.

Parameters:

{number} x

{number} y

Returns:

{number} the default implementation returns zero.

Parameters:

{ForceDirectedVertex} v

Returns:

{number}

Parameters:

{ForceDirectedVertex} v

Returns:

{boolean} returns true if the node should not be moved by the layout algorithm.

Parameters:

{LayoutVertex} v

Parameters:

{ForceDirectedEdge} e

Returns:

{number} Returns the length of the edge representing a link, the value of ForceDirectedEdge.length if it's a number, or else the value of defaultSpringLength.

Parameters:

{ForceDirectedEdge} e

Returns:

{number} Returns the stiffness of the edge representing a link, the value of ForceDirectedEdge.stiffness if it's a number, or else the value of defaultSpringStiffness.