Named Structure Tools

How does it work?

You define a Named Structure by using it - by assigning a Named Structure tag to an object. Select "Collie Tools - Named Structure" from the tag menu. The tag has only one string field, where you can enter as many names for Named Structures as you like. Alternatively, you may assign several Named Structure tags to the same object. The effect is the same, so you can organize work with Named Structures as you like.

Named Structure tag Named Structure tag; and its view in the attribute manager:

Named Structure Tag in the Attribute Manager

The tag will show the name list in the tooltip as well, so that you don't need to open the attribute manager to see it.

This list defines the Named Structures "red", "cube", "blocky", "row3" and "col3". You enter them in the list field without quote marks, but you may use comma or semicolon to separate the names, instead of just spaces. At the same time, the tag assigns the object to all these Named Structures. You don't need to define the Named Structures anywhere else. All objects that use the name "red" in their tags belong to the Named Structure "red".

Names must conform to the rules for object names. Start with a character; use only characters and digits, underscore, dot, angular brackets or the "at" sign. Do not use space (this separates Named Structures) or other special characters. "red", "red1", "red_blue" or "My_Object_@Stuff" are valid names. "red$", "_red", "red#number" or "*red?" are not.

Uppercase and lowercase letters are regarded as different, so "Red" and "red" are different Named Structures. Also, if you mistype a Named Structure, you may inadvertently define a new one. Typing "red" in one object's Named Structure tag, "Red" in another's, and "ret" in the third will yield three Named Structures. However, mistakes like that are easily caught when you first try to use the desired Named Structure.

A Named Structure tag is valid not only for the object itself, but also for all it's children (there is a way to exclude children explicitly, as shown later). So you don't need to add a NS tag for each object in the scene, but only for the top object of an assembly.

How is a Named Structure used?

Now that you have defined Named Structures through the tags, you just need a tool to control them. For this purpose, the Collie Tools offer the Named Structure Control dialog. Open it through the plugin menu will show its layout:

Named Structure Dialog

If you use this feature often, you may want to integrate this dialog into your default layout, as I did. You may group it with other control dialogs so it won't take up that much space. Alternatively, you can add the icon for opening the dialog to your object manager's toolbar:

Icon to open the Named Structure Dialog

With this icon, you may open the dialog on the fly when you need it.

There are four sections in this dialog. The input field in the first section allows entering a Named Structure. This field is used by all the controls below. The second section offers controls for the visibility of that Named Structure, and the third presents controls for the selection and folding of objects in Named Structures. The fourth section finally allows setting and removing multiple NS names in selected elements, handling the tags automatically.

A detailed explanation for the controls will follow with the example on the next page. You can now use the default settings (if you have set a tag as seen above). Type "red" in the input field (without quote marks), and press "Set Visibility". All objects in your scene disappear, with the exception of the objects that bear the Named Structure tag "red". Why? Because the checkbox "From Top" is checked (which means that the function will start at the first element in the scene), and the radio button "Only these" is set (which means that only objects with the Named Structure will become visible, and everything else will become invisible).

No matter where you set the Named Structure tag, the dialog gives you full control over those objects that belong to it.

Note that the "From Top" functionality will only work on the first object on top level of the scene. This is by design to prevent changes to stage sets and currently unused objects. See Scene Requirements for details.

(next page)


Back to Main Manual Page