Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
start:plugins:rhinopiping:rp-usermanual [2021/07/22 10:15]
adminmar [RP_CreatePipeline {{ :start:plugins:rhinopiping:image2.png}}]
start:plugins:rhinopiping:rp-usermanual [2021/11/19 10:28] (current)
adminmar [RP_CC_CreateDressedItem] Illustration added
Line 4: Line 4:
 RhinoPiping is a rhino(r) plugin to create parametric piping networks in contextual 3D. RhinoPiping is a rhino(r) plugin to create parametric piping networks in contextual 3D.
 ===== Plugin installation ===== ===== Plugin installation =====
 +<WRAP center round important 60%>
 +RhinoPiping is currently only compatible with Rhino 5.
 +</WRAP>
 +
 ==== Overview ==== ==== Overview ====
 RhinoPiping exists in two versions, **RhinoPiping LT** and **RhinoPiping Pro**. __These two versions are not compatible__, so when installing one, the other should be uninstalled beforehand. RhinoPiping exists in two versions, **RhinoPiping LT** and **RhinoPiping Pro**. __These two versions are not compatible__, so when installing one, the other should be uninstalled beforehand.
Line 124: Line 128:
 </nominal-sizes> </nominal-sizes>
 </code> </code>
 +
 +==== How to add a piping component to your catalog ====
 +See [[https://wiki.tomkod.com/doku.php?id=start:plugins:rhinopiping:rp-usermanual#rp_cc_createitem|RP_CC_CreateItem]]
 +
 ==== How to create a pipe class ==== ==== How to create a pipe class ====
 Every pipe class definition file are declared in the file pipe-classes.xml Every pipe class definition file are declared in the file pipe-classes.xml
Line 617: Line 625:
 This option lets you change the tapping class of the pipeline.  This option lets you change the tapping class of the pipeline. 
  
-==== RP_AddComponent {{ :start:plugins:rhinopiping:image3.png}}  ==== +==== RP_AddComponent   ==== 
 +{{ :start:plugins:rhinopiping:image5.png}}
 === Presentation === === Presentation ===
 This command adds a component to the model. The component can be inserted:  This command adds a component to the model. The component can be inserted: 
Line 654: Line 662:
 This option turns the component over.   This option turns the component over.  
  
-==== RP_Slide {{ :start:plugins:rhinopiping:image4.png}}[[http://www.rhinopiping.com/images/icon/command/32x32/RP_Slide.png|]] ====+==== RP_Slide ==== 
 +{{ :start:plugins:rhinopiping:image6.png}}
 This command slides a component along its pipeline.  This command slides a component along its pipeline. 
  
Line 668: Line 677:
 Permutes the connection circles to choose which circle is placed at the mouse cursor. This option applies when inserting a component into a pipe, not when connecting to the end of the line.  Permutes the connection circles to choose which circle is placed at the mouse cursor. This option applies when inserting a component into a pipe, not when connecting to the end of the line. 
  
-==== RP_Connect {{ :start:plugins:rhinopiping:image5.png}}  ====+==== RP_Connect  ==== 
 +{{ :start:plugins:rhinopiping:image7.png}}
 This command connects two pipelines or two piping elements  This command connects two pipelines or two piping elements 
  
Line 684: Line 694:
 When selected, Rhino Piping will check every circle on the active document, and connect them automatically if they are matching.  When selected, Rhino Piping will check every circle on the active document, and connect them automatically if they are matching. 
  
-==== RP_Disconnect {{ :start:plugins:rhinopiping:image6.png}}  ====+==== RP_Disconnect  ==== 
 +{{ :start:plugins:rhinopiping:image8.png}}
 This command disconnects the selected piping element from its pipeline. The pre-selection is canceled if several piping elements were selected.  This command disconnects the selected piping element from its pipeline. The pre-selection is canceled if several piping elements were selected. 
  
-==== RP_Cut {{ :start:plugins:rhinopiping:image7.png}}  ==== +==== RP_Cut  ==== 
-This command lets you cut a pipe. It becomes then two different pipes, with a green (disconnected) connection circle between them.   +{{ :start:plugins:rhinopiping:image9.png}} 
- +This command lets you cut a pipe. It becomes then two different pipes, with a green (disconnected) connection circle between them.  
-{{ :start:plugins:rhinopiping:image66.jpg}}{{ :start:plugins:rhinopiping:image67.jpg}}  +<WRAP group> 
- +<WRAP half column>{{:start:plugins:rhinopiping:image62.jpg}}</WRAP> 
-==== RP_Replace {{ :start:plugins:rhinopiping:image8.png}}  ==== +<WRAP half column>{{:start:plugins:rhinopiping:image63.jpg}}</WRAP> 
 +</WRAP> 
 +  
 +==== RP_Replace  ==== 
 +{{ :start:plugins:rhinopiping:image10.png}}
 This command replaces a component with any other one compatible in shape and size.  This command replaces a component with any other one compatible in shape and size. 
 If components are pre-selected, the command will replace, among these components, the ones of the chosen family. (RhinoPiping will then propose to select which family should be replaced)  If components are pre-selected, the command will replace, among these components, the ones of the chosen family. (RhinoPiping will then propose to select which family should be replaced) 
  
-==== RP_Rotate {{ :start:plugins:rhinopiping:image9.png}}  ====+==== RP_Rotate  ==== 
 +{{ :start:plugins:rhinopiping:image11.png}}
 This command rotates an element around the axis of one of its connection circles. It can also be used to rotate a larger part of a pipeline.  This command rotates an element around the axis of one of its connection circles. It can also be used to rotate a larger part of a pipeline. 
  
Line 711: Line 726:
   * RotateNeighbours   * RotateNeighbours
 If the value is “True”, the transformation is also applied to the neighbors of the transformed element. This option is disabled if the neighbors cannot follow the transformation. (It's the case when the transformed element is on a loop.)  If the value is “True”, the transformation is also applied to the neighbors of the transformed element. This option is disabled if the neighbors cannot follow the transformation. (It's the case when the transformed element is on a loop.) 
-==== RP_TurnAround {{ :start:plugins:rhinopiping:image10.png}}  ====+==== RP_TurnAround  ==== 
 +{{ :start:plugins:rhinopiping:image12.png}}
 This command turns a component around an axis while keeping the connections. You just have to run the command, choose the component, and pick the symmetry’s axis.  This command turns a component around an axis while keeping the connections. You just have to run the command, choose the component, and pick the symmetry’s axis. 
-{{ :start:plugins:rhinopiping:image71.jpg}}{{ :start:plugins:rhinopiping:image72.jpg}}{{ :start:plugins:rhinopiping:image73.jpg}} + 
 +==== RP_CC_CreateItem ==== 
 +=== Introduction === 
 +The creation of piping components for RhinoPiping is highly flexible and quite fast. You can create as many components as you want, even with the free RhinoPiping LT license. The main characteristics of a component will be: 
 +  * From one up to eight connection circles. Each of them can have a different diameter. 
 +  * No limitation concerning the shape. The component can contain curves, surfaces, solids, or meshes. 
 +===  Preparing a Rhino3D model  === 
 +Before it could be imported as a RhinoPiping component, you should add to your Rhino model a closed circle for each future pipe connection point. They will become the basis to generate the actual piping connection circle. 
 +<WRAP center round tip 80%> 
 +If your design allows it, the fastest way would be to use the Rhino command: _dupedge 
 +Else the command: _circle would obviously do the job 
 +</WRAP> 
 +{{ :start:plugins:rhinopiping:image45.jpg?nolink |}} 
 +<WRAP center round tip 80%> 
 +**Tip for using an existing component as a basis:**  
 +  - Insert the component with the command RP_AddComponent (don’t connect it to a pipeline) 
 +  - Use the command _explode: it won’t be anymore a piping component (No connection circles) 
 +  - Remodel it as needed, and then create a new component from it 
 +</WRAP> 
 +=== Creating a component === 
 +  - Select every element: \\ {{ :start:plugins:rhinopiping:image46.jpg?nolink |}} 
 +  - Launch the command: RP_CC_CreateItem {{ :start:plugins:rhinopiping:image47.jpg?nolink |}} 
 +  - Name your component: 
 +    * The name shall not contain special characters and blank spaces, except “-” and/or “_”.  
 +    * Don’t use the diameter in the component’s name. All identical components with different diameters should have the same name because RhinoPiping will automatically use the right DN/NPS. 
 +    * The character “/” lets you define the hierarchy in the component tree. \\ For example: ''%% Provider/Class/ValveButterfly1 %%'' will appear later as: \\ {{:start:plugins:rhinopiping:image48.jpg?nolink|}} 
 +  - Select your connection circles. (If you followed this guide you created them before) For each of them, RhinoPiping will try to detect the corresponding nominal size and ask you for confirmation: \\ {{ :start:plugins:rhinopiping:image49.jpg?nolink |}} \\ If you select no, you will be asked to choose the right nominal size: \\ {{ :start:plugins:rhinopiping:image50.jpg?nolink |}} 
 +  - Check the connection circles’ orientation. Each of them should have an arrow pointed outward. Click near a circle to reverse its orientation.  \\ {{ :start:plugins:rhinopiping:image51.jpg?nolink |}} 
 +  - In some cases, the command will ask you if you want to confirm if you want to apply a stereotype (A special rule for this component). \\ The most common stereotype is ‘invariant under rotation’. If you validate this one your component will ignore the rotation requests later. In most cases, you wouldn’t want that.  \\ {{ :start:plugins:rhinopiping:image52.jpg?nolink |}} 
 +  - Another stereotype is quite important; it is the ‘elbow’ stereotype. By allowing this one you will be able to use a component as an elbow.  \\ {{ :start:plugins:rhinopiping:image53.jpg?nolink |}} 
 +==== RP_CC_CreateDressedItem (Rhinopiping PRO) ==== 
 +The dressed components are special piping components, made of several components each ((Available for RhinoPiping Pro only)).  
 +The dressed component has its own attributes, but it is possible to “undress” it and make it back to the original components.  
 +<WRAP center round tip 95%> 
 +For example, you could group together a valve with its two flanges and joints, which would make it really faster to use when designing a pipeline. 
 +</WRAP> 
 +<WRAP center round info 95%> 
 +The opposite command is available to decompose a dressed component as several base components: ''%% RP_ExplodeDressedComponent %%'' 
 +</WRAP> 
 +=== Usage === 
 +{{ :start:plugins:rhinopiping:image57.png?nolink&600 |}} 
 +From left to right: 
 +  - The first one is a ball valve alone.  
 +  - The second one is a small portion of the line, including a ball valve, two joints, and two flanges. It is fine but it would be 5 components to insert every time. 
 +  - The last one is a dressed component, made from all the components aforementioned. It is a lot faster to insert in a pipeline (two clicks), and it avoids making a mistake while choosing the matching elements.
  
 ===== Commands (Pro edition only)  ===== ===== Commands (Pro edition only)  =====
  
-==== RP_ChangeElbows {{ :start:plugins:rhinopiping:image11.png}} ====+==== RP_ChangeElbows ==== 
 +{{ :start:plugins:rhinopiping:image13.png}}
 This command replaces an elbow (or several) with any other compatible elbow.  This command replaces an elbow (or several) with any other compatible elbow. 
  
-==== RP_ReplaceDiameters {{ :start:plugins:rhinopiping:image12.png}} ====+==== RP_ReplaceDiameters ==== 
 +{{ :start:plugins:rhinopiping:image14.png}}
 This command changes the diameter of a pipeline. Every piping element of the selected pipeline, including components, will be replaced. You will only be able to select compatible diameters. (For example, if a valve included in the selected pipeline only exists for DN40 and DN50, you will only be able to choose between these two sizes.)  This command changes the diameter of a pipeline. Every piping element of the selected pipeline, including components, will be replaced. You will only be able to select compatible diameters. (For example, if a valve included in the selected pipeline only exists for DN40 and DN50, you will only be able to choose between these two sizes.) 
  
-==== RP_Stretch**[[http://www.rhinopiping.com/images/icon/command/32x32/RP_Stretch.png|]]{{ :start:plugins:rhinopiping:image13.png}}[[http://www.rhinopiping.com/images/icon/command/32x32/RP_Stretch.png|]] ====+==== RP_Stretch ==== 
 +{{ :start:plugins:rhinopiping:image15.png}}
 This command lets you stretch/shorten one pipe or several parallel pipes.  This command lets you stretch/shorten one pipe or several parallel pipes. 
  
Line 736: Line 799:
 Switch the unchanged and transformed ends.  Switch the unchanged and transformed ends. 
  
-==== RP_Mirror {{ :start:plugins:rhinopiping:image14.png}}  ==== +==== RP_Mirror  ==== 
- +{{ :start:plugins:rhinopiping:image16.png}} 
-This command creates the symmetry of a pipeline portion. The created components are the same as the original ones, only their position is symmetrical.  The pre-selection is taken into account. //+This command creates the symmetry of a pipeline portion. The created components are the same as the original ones, only their position is symmetrical.  The pre-selection is taken into account.
 === Usage === === Usage ===
-  - {{ :start:plugins:rhinopiping:image78.jpg}}Run the command //RP_Mirror//  +  - Run the command //RP_Mirror//  
-  - Select a pipe line or part of it (The //completion// option might help) +  - Select a pipeline or part of it (The //completion// option might help) 
   - Choose the mirror plane.    - Choose the mirror plane. 
   - Validate    - Validate 
 ===Options === ===Options ===
-  * Copy +  * CopyThis option is available only if you selected the whole pipeline. If you select yes, the original line is kept, else it is removed.  
-This option is available only if you selected the whole pipeline. If you select yes, the original line is kept, else it is removed.  +  * CompletionThis option helps with the selection:  
-  * Completion +    //NoCompletion// (Default): you will select components and pipes one by one  //CoaxialSection//: you will select coaxial sections of your pipeline one by one  
-This option helps with the selection:  +    //SameDNsection//: Your selection will be extended across the pipeline until there is a change of nominal diameter  
- +    //WholePipeline//: The whole pipeline will be selected  
-  - //NoCompletion// (Default): you will select components and pipes one by one  //CoaxialSection//: you will select coaxial sections of your pipeline one by one  +  * Mirror plane: 
-  //SameDNsection//: Your selection will be extended across the pipeline until there is a change of nominal diameter  +    Default: Select two points within the current CPlane  
-  //WholePipeline//: The whole pipeline will be selected  +    3points: Define a custom plane  
-  * Mirror plane +    XAxis: Symmetry based on X axe  
-You have several ways to select the Mirror Plane:  +    YAxis: Symmetry based on Y axe  
-  Default: Select two points within the current CPlane  +==== RP_Avoidance  ==== 
-  3points: Define a custom plane  +{{ :start:plugins:rhinopiping:image17.png}}
-  XAxis: Symmetry based on X axe  +
-  YAxis: Symmetry based on Y axe  +
-==== RP_Avoidance {{ :start:plugins:rhinopiping:image15.png}}  ====+
 This command builds an avoidance on a pipe, in order to avoid an obstacle for example.  This command builds an avoidance on a pipe, in order to avoid an obstacle for example. 
-{{ :start:plugins:rhinopiping:image80.jpg}}{{ :start:plugins:rhinopiping:image81.jpg}} //+<WRAP group> 
 +<WRAP half column>{{ :start:plugins:rhinopiping:image68.jpg}}</WRAP> 
 +<WRAP half column>{{ :start:plugins:rhinopiping:image69.jpg}}</WRAP> 
 +</WRAP>
 ===Usage === ===Usage ===
   - Run the command //RP_Avoidance//    - Run the command //RP_Avoidance// 
Line 786: Line 849:
 This option lets you choose if the first selected point will be the centered vertex or the side vertex of the avoidance.  This option lets you choose if the first selected point will be the centered vertex or the side vertex of the avoidance. 
  
-==== RP_RemoveComponent {{ :start:plugins:rhinopiping:image16.png}}[[http://www.rhinopiping.com/images/icon/command/32x32/RP_RemoveComponent.png|]] ====+==== RP_RemoveComponent ==== 
 +{{ :start:plugins:rhinopiping:image18.png}}
 This command deletes a component and tries to redraw a pipeline instead. Just launch the command, select the component and validate to remove it. Pre-selection is taken into account.  This command deletes a component and tries to redraw a pipeline instead. Just launch the command, select the component and validate to remove it. Pre-selection is taken into account. 
-{{ :start:plugins:rhinopiping:image83.jpg}}{{ :start:plugins:rhinopiping:image84.jpg}} +<WRAP group> 
 +<WRAP half column>{{ :start:plugins:rhinopiping:image70.jpg}}</WRAP> 
 +<WRAP half column>{{ :start:plugins:rhinopiping:image71.jpg}} </WRAP> 
 +</WRAP>
 <WRAP center round important 70%> <WRAP center round important 70%>
 An error will occur if the pipes connected to the removed components are not from the same pipe class. This is due to a limitation of the components: as their class is not checked, you may connect them with several non-compatible pipe classes. In this case, the //RP_RemoveComponent// command would try to connect two pipe classes that are not supposed to be compatible. An error will occur if the pipes connected to the removed components are not from the same pipe class. This is due to a limitation of the components: as their class is not checked, you may connect them with several non-compatible pipe classes. In this case, the //RP_RemoveComponent// command would try to connect two pipe classes that are not supposed to be compatible.
Line 798: Line 865:
 ==== AA_SetValue ==== ==== AA_SetValue ====
 This command lets you set the value for a specific attribute. Several elements may be changed at once.  This command lets you set the value for a specific attribute. Several elements may be changed at once. 
-====Command1 TODO==== 
-<WRAP center round todo 60%> 
-TODO 
-</WRAP> 
-=== Walkthrough === 
-  - Launch the command 
-  - First Step :?: 
-  - Second Step :?: 
-=== Scripted mode === 
  
----- +
-====Command2 TODO==== +
-<WRAP center round todo 60%> +
-TODO +
-</WRAP> +
-=== Walkthrough === +
-  - Launch the command +
-  - First Step :?: +
-  - Second Step :?: +
-=== Scripted mode === +
-----+