Differences

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

--- 01_user_documentation:user-guide:common_panels [2025/01/24 11:58] – ↷ Links adapted because of a move operation gaetan
+++ 01_user_documentation:user-guide:common_panels [2025/01/24 17:08] (current) – removed gaetan
@@ Line 1: / Line 1: @@
-===== Common panels =====
-==== File Explorer ====
-GroIMP's File Explorer shows all those files of the project which have an immediate meaning as files to GroIMP. These are source code files, plain text files, HTML files and the like. Files which are used to define non-file-like objects (e.g., images, 3D geometry, data sets) are not shown in the file explorer panel, they are accessible in the panels of the corresponding object type.
-**Figure 2.2. File Explorer**
-{{:user-manual:fileexplorer.png}}
-If the file explorer is not already shown, open the panel via the Panel menu. As you will know it from your system's file browser, GroIMP's file exporer displays files in a tree-like structure. Files may be activated by a double-click or pressing the **Enter** key: On activation, source code and text files are opened in the text editor, HTML files are shown in GroIMP's integrated browser. At the moment, files cannot be renamed, moved or deleted in the file explorer.
-Files which already exist in your file system can be added to a project via the menu item Object/New/Add File. You have the choice to _link_ or _add_ these files: A linked file does not become part of the project, the project just references it in your file systems. Changes to a linked file take effect on the project when GroIMP (re-)opens the file. In contrast to a linked file, an added file is copied into the project, thus, after addition, there is no connection between the original file and the project any more.
-In Figure 2.2, “File Explorer”, a file explorer panel is shown. `FTree.rgg` is a source code file, `FTree.txt` a text file which contains some explanations about the project FTree, and `index.html` is a link (indicated by the small arrow at the lower left corner of the icon) to an HTML file.
-==== Text Editor ====
-GroIMP is equipped with a simple internal text editor. When you activate a source code or text file entry in the file explorer, it is opened in the text editor and can be edited. The usual editing operations (Cut&Paste, Undo/Redo, Save) are available. Figure 2.3, “Text Editor” shows a screenshot.
-**Figure 2.3. Text Editor**
-{{:user-manual:texteditor.png}}
-For some file types, additional actions are triggered when a file of that type is saved. For example, source code is compiled immediately.
-==== Text Editor jEdit ====
-If the jEdit-Plugin is installed, the [[http://www.jedit.org/|jEdit]] text editor is used instead of GroIMP's simple internal text editor. Figure 2.4, “Text Editor jEdit” shows a screenshot. jEdit supports syntax highlighting and contains various edit, search, and print commands. Comprehensive documentation is available via the Help\-menu of jEdit.
-**Figure 2.4. Text Editor jEdit**
-{{:user-manual:texteditor_jedit.png}}
-Both text editor support [[01_user_documentation:additional-functionality:autocomplete|text autocompletion]].
-==== Image Explorer ====
-Every image used within a GroIMP project, e.g., a colouring texture of a 3D material, is shown in the Image Explorer. Its structure is similar to the File Explorer. New images can be added to a project via the menu Object/New: Currently, this menu contains only the item From File which reads an existing image file into the project. All file formats which are supported by your installation of the Java Image I/O Framework are readable, these are at least Portable Network Graphics (`png`), JPEG and Graphics Interchange Format (`gif`). If a format you need is not supported by your installation, see [[01_user_documentation:user-manual:ch01#plugin_architecture|Section “Installation of Plugins for the Java Image I/O Framework”]]. As for the File Explorer, you have the choice to link or add image files to the project.
-**Figure 2.5. Image Explorer, Material Explorer, Attribute Editor**
-{{:user-manual:imgmatattr.png}}
-==== Attribute Editor ====
-Another panel which you will encounter often is the attribute editor (Figure 2.5, “Image Explorer, Material Explorer, Attribute Editor”). It is used to edit attributes of a variety of objects: User settings of configuration objects, geometric attributes of scene objects, attributes of resource objects like 3D materials, and others.
-Each attribute has a type, and each type brings up specific edit components in the attribute editor. For example, the radius attribute of circles or spheres is a numeric attribute and is editable through a simple input field. The orientation of a cylinder in 3D space is a 3D vector and, thus, it is editable through a set of three numeric input fields. Very complex attributes like 3D materials consist of several subattributes, each of which brings up its own edit components in the attribute editor.
-In Figure 2.5, you can see the attribute editor for a 3D material of type Phong. Such a material has the attributes _`Channel Input`_, _`Diffuse Colour`_, _`Transparency`_, _`Interpolated Transparency`_, _`Ambient Colour`_, _`Emissive Colour`_, _`Specular Colour`_ and _`Shininess`_. The Phong material shown has a Checkerboard 2D surface map as its _`Diffuse Colour`_, the checkerboard itself has the attributes _`Channel Input`_, _`Colour 1`_ and _`Colour 2`_. As _`Channel Input`_, an UV-Transformation is chosen, its numeric attributes are editable through the input fields. For angles and other attributes which represent physical quantities, their units are shown, in the this case **`deg`** which stands for degrees. As _`Colour 1`_, an RGB colour is chosen, whose values are modified by sliders.
-_`Colour 2`_ of the checkerboard is set to an image map. One could have chosen an RGB colour as for the first colour, a Checkerboard 2D as for the diffuse colour of the material, a simple constant colour, or some other valid type for this attribute. In GroIMP, there are many attributes whose values may be of a set of different types. For all these attributes, a button is shown in the attribute editor which pops up a menu to choose the desired type. Once a type has been chosen, the attribute value is set to this type, and appropriate edit components are created. They are shown within a minimizable subpanel. To minimize it (and to maximize it later on), click on its upper border where a small button is displayed. For example, the subpanel for the RGB components of the Opacity attribute is minimized in Figure 2.5. A double-click on the upper border maximizes the subpanel and minimizes all other panels.
-==== Preferences ====
-In the Preferences panel, you can configure some options of GroIMP and its plugins. GroIMP options can be provided from two level: 1) the Global options 2) the current workbench options.
-The Global options are used for any workbench that do not contains a specific current workbench options file.
-It contains options from all plugins. See the main ones:
-  * [[01_user_documentation:user-guide:panel_options|General panel options]]
-  * [[01_user_documentation:user-guide:panel_options#workbench_options|Setup a workbench option file]]
-  * [[01_user_documentation:groimp-platform:raytracing:raytracer_options|Main renderer options]]
-  * [[01_user_documentation:user-guide:gpuflux_options|GPUFlux options]]
-  * [[01_user_documentation:groimp-platform:input-and-output-in-groimp#options|Import and Export options]]
-==== Project Explorer ====
-This panel display all example project included in the GroIMP installation. The projects can be open and executed. They can be modified but not overridden, which means that the changes can only be saved in another project.
-==== Function Browser ====
-The function browser display a set of function available by default in all rgg files. They mostly comes from the __Library.java__ file, which is imported by default ([[:dev-guide:automatic-imports|more on default imports]]).
-The function browser content can be increased by adding content to the [[:dev-guide:add-content-registry-descriptor|registry content descriptors]].
-{{:user-guide:function-browser.png?400|}}
-==== Other Explorer Panels ====
-Besides files and images, a variety of other object kinds is displayed within an explorer panel. For example, Figure 2.5, “Image Explorer, Material Explorer, Attribute Editor” shows the Material Explorer panel. These panels are always similar to the file explorer or the image explorer: Objects are shown in a hierarchical tree-like layout, and new objects are created by the Object/New menu of the panel. The contents in this menu depend on the explorer: The Image Explorer reads in images from files, the Material Explorer allows the creation of new materials of several material types, etc.
-See more:
-  * [[01_user_documentation:groimp-platform:input-and-output-in-groimp|the list of import/export]] format in GroIMP to see all Explorer.