GITBOOK-54: modify forcediagram

gitbook/manual/supports-1.md

@@ -1,28 +1,37 @@
 # 7b. Modify ForceDiagram
 
+## Modify ForceDiagram
+
 |                                                                                           |                                                                               |                                                                                                                         |
 | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_ForceDiagram-modify (1).svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_force_modify</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_force_modify.py"><code>RV_force_modify.py</code></a></p> |
 
-Description
-
-
-
-
+`RV_force_modify` allows users to make the following modifications to the ForceDiagram.
 
 ***
 
-## Sub functions
+## Modify Attributes
 
 ### VertexAttributes
 
+The following vertex attributes of the `ForceDiagram` can be modified.
 
+* **is\_fixed** -  If set to `True`, the vertex will remain fixed during any force-density-based relaxation or `RV_tna_horizontal`. This is set to `False` by default.
+* **x** - Current x-coordinate of the vertex. This value is automatically computed, although can be changed manually to re-locate vertices to specific positions.
+* **y** - Current y-coordinate of the vertex. This value is automatically computed, although can be changed manually to re-locate vertices to specific positions.
+* **z** - Current z-coordinate of the vertex. This value is automatically computed, although can be changed manually to re-locate vertices to specific positions.
 
 ### EdgeAttributes
 
+The following edge attributes of the `ForceDiagram` can be modified.
 
+* lmax - Maximum allowable length of the edge. This value is set to 10000000.0 by default.
+* lmin - Minimum allowable length of the edge. This value is set to 0.0 by default.
 
-### MoveVertices
+***
 
+## Sub-commands
 
+### MoveVertices
 
+This sub-command enables users to move any vertices of the `ForceDiagram`. This is a 2-dimensional transformation on the XY plane. The transformation can be unconstrained ("free"), or constrained to: either the X or Y axis, or the XY plane.

gitbook/manual/supports-2.md

@@ -6,13 +6,13 @@
 | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |
 | <img src="../.gitbook/assets/RV_ThrustDiagram-modify.svg" alt="" data-size="original"> | <p><strong>Rhino command name</strong></p><p><code>RV_thrust_modify</code></p> | <p><strong>source file</strong></p><p><a href="../../plugin/RV_thrust_modify.py"><code>RV_thrust_modify.py</code></a></p> |
 
-`RV_thrust_modify` allows users to make modifications to the ThrustDiagram.
+`RV_thrust_modify` allows users to make the following modifications to the ThrustDiagram.
 
 ***
 
-## Sub-commands
+## Modify Attributes
 
-The following sub-commands are built into `RV_thrust_modify` .&#x20;
+The following atributes of vertices, edges or faces can be made using `RV_thrust_modify` .&#x20;
 
 ### VertexAttributes
 
@@ -41,6 +41,12 @@ The following edge attributes of the `ThrustDiagram` can be modified.
 
 Not implemented.
 
+***
+
+## Sub-commands
+
+The following sub-commands are built into `RV_thrust_modify` to enable geometric modificiations to the `ThrustDiagram`.&#x20;
+
 ### MoveSupports
 
 This sub-command enables users to move supports of the `ThrustDiagram`. This transformation is constrained to the z-axis.&#x20;