Help Information / Tutorial for exim.rb Script

Script : exim.rb

Author : Todd Burch

email : toddb@smustard.com=

Version: 1.2 April 08, 2005

Changes: 2005/Apr/0= 6: Add Metric Support, Add UNDO capability after Resetting Values.

Abbreviations:

= G/C =3D Group and/or Component

= G/Cs =3D Groups and/or Components

= RMB =3D Right Mouse Button

The exim.rb Ruby Script explodes (moves apart) and implodes (puts back together) models that are made up of G/Cs. The purpose is to provide exploded parts diagrams for assemblies made with Grou= ps and/or Components. There are = two methods to explode:

- = via centerpoint/distance/direction, and

- = manually.

You also have a thi= rd option by using a combination of the two methods.

exim.rb is = a RMB Context Menu script.&n= bsp; It only shows up in the context menu when a G/C is in the current selection set. It shows up as "Explode/Implode". Hovering and/or clicking this option will display a submenu full of logically grouped choices.

Quick Reference: (For the Centerpoint, Distance and Direction Method)

Set your Initial Positions for you= r G/Cs. (These are your "Implode" positions)
Set your Explode = Centerpoint. This is the point everything = moves away from during an explode. For your first experiment, si= mply select the whole drawing, then choose Explode/Implode>Set Explode <= span class=3DSpellE>Centerpoint.
Set your distance - the distance everythi= ng moves away from the centerpoint.
The Direction is calculated automatically= .
Pick Explode from Center. Done!
To put it back, pick Implode, or Click UN= DO.

What to Select?

exim.rb only works on G/Cs. If you select anything else along = with a G/C, you will get a warning message that these standalone entities were rem= oved from the selection set. Proce= ssing will continue with your request after you acknowledge the removal from the popup alert. A G/C has to be = selected to allow the script's options to display in the context menu.

What Do I Dp First?

The first thing to do, after reading this Help, is to define the initial positi= ons of your G/Cs. You do this wit= h the first option in the "Explode/Implode" submenu, called &quo= t;Set Initial Positions". = This is the location that each G/C will "implode" back to after it is exploded. Each time this opti= on is chosen, the G/Cs in the current selection set will have their initial posit= ions reset to their current position in the model.

How Do I Specify HOW to explode?

There are two ways to explode. The quickest is via Distance and Direction.&nb= sp; The slower (to set up) Manual = Method gives you exact control over the placement of each G/C for the exploded location.

Method #1: Distance and Direction

This method works on the concept of moving G/Cs away from the "center"= of a reference point the distance you specify. You set the distance via a dialog.= You also set the centerpoint, (think of it as the center of the explosion for that G/C), which in turn, calculates the direction (the vector).&nbs= p;

Picking a Reference Point:

You pick a reference point via the submenu option "Set Explode Centerpoint". The Centerpoint that will be set will be= set for all selected G/Cs from the physical center of the bounding box of all selected G/Cs. If you want th= e Centerpoint to be the center of your whole model, sim= ply select everything in your model and pick "Set Explode Centerpoint". If you have, for instance, 3 G/Cs that will use a reference centerpoint that happens to be the physical centerpoint of their bounding box, again, simply sele= ct the 3 G/Cs and pick "Set Explode Centerpoint." If you want a reference point that= is outside the bounding box of your selection, you'll have to create temporary G/Cs in order to create a temporary bounding box that will have a centerpoint where you want it. If this seems like too much work, = you can set the Explode Final Positions manually as described in Method #2. =

Setting the Distance:

This submenu option, “Set Explode Distance”, will present a s= mall dialog box in which you specify the distance for the objects to be moved du= ring the Explode. Each G/C in the selection set will get the same value you specify. If you want different distances fo= r each G/C, you will have to select each G/C in turn and pick this option and spec= ify the distance you want.

Exploding= the Model:

After you have:

1) Set the Initial Positions, <= /p>

2) Set the Centerpoint and

3) Set the Distance,

You are ready to &#= 8220;Explode From Center”. If any of = the above 3 options are not set for a G/C, it will not Expl= ode From Center. To check if you = have set these values, you can pick “Diag Repo= rt Keys/Values” from the submenu. You’ll need to have the Ruby Console open to view the results = of the report. To put ever= ything back after an explode operation, choose “Implode”.

Method #2: Manually Set Final Positions <= /h1>

It's manual, but it's quick and pretty simple.&= nbsp; To set a manual exploded-to position (Set Final Positions in the submenu), use the MOVE tool to place the G/C wherever you want it, then RMB>Explode/Implode>Set Final Positions. As with all things in exim.rb, everything in the selection set will get processed, so you can move around all your G/Cs to your heart's content and then Set Final Positions just once. &= nbsp; You can also use "Explode From Ce= nter" as a suggestion for Final Positions, perhaps accept that or tweak it, and t= hen set Final Positions.

A G/C can have either Method #1 defined and/or Method #2 defined. How= ever, if you used Method #1 only and have not set Final Positions= , the object will not be exploded if you choose "Explode" from t= he submenu, as "Explode" only works after "Set Final Positions" has been specified.&nb= sp;

Similarly, if you have only defined Final Positions, if you choose "Explode From Center", the G/Cs will not be moved.

Therefore, if you want the same thing to happen each time no matter which method you p= ick to explode, first define the Centerpoint and Distance, then Explode From Center, and when exp= loded, select the G/Cs and pick "Set Final Positions".

USAGE NOTES:

1) exim.rb uses an obje= cts center-point as the basis for movement.&nb= sp; If you want an object to move in a certain direction (i.e., orthogon= ally), you can create extra (reference) geometry for the purpose of establishing t= he Explode Centerpoint, and then delete (or hide) = it.

2) If G/Cs don't move as expected, run the "Diag Report Keys/Values" to see wh= at has been specified.

3) Your Explode specifications are saved automatically along with your model (= in the .skp file) and across SU restarts.

4) You can always tweak your Explode or Implode positions while in the middle = of an Explode. Just remember that setting (or resetting) the Initial Position or Final Position has no affect= on the other setting, and only affects G/Cs in the current selection set.

5) To remove a G/C from the explode operation, simp= ly do not select it when performing the Explode/Implode operation. If it is inconvenient to not selec= t it, then set the Final Position equal to the Initial Position and it will not be moved.

6) Only top level G/Cs are acted upon. If you have a top level Group made= up of three lower level Groups (sub-groups), and you have previously defined Init= ial and Final positions for the three sub-Groups, the three sub-Groups will not= be acted upon during an implode or explode operation - only the top level Grou= p is acted upon.

7) All Explode and Implode operations are dealt with as a single UNDO operatio= n.

8) Explode From Center is cumulative. This means that if objects are alr= eady exploded, choosing "Explode From Center" again will explode them again - thus doubling, or more, the distance from the center. Implode will always take G/Cs back= to their Initial Positions.

9) If you want to start over with your definitions, pick “Reset All Values” from the submenu to clear all your settings.

10) exim.rb is also hand= y for cleaning up your drawing of geometry that does not belong to any G/Cs. To use it this way, select everyth= ing in your model (CTRL+A) and pick any submenu option. Non-grouped geometry will be remov= ed from the selection set. Move the current selection out of the way, and all your stray geomet= ry will be evident.

11) You will most likely never need to turn on the Debug Trace. If you have a problem, feel free t= o sent the model to me (= Todd Burch), as that= would be easier for me to analyze that a debug trace without a model.

12) This help file should be placed in your SketchUp™ /plugins/ directory.