Differences

This shows you the differences between two versions of the page.

--- start:plugins:rhinobeamtools:rbt-usermanual [2021/02/09 11:17]
adminmar [Interface]
+++ start:plugins:rhinobeamtools:rbt-usermanual [2021/11/04 14:27] (current)
adminmar
@@ Line 3: / Line 3: @@
 ===== Introduction =====
-//Rhino Beam Tools// is a plugin for Rhino 3D, designed to draw mechanical Beams and Nodes in context, then export them in a Beam calculation software. Currenttly, //RhinoBeamTools// is only compatible with (c)[[https://marine-offshore.bureauveritas.com/steel-software-3d-beam-analysis|Steel]]((v3 or v4)) (Editor: (r)[[https://marine-offshore.bureauveritas.com/|Bureau Veritas]]).
+//Rhino Beam Tools// is a plugin for Rhino 3D, designed to draw mechanical Beams and Nodes in context, then export them in a Beam calculation software. Currently, //RhinoBeamTools// is only compatible with (c)[[https://marine-offshore.bureauveritas.com/steel-software-3d-beam-analysis|Steel]]((v3 or v4)) (Editor: (r)[[https://marine-offshore.bureauveritas.com/|Bureau Veritas]]).
 ===== Plugin installation =====
@@ Line 9: / Line 9: @@
 The plugin installer can be downloaded at: [[https://www.tomkod.com/product/rhino-beam-tools/]] \\
 A free trial is included, and yearly licenses can be purchased on the aforementioned page.\\
-//Rhino Beam Tools// works for Rhino 5 ((Rhino 5.12 or later)), Rhino 6 ((Rhino 6.15 or later)), and Rhino7((Tested up to Rhino 7.1)).
+//Rhino Beam Tools// works with Rhino 5((Rhino 5.12 or higher)), Rhino 6((Rhino 6.15 or higher)), and Rhino7((Rhino 7.5 or higher)).
 {{page>start:plugins:common#[Yak]&noindent&nofooter&nodate}}
@@ Line 20: / Line 20: @@
 ==== Definitions ====
 === Nodes ===
-Nodes are custom points with translations and rotation constraints defined on x, y & z axis.
+Nodes are custom points with translations and rotation constraints defined on the x, y & z axis.
 Every node in the model is identified by a unique number.
 === Beams ===
-Beams are oriented lines located between two nodes ((More specifically, two node definition numbers)). They are represented as an arrow, and have an optionnal angle option.
+Beams are oriented lines located between two nodes ((More specifically, two nodes definition numbers)). They are represented as an arrow and have an optional angle option.
 Every beam in the model is identified by a unique number.
-=== Sets ===
+== Beams local axes ==
+Each beam has an angle referred to as θ, and an associated system of local axes x, y, z defined as follows:
+  *  O is the origin of the beam
+  *  E is the end of the beam
+  *  OX, OY, OZ are three axes passing through O and parallel respectively to the three global axes X, Y, Z
+  *  x is the axis orientated from O to E
+  *  OV is an axis :
+    *  perpendicular to x
+    *  contained in the plane x, OY
+    *  oriented like OY (VOY angle >= 90º)
+    *  But, if x is parallel to OY, then:
+      *  if x is orientated like OY, then OV is orientated in the opposite direction of OX
+      *  if x is orientated in the opposite direction of OY, then OV is orientated like OX
+  *  y is the axis obtained by rotating OV clockwise with respect to x by an angle equal to θ (when θ = 0º, y is identical to OV)
+  *  z is the axis perpendicular to x and y and forming with them a dextrose trihedron
+These rules are designed to fit //Steel//'s requirements, thus they might be different when exporting to RDM6-7.
+== Sets ==
 A set is a group of beams. It is mainly used to easily select beams together.
 ==== Interface ====
 === Panel ===
-//Rhino Beam Tools// comes with a user panel to interact with your Beams, Nodes and Sets.
+//Rhino Beam Tools// comes with a user panel to interact with your Beams, Nodes, and Sets.
-The panel display is refreshed in real time. If you select a beam or a node in the model, the panel is automatically enabled and the appropriate tab is opened.
+The panel display is refreshed in real-time. If you select a beam or a node in the model, the panel is automatically enabled and the appropriate tab is opened.
-The //Display// tab offers quick access tro display settings.
+The //Display// tab offers quick access to display settings.
 {{ :start:plugins:rhinobeamtools:rbt_panel_alltabs.jpg?nolink |}}
 === Annotations ===
-//Rhino Beam Tools// offer the possibility to display annotations in the model with the every node's settings:
+//Rhino Beam Tools// offer the possibility to display annotations in the model with every node's settings:
 {{ :start:plugins:rhinobeamtools:rbt_annotations.jpg?nolink |}}
 The content, size, offset and color of these annotations can be edited in the RhinoBeamTools' panel's //Display// tab.
@@ Line 49: / Line 65: @@
 === Display settings  ===
 <WRAP center round info 80%>
-The display settings can be edited from RhinoBeamTools' panel's //Display// tab. These settings are immediately applied when their values is changed, and are saved in the plugin.
+The display settings can be edited from RhinoBeamTools' panel's //Display// tab. These settings are immediately applied when their values are changed and are saved in the plugin.
 </WRAP>
 {{ :start:plugins:rhinobeamtools:rbt_displaysettings.gif?nolink |}}
 |              ^ Name            ^ Description          ^    ^
-^   Beams display settings      |  Enable oriented preview          |Shows or hides 3D  H - shaped beams to make it easier to understand the beams orientation.  |{{ :start:plugins:rhinobeamtools:rbt_panel_display.jpg?nolink |}}|
+^   Beams display settings      |  Enable oriented preview          |Shows or hides 3D  H - shaped beams to make it easier to understand the beams' orientation.  |{{ :start:plugins:rhinobeamtools:rbt_panel_display.jpg?nolink |}}|
-^   :::                                            |  Enable local axis                         |Shows or hides the beams' local x, y & z axis, taking in account the beams' angle values.          |:::|
+^   :::                                            |  Enable local axis                         |Shows or hides the beams' local x, y & z axis, taking into account the beams' angle values.          |:::|
 ^   Nodes display settings       |  Enable annotations                    |Shows or hides the nodes annotations.                                                                                                |:::|
 ^   :::                                            |  Show nodes labels                      |If enabled, the nodes annotations content will include the nodes' labels. (IDs)                            |:::|
 ^   :::                                            |  Show nodes constraints            |If enabled, the nodes annotations content will include the nodes' constraints.                            |:::|
 ^   :::                                            |  Text height                                   |Sets the nodes annotations' display height. If too small this option might be ignored.               |:::|
-^   :::                                            |  Text offset                                    |Sets the nodes annotations' display offset. The offset if oriented in the screen vertical direction.|:::|
+^   :::                                            |  Text offset                                    |Sets the nodes annotations' display offset. The offset is oriented in the screen vertical direction.|:::|
 ^   :::                                            |  Annotation colors      |Clicking on these buttons opens a dialog form to set custom display colors for particular node constraints.|:::|
@@ Line 101: / Line 117: @@
 {{ :start:plugins:rhinobeamtools:rbt_addbeam.gif?nolink |}}
 === Preselection ===
-Preselection is allowed, but the nodes order will be random. If more than two nodes where preselected, the beam will randomly be created between two nodes.
+Preselection is allowed, but the nodes' order will be random. If more than two nodes were preselected, the beam will randomly be created between two nodes.
 ===  Options ===
 No option available.
@@ Line 128: / Line 144: @@
   - Select the line and curves that should be imported
   - Choose if the original lines should be removed
-  - For each non linear curve, a segment count option is shown to split the curve in several lines. The current view is zoomed in and the current curve is highlighted.
+  - For each non-linear curve, a segment count option is shown to split the curve into several lines. The current view is zoomed in and the current curve is highlighted.
-  - Every beams and nodes are created, duplicated nodes are removed and intersecting beams are splitted.
+  - Every beam and node is created, duplicated nodes are removed and intersecting beams are split.
 {{ :start:plugins:rhinobeamtools:rbt_importlines.gif?nolink |}}
 === Preselection ===
 Preselection is allowed.
 ===  Options ===
-  * //Delete original lines// : Select wether or not the original curves should be removed from the model upon completion.
+  * //Delete original lines//: Select whether or not the original curves should be removed from the model upon completion.
 ----
@@ Line 159: / Line 175: @@
 ====RBT_Export ====
-<WRAP center round todo 60%>
+ Exports your beams, nodes, and sets to (c)Steel((//(r)Bureau Veritas//' beam calculation software)) or RDM7.
-Todo: Add the new icon
-</WRAP>
- Exports your beams, nodes and sets to (c)Steel((//(r)Bureau Veritas//' beam calculation software)) or RDM7.
 === Walkthrough ===
   - Launch the command
   - Select a file path and extension to export the model to (c)Steel3 (//*.stw*//), (c)Steel4  (//*.steel*//), or RDM6-7 (//*.por*//)
-  - The file is created, then RBT attempts to open it with windows default program for this extension.
+  - The file is created, then RBT attempts to open it with Windows' default program for this extension.
-<WRAP center round todo 60%>
+=== Particularities of RDM6-7 ===
-Todo: Add animated captures
+//RhinoBeamTools// degrees of freedom and local axis orientation are based on Steel. To preserve as much as possible the model when exporting to RDM6-7, the following changes are applied to the exported file:
+  * RBT's local y axis is declared as RDM6-7 local Z axis
+  * The nodes constraints (DoF) are simplified, to keep only the values allowed by RDM6-7
+    * Fixed on all DoF
+    * Translation fixed / rotation free on all DoF
+    * Fixed on all DoF except Y rotation ((But the attached beam must have the other node fixed, otherwise the beam will be NULL))
+    * Fixed on all DoF except Z rotation ((But the attached beam must have the other node //Fixed on all DoF except Y rotation//, otherwise the beam will be NULL))
+<WRAP center round important 60%>
+Every other node constraints will be ignored and the attached beams set to NULL.
 </WRAP>
 === Scripted mode ===
@@ Line 191: / Line 212: @@
 === Walkthrough ===
   - Select the beams
-  - The beams nodes are swapped. The arrow orientation are refreshed as well as the node infos.
+  - The beams nodes are swapped. The arrows' orientations are refreshed as well as the nodes' info.
 {{ :start:plugins:rhinobeamtools:rbt_reversebeam.gif?nolink |}}
 === Preselection ===
-Preselection is allowed, every selected beams will be reversed.
+Preselection is allowed, every selected beam will be reversed.
 ===  Options ===
 No option available.
@@ Line 210: / Line 231: @@
 {{ :start:plugins:rhinobeamtools:rbt_duplicatenodedata.gif?nolink |}}
 === Preselection ===
-Preselection is enabled if one and anly one node is preselected.
+Preselection is enabled if one and only one node is preselected.
 ===  Options ===
 No option available.
@@ Line 240: / Line 261: @@
 <WRAP center round important 60%>
 This command is a beta prototype.
-It might have unwanted behaviours and we will decline any responsability if it causes damages to your model.
+It might have unwanted behaviors and we will decline any responsibility if it causes damages to your model.
 TomKod may or may not publish a proper version at a later date.
 </WRAP>