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:attributeanalysis:attributeanalysis-usermanual [2020/10/22 15:53]
adminmar
start:plugins:attributeanalysis:attributeanalysis-usermanual [2021/11/04 14:27]
adminmar
Line 3: Line 3:
 //Attribute Analysis// is a plugin for Rhino 3D,  designed to give you a fast Analysis of your Rhino model attributes. //Attribute Analysis// is a plugin for Rhino 3D,  designed to give you a fast Analysis of your Rhino model attributes.
 ===== Plugin installation ===== ===== Plugin installation =====
 +==== Overview ====
 The plugin installer can be downloaded at: [[https://www.tomkod.com/product/attribute-analysis/]] \\  The plugin installer can be downloaded at: [[https://www.tomkod.com/product/attribute-analysis/]] \\ 
 A free trial is included, and yearly licenses can be purchased on the aforementioned page.\\  A free trial is included, and yearly licenses can be purchased on the aforementioned page.\\ 
-//Attribute Analysis// works for Rhino ((Rhino 5.12 or later)), Rhino 6 ((Rhino 6.15 or later)) and as standalone software ((windows7 and later)).+//Attribute Analysis// works with Rhino ((Rhino 6.15 or higher)), Rhino7((Rhino 7.or higher))and as standalone software ((windows7 and higher)). 
 +<WRAP center round important 80%> 
 +Please note that only the provided .exe installers offer the possibility to register an "Analysis" shortcut on a 3dm file's right-click. 
 + 
 +If you installed our plugin from Rhino's package manager, you'll have to do //Right-Click/OpenWith.../(Select the executable file from installation directory)// 
 +</WRAP> 
 + 
 +{{page>start:plugins:common#[Yak]&noindent&nofooter&nodate}}
  
 {{page>start:plugins:common#[License activation]&noindent&nofooter&nodate}} {{page>start:plugins:common#[License activation]&noindent&nofooter&nodate}}
Line 11: Line 19:
 {{page>start:plugins:common#[Toolbar]&noindent&nofooter&nodate}} {{page>start:plugins:common#[Toolbar]&noindent&nofooter&nodate}}
  
 +===== Generalities =====
 +The following rules will apply both when Attribute Analysis is performed from Rhino and from windows explorer:
 +  * Any object hidden in the model will be ignored. 
 +  * Any hidden belonging to a hidden layer will be ignored.
 +  * Only top-level objects will be considered. Typically, if an object is part of a block instance, its attributes won't be read - the block instance's attribute will be used instead.
 ===== Rhino commands ===== ===== Rhino commands =====
 ==== AttributeAnalysis_About ==== ==== AttributeAnalysis_About ====
-<WRAP center round todo 60%> +This command can be used only from the command line prompt. It displays the plugin's current revision and license status, as well as the ChangeLog and the list of available commands. 
-Todo +{{ :start:plugins:attributeanalysis:attributeanalysis_about.jpg?nolink&400 |}} 
-</WRAP>+==== AttributeAnalysis_License ==== 
 +This command can be used only from the command line prompt. It displays the plugin's activation form. 
 + 
 +See [[attributeanalysis-usermanual#license_activation]]. 
 ==== AttributeAnalysis ==== ==== AttributeAnalysis ====
 +This command gives a fast analysis of the model's attributes. It is particularly useful if you want to store the material statuses directly in the model. For example, a part could be marked as //"Draft", "Validated", "Ordered", "Assembled",// or //"Controlled"//
 === Walkthrough === === Walkthrough ===
-<WRAP center round todo 60%> +  - Launch the command 
-Todo +  - Select an attribute((usertext)) from the list (Double-click) 
-</WRAP>+  - The [[start:plugins:attributeanalysis:attributeanalysis-usermanual#attribute_analysis_form|attribute analysis form]] is shown and the model's objects are colored to match the keys. The stats are also added to the command line history. <wrap hi>From this window, the values can be edited, and a selection by user texts' value(s) can be performed.</wrap> 
 +  - When the form is closed, the command ends, but the object's selection remains. 
 +{{ :start:plugins:attributeanalysis:attributeanalysiscommand.gif?nolink |}}
 === Scripted mode === === Scripted mode ===
-<WRAP center round todo 60%> +No scripted mode is available for this command. 
-Todo +
-</WRAP> +
-===  Options ===  +
-<WRAP center round todo 60%> +
-Todo +
-</WRAP>+
 ===== StandAlone mode ===== ===== StandAlone mode =====
 +This plugin offers a standalone mode, to check your models' attributes directly for windows explorer.
 +
 +<wrap em>Rhino is not needed, this will work regardless it is installed or not!!!</wrap>
 +==== Walkthrough ====
 +  - Right click to a 3dm file, then pick "AttributeAnalysis" ((Alternatively //Right click on a rhino file ♦ Select //"Open with.."// ♦ Use the program AttributeAnalysis.exe, available in the plugin's installation folder//)) {{ :start:plugins:attributeanalysis:ata-shellmenu.jpg?nolink |}}
 +  - Select an attribute((usertext)) from the list (Doublic-click)
 +  - The [[start:plugins:attributeanalysis:attributeanalysis-usermanual#attribute_analysis_form|attribute analysis form]] is shown.
 +  - When the //attribute analysis form// is closed, the attribute selection form is shown again. Close it to close the program.
 +{{ :start:plugins:attributeanalysis:attributeanalysisstandalone.gif?nolink |}}
 +===== Custom settings / How to's =====
 +=== Hide/show attribute keys from the list ===
 +Sometimes we use rhino's user keys for information not relevant for the AttributeAnalysis command. You can hide these attributes by adding them to the file **AA_AnalysisIgnoredAttributes.set**; editable with any text editor such as notepad.exe. Located inside the installation folder, it only consists of a semicolon-separated list of attribute keys that should be ignored, for example:
 +<code>
 +IgnoreThisAttributeName;ThisOneToo
 +</code>
 +
 +===== Attribute Analysis Form =====
 +This custom form is where the selected user texts stats will be displayed:
 +{{ :start:plugins:attributeanalysis:attributeanalysis_form_fixed.jpg?nolink |}}
 +
 +From v2.1.2, several new buttons are available to copy the results to the clipboard, or save it as a .jpg file:
 +{{ :start:plugins:attributeanalysis:ata-formexport.jpg?nolink |}}