====== Rhino Beam Tools - User Manual ====== ===== 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. 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 ===== ==== Overview ==== 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 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}} {{page>start:plugins:common#[License activation]&noindent&nofooter&nodate}} {{page>start:plugins:common#[Toolbar]&noindent&nofooter&nodate}} ===== Generalities ===== ==== Definitions ==== === Nodes === 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 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. == 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. 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 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 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. //Constraints// can be "Fixed", "Free", "TranslationFixed", "RotationFixed", or Custom. Custom constraints are displayed like this: x , y & z values for translation (t), then x , y & z values for rotation (r). \\ The values can be 0=fixed , 1=free, 2=spring, 3=forced. \\ In the example above, the node //#87// is rotation-Free, with translation-fixed on //x//, translation-spring on //y//, and translation-free on //z// === Display settings === 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. {{ :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 |}}| ^ ::: | 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 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.|:::| === Toolbar === A toolbar is included in Tomkod's toolbar group, with buttons available for most commands: {{ :start:plugins:rhinobeamtools:rbt_toolbar.jpg?nolink |}} todo: Update capture with updated ToolBar ---- ===== Commands ===== ====RBT_About==== This command can be used only from the command line prompt. It displays the plugin's current revision and license status. {{ :start:plugins:rhinobeamtools:rbt_about.jpg?nolink&500 |}} ---- ====RBT_License==== This command can be used only from the command line prompt. It displays the plugin's activation form. See [[rbt-usermanual#license_activation]]. ---- ====RBT_AddNode ==== {{:start:plugins:rhinobeamtools:rbt_icon_addnode.jpg?nolink|}}This command adds a node to the model. === Walkthrough === - Pick a location - The node is created without constraints (Free) {{ :start:plugins:rhinobeamtools:rbt_addnode.gif?nolink |}} === Options === No option available. ---- ==== RBT_AddBeam ==== {{:start:plugins:rhinobeamtools:rbt_icon_addbeam.jpg?nolink|}}This command adds a beam to the model. === Walkthrough === - Pick two nodes - The beam is created from the first node to the second node. {{ :start:plugins:rhinobeamtools:rbt_addbeam.gif?nolink |}} === Preselection === 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. ---- ====RBT_DissociateNode ==== {{:start:plugins:rhinobeamtools:rbt_icon_dissociatenode.jpg?nolink|}} This command allows to separate two beams with a common node by duplicating the node. === Walkthrough === - Select the beam that should be dissociated (The one that will be linked to a new node) - Select which node should be dissociated: //StartNode// or //EndNode// - Choose if the node constraints should be duplicated ((default value = true)). If //No// is selected, the new node will be unconstrained (Free). - Pick the new node location {{ :start:plugins:rhinobeamtools:rbt_dissociatenode.gif?nolink |}} === Preselection === Preselection is allowed if only one beam is preselected === Options === * //StartNode// or //EndNode// * //Duplicate the node constraints// ---- ====RBT_ImportLines ==== {{:start:plugins:rhinobeamtools:rbt_icon_importlines.jpg?nolink|}}This command can convert lines and curves into beams and nodes. === Walkthrough === - 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 into several lines. The current view is zoomed in and the current curve is highlighted. - 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 whether or not the original curves should be removed from the model upon completion. ---- ====RBT_IntersectBeams ==== {{:start:plugins:rhinobeamtools:rbt_icon_intersectbeams.jpg?nolink|}} This commands check the whole model and adds node at beams intersections. === Walkthrough === Launch the command and that's it! {{ :start:plugins:rhinobeamtools:rbt_intersectbeams.gif?nolink |}} === Options === No option available. ---- ====RBT_MergeDuplicateNodes ==== {{:start:plugins:rhinobeamtools:rbt_icon_mergeduplicatenodes.jpg?nolink|}} This command merge node with the same location. === Walkthrough === - Set the tolerance (Default 0.001) - Every duplicated nodes are merged in the model === Options === * //Tolerance// : in model unit, maximum distance to consider two nodes duplicated. ---- ====RBT_Export ==== 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. === Particularities of RDM6-7 === //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)) Every other node constraints will be ignored and the attached beams set to NULL. === Scripted mode === No Scripted Mode === Options === No option available. ---- ====RBT_SetManager ==== This command((Formerly named RBT_AnnotationsSettings)) is a direct link to the //Rhino Beam Tools// panel's //Sets// tab === Walkthrough === - Launch the command - RhinoBeamTools' panel((See [[rbt-usermanual#interface]])) will be opened, with the //Sets// tab selected. {{ :start:plugins:rhinobeamtools:rbt_panel_sets.jpg?nolink&250 |}} === Options === No option available. ---- ====RBT_ReverseBeam ==== {{:start:plugins:rhinobeamtools:rbt_icon_reversebeam.jpg?nolink|}} This command reverses the beam's first and second node. === Walkthrough === - Select the beams - 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 beam will be reversed. === Options === No option available. === Alternative === A //"Reverse beam"// button is available on the panel's Beams tab. It does the same thing but does not allow to reverse several beams at the same time. ---- ====RBT_DuplicateNodeData ==== {{:start:plugins:rhinobeamtools:rbt_icon_duplicatenodedata.jpg?nolink|}} This command copies a node's constraints to another. === Walkthrough === - Pick the original node to duplicate its constraints - Pick one or several nodes that need to be changed - The selected nodes are updated with the original node's constraints {{ :start:plugins:rhinobeamtools:rbt_duplicatenodedata.gif?nolink |}} === Preselection === Preselection is enabled if one and only one node is preselected. === Options === No option available. ---- ====RBT_ShowAnnotations ==== {{:start:plugins:rhinobeamtools:rbt_icon_showannotations.jpg?nolink|}} === Walkthrough === - Launch the command. - If annotations were visible, they are hidden, if they were hidden they will be shown {{ :start:plugins:rhinobeamtools:rbt_showannotations.gif?nolink |}} === Options === No option available. ---- ====RBT_DisplaySettings ==== Todo: Add the new icon This command((Formerly named RBT_AnnotationsSettings)) is a direct link to the panel's //Display// tab === Walkthrough === - Launch the command - RhinoBeamTools' panel will be opened, with the //Display// tab selected. See [[rbt-usermanual#interface]] for more details. {{ :start:plugins:rhinobeamtools:rbt_panel_display.jpg?nolink&150 |}} ---- ====RBT_ImportSteel4File ==== This command is a beta prototype. 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. Attempts to import a //Steel (*.steel)// project beams' and nodes' in your Rhino models. === Walkthrough === - Launch the command - Select the file to import - Nodes are imported with their contraints - Beams are imported ---- ====RBT_Refresh ==== {{:start:plugins:rhinobeamtools:rbt_icon_refresh.jpg?nolink|}} This command forces a display update: * Overlapped nodes are merged * Beam errors are detected * Beam positions are fixed * Rhino views are redrawn __Normally you don't need to use this command.__ === Options === No option available.