-
Notifications
You must be signed in to change notification settings - Fork 6
Changes as defined by MLAB-6185 #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -147,13 +147,13 @@ Each module has a context menu, providing the following options: | |
|
|
||
|  | ||
|
|
||
| * **Show Internal Network:** [Macro modules](glossary/#macro-module) provide an entry to open the internal network. You can see what happens inside a macro module. The internal network may also contain other macro modules. | ||
| * **Show Window:** If a module does not provide a User Interface, you will see the automatic panel showing the module's name. Modules may additionally have one or more windows that can be opened. You can also open the Scripting Console of a module to integrate Python. | ||
| * **Show Internal Network:** [Macro modules](glossary/#macro-module) provide an entry to open the internal network. You can see what happens inside a macro module. The internal network may also contain other macro modules. Changes in the internal network are applied to the currently running instance of yor module but not saved permanently. | ||
| * **Show Window:** If a module does not provide a User Interface, you will see the automatic panel, showing the module's name. Modules may additionally have one or more windows that can be opened. You can also open the Scripting Console of a module to integrate Python. | ||
| * **Instance Name:** You can edit or copy the instance name. Renaming can be useful if the same module appears more than once in one network and/or if you want to access and distinguish the modules in your Python script. | ||
| * **Help:** The menu entry Help provides access to the Module Help pages and to an example network where the module is used. This example network often helps to understand which additional modules can be added to create your desired effect. | ||
| * **Extras:** Automated tests written for the specific module can be executed here. You can also run this module in a separate process. | ||
| * **Reload Definition:** In the case you are currently working on a module, you may need to reload the definition so that your changes are applied on the module (for example, attached Python scripts). | ||
| * **Related Files:** Related files allows a quick access to the modules *.script* or *.py* files. The files are automatically opened in [MATE](glossary/#mevislab-mate) for editing. | ||
| * **Related Files:** Related files allows a quick access to the modules *\*.script* or *\*.py* files. The files are automatically opened in [MATE](glossary/#mevislab-mate) for editing. Changes on the .mlab file are applied permanently for your module. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| * **Show Enclosing Folder:** This entry opens the directory where your module is stored. | ||
| * **Grouping:** Multiple modules can be clustered and the groups can be named. This adds clarity to the structure of your network. In addition to that, grouped modules can be converted to local or global macro modules easily. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -165,15 +165,15 @@ It is also possible to use the pre-defined module `SynchroView2D` to accomplish | |
|
|
||
| ### Grouping Modules {#TutorialGroupingModules} | ||
|
|
||
| A contour filter can be created based on our previously created network. To finalize the filter, add the modules `Arithmetic2` and `Morphology` to your workspace and connect the modules as shown below. Double-click the module `Arithmetic2` to open its panel. Change the field *Function* of the module `Arithmetic2` to use the function *subtract* in the panel of the module. The contour filter is done now. You can inspect each processing step using the Output Inspector by clicking on the input and output connectors of the respective modules. The final results can be displayed using the viewer modules. If necessary, adjust the contrast by pressing the right mouse button and moving the cursor. | ||
| A contour filter can be created based on our previously created network. To finalize the filter, add the modules `Arithmetic2` and `Morphology` to your workspace and connect the modules as shown below. Double-click {{< mousebutton "left" >}} the module `Arithmetic2` to open its panel. Change the field *Function* of the module `Arithmetic2` to use the function *subtract* in the panel of the module. The contour filter is done now. You can inspect each processing step using the Output Inspector by clicking on the input and output connectors of the respective modules. The final results can be displayed using the viewer modules. If necessary, adjust the contrast by pressing the right arrow key and moving the cursor. | ||
|
|
||
|  | ||
|
|
||
| If you'd like to know more about specific modules, search for help. You can do this by right-clicking the module and select help, which offers an example network and further information about the selected module in particular. | ||
| If you'd like to know more about specific modules, search for help. You can do this by right-clicking {{< mousebutton "right" >}} the module and select help, which offers an example network and further information about the selected module in particular. | ||
|
|
||
|  | ||
|
|
||
| To be able to better distinguish the image processing pipeline, you can encapsulate it in a group: Select the three modules, for example, by dragging a selection rectangle around them. Then right-click the selection to open the context menu and select {{< menuitem "Add to New Group" >}}. | ||
| To be able to better distinguish the image processing pipeline, you can encapsulate it in a group: Select the three modules, for example by dragging a selection rectangle around them. Then right-click {{< mousebutton "right" >}} the selection to open the context menu and select {{< menuitem "Add to New Group" >}}. | ||
|
|
||
|  | ||
|
|
||
|
|
@@ -199,15 +199,17 @@ You have probably already noticed how the modules differ in color. Each color re | |
| * Green modules are OpenInventor modules: they enable visual 3D scene graphs. | ||
| * The brown modules are called macro modules. Macro modules encapsulate a whole network in a single module. | ||
|
|
||
| To condense our filter into one single module, we will now be creating a macro module out of it. To do that, right-click on the group title and select *Convert To Local Macro*. Name your new macro module and finish. You just created a local macro module. Local macros can only be used from networks in the same or any parent directory. | ||
| To condense our filter into one single module, we will now be creating a macro module out of it. To do that, right-click {{< mousebutton "right" >}} on the group title and select *Convert To Local Macro*. Name your new macro module and finish. You just created a local macro module. Local macros can only be used from networks in the same or any parent directory. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Right-click the macro module and select *Show Internal Network* to inspect and change the internal network. You can change the properties of the new macro module by changing the properties in the internal network. You can, for example, right-click the module `Convolution` and change the kernel. These changes will be preserved. | ||
| Right-click the macro module and select *Show Internal Network* to inspect and change the internal network. You can change the properties of the new macro module by changing the properties in the internal network. You can, for example, right-click {{< mousebutton "right" >}} the module `Convolution` and change the kernel. These changes will be applied for the currently running instance. | ||
|
|
||
|  | ||
|
|
||
| If you want to change the permanent behaviour or the module, right-click {{< mousebutton "right" >}} and select {{< menuitem "Related Files" "Filter.mlab" >}}. The network file of the module opens. Changes applied in this file are saved permanently. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. behavior (US-english) applied in this file -> to this file |
||
|
|
||
| {{< youtube "VmK6qx-vKWk">}} | ||
|
|
||
| {{<alert class="info" caption="Extra Infos">}} | ||
|
|
@@ -224,6 +226,6 @@ More information on macro modules can be found {{< docuLinks "/Resources/Documen | |
| * Parameters of each module can be changed in the Module Inspector or Automatic Panel of the module. | ||
| * Parameter connections can be established to synchronize the values of these parameters. | ||
| * Modules can be clustered. Clustered modules can be encapsulated into local or global macro modules. | ||
| * Macro modules encapsulate networks. Internal networks can be shown and modified. Any changes of the internal network are applied to the macro module. | ||
| * Macro modules encapsulate networks. Internal networks can be shown and modified. Any changes of the internal network are applied to the macro module on the fly, changes in the *.mlab file are changing the permanent behaviour of your module. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| {{< networkfile "examples/basic_mechanisms/contour_filter/ContourFilter.zip" >}} | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -85,11 +85,7 @@ Window { | |
|
|
||
| ### Edit Viewer Settings in the Panel | ||
|
|
||
| You may want to change the design setting of the right viewer. This is | ||
| still possible via the internal network of the macro module. Open the | ||
| internal network either via the context menu or using the middle mouse | ||
| button {{< mousebutton "middle" >}} and click on the module. After that, open the Automatic Panel of | ||
| the module `SoExaminerViewer` via context menu {{< menuitem "Show Windows" "Automatic Panel" >}} and change the field *decoration* to *False*. Keep in mind, as we did not create CSOs by now, the right viewer stays black. | ||
| You may want to change the design setting of the right viewer. This is possible via the network file of the macro module. Open the context menu {{< mousebutton "right" >}} and select {{< menuitem "Related Files" "IsoCSOs.mlab" >}} on the module. In the network file, open the Automatic Panel of the module `SoExaminerViewer` via context menu {{< menuitem "Show Windows" "Automatic Panel" >}} and change the field *decoration* to *False*. Keep in mind, as we did not create CSOs by now, the right viewer stays black. | ||
|
|
||
|  | ||
|
|
||
|
|
@@ -98,11 +94,7 @@ the module `SoExaminerViewer` via context menu {{< menuitem "Show Windows" "Auto | |
| ### Selection of Images | ||
|
|
||
| Next, we like to add the option to browse through the folders and select | ||
| the image, we like to create CSOs from. This functionality is already given in the internal network in the module `LocalImage`. We can copy this functionality from `LocalImage` and add this option to the panel above both viewers. But, how should we know, which field name we | ||
| reference to? To find this out, open the | ||
| internal network of your macro module. Now you are able to open the panel of | ||
| the module `LocalImage`. Right-click {{< mousebutton "right" >}} the desired field: In this case, right-click the label | ||
| *Name:*. Select *Copy Name*, to copy the internal name of this field. | ||
| the image, we like to create CSOs from. This functionality is already given in the internal network in the module `LocalImage`. We can copy this functionality from `LocalImage` and add this option to the panel above both viewers. But, how should we know, which field name we reference to? To find this out, open the network file of your macro module again. Now you are able to open the panel of the module `LocalImage`. Right-click {{< mousebutton "right" >}} the desired field: In this case, right-click the label *Name:*. Select *Copy Name*, to copy the internal name of this field. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. already given -> already present |
||
|
|
||
|  | ||
|
|
||
|
|
@@ -239,7 +231,7 @@ can do this in the following way: | |
|
|
||
|  | ||
|
|
||
| 2. Enable a functionality that allows us to notice the id of the CSO we are currently hovering over with our mouse. For this open the internal network of our macro module. We will use the module `SoView2DCSOExtensibleEditor`. Open its panel and select the tab *Advanced*. You can check a box to enable *Update CSO id under mouse*. If you now hover over a CSO, you can see its id in the panel. We can save the internal network to save this functionality, but we can also solve our problem via scripting. The Scripting Assistant translated our action into code, which we can use. | ||
| 2. Enable a functionality that allows us to notice the id of the CSO we are currently hovering over with our mouse. For this open the network file of our macro module. We will use the module `SoView2DCSOExtensibleEditor`. Open its panel and select the tab *Advanced*. You can check a box to enable *Update CSO id under mouse*. If you now hover over a CSO, you can see its id in the panel. We can save the network to save this functionality, but we can also solve our problem via scripting. The Scripting Assistant translated our action into code, which we can use. | ||
|
|
||
|  | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: yor