User Tools

Site Tools


user-manual:ch02

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
user-manual:ch02 [2024/04/29 16:18] gaetanuser-manual:ch02 [2025/04/03 10:01] (current) – [Common panel handling] Tim
Line 1: Line 1:
 ====== Table of Contents ====== ====== Table of Contents ======
     * [[:User-Manual:ch02#graphical_user_interface|Graphical User Interface]]     * [[:User-Manual:ch02#graphical_user_interface|Graphical User Interface]]
-    * [[:User-Manual:ch02#panels_handling|Common Panel Handling]]+    * [[:User-Manual:ch02#handling_of_panels|Common Panel Handling]]
     * [[:User-Manual:ch02#projects_handling|GroIMP's Projects]]     * [[:User-Manual:ch02#projects_handling|GroIMP's Projects]]
     * [[:User-Manual:ch02#import_and_export_data|Import Export Data]]     * [[:User-Manual:ch02#import_and_export_data|Import Export Data]]
Line 19: Line 19:
  
  
-====== Panels Handling ======+====== Handling of panels ======
  
 ===== Common panel handling ===== ===== Common panel handling =====
Line 29: Line 29:
 Normally, not all possible panels are actually present in the user interface. However, all panels are accessible through the Panels menu of GroIMP's main window. If a panel you need is missing, just select it in the main Panels menu. This brings up the panel in a new floating window. Normally, not all possible panels are actually present in the user interface. However, all panels are accessible through the Panels menu of GroIMP's main window. If a panel you need is missing, just select it in the main Panels menu. This brings up the panel in a new floating window.
  
-The arrangement of all panels is called a panel _layout_. The menu Panels/Set Layout provides a set of predefined layouts which are useful for distinct tasks; the menu item Panels/Add Layout adds the current layout to the list of user-defined layouts of the current project. User-defined layouts are also accessible in the menu Panels/Set Layout.+The arrangement of all panels is called a panel _layout_. The menu Panels/Set Layout provides a set of predefined layouts that are useful for distinct tasks; the menu item Panels/Add Layout adds the current layout to the list of user-defined layouts of the current project. User-defined layouts are also accessible in the menu Panels/Set Layout.
  
 See more documentation on: See more documentation on:
   * [[:user-guide:common_panels|Common Panels]]   * [[:user-guide:common_panels|Common Panels]]
   * [[:user-guide:panel_options|Panel options]]   * [[:user-guide:panel_options|Panel options]]
-  * [[:user-guide:panel_data_import|Import data from Panels]]+  * [[:tutorials:import-object-in-groimp|Import data from Panels]] 
 +  * [[:user-guide:more_panels|More Panels]]
  
  
Line 40: Line 41:
  
  
-The main entity you work on in GroIMP is the _project_. A project may consist of various parts, e.g., files, source code, a scene (2D, 3D, or other), resource objects like data sets, 3D materials or the like. Several projects can be open at the same time, each in its own main window.+The main entity you work on in GroIMP is the //project//. A project may consist of various parts, e.g., files, source code, a scene (2D, 3D, or other), resource objects like data sets, 3D materials or the like. Several projects can be open at the same time, each in its own main window.
  
 You create a new project by choosing the menu item File/New/Project. Via File/Open, projects can be read from a file. Different file formats are available: GS and GSZ are GroIMP's native project formats, the other formats are imported into a new project. You create a new project by choosing the menu item File/New/Project. Via File/Open, projects can be read from a file. Different file formats are available: GS and GSZ are GroIMP's native project formats, the other formats are imported into a new project.
  
-Saving of a project is done in the File menu too. Here, only GS and GSZ are available as file formats. The GS file format in fact consists of a set of files written in the folder containing the GS file: `graph.xml` contains the scene graph of the project, the folder `META-INF` some meta information about the files, and if there are files included in the project, they will be written in the folder (or subfolders) too. To avoid conflicts between different projects, it is mandatory to use an own folder for each project.+Saving of a project is done in the File menutoo. Here, only GS and GSZ are available as file formats. The GS file format in fact consists of a set of files written in the folder containing the GS file: `graph.xml` contains the scene graph of the project, the folder `META-INF` some meta information about the files, and if there are files included in the project, they will be written in the folder (or subfolders) too. To avoid conflicts between different projects, it is mandatory to use an own folder for each project.
  
 Contrary to the GS file format, the GSZ file format only consists of a single file. This file is actually a file in the common zip-format with special content: It contains all the files which comprise a project in the GS file format in a single zip archive. You can use standard zip tools to examine or even modify its contents. Contrary to the GS file format, the GSZ file format only consists of a single file. This file is actually a file in the common zip-format with special content: It contains all the files which comprise a project in the GS file format in a single zip archive. You can use standard zip tools to examine or even modify its contents.
Line 50: Line 51:
 While working with an open project, there is one difference between projects in GS/GSZ file format: If you modify and save files (e.g., text files) contained in a GS project, they will be written to your file system immediately because the GS file format consists of a set of files in your file system. However, for a GSZ project, these files are written to an internal storage: Your modifications are persistently saved only when the whole project is saved. While working with an open project, there is one difference between projects in GS/GSZ file format: If you modify and save files (e.g., text files) contained in a GS project, they will be written to your file system immediately because the GS file format consists of a set of files in your file system. However, for a GSZ project, these files are written to an internal storage: Your modifications are persistently saved only when the whole project is saved.
  
 +See more:
 +  * [[:groimp-platform:gs-project|Complete description of a GroIMP project]]
 ====== Import and Export Data ====== ====== Import and Export Data ======
  
-There are many file type supported in GroIMP. Find the complete list [[:GroIMP-Platform:Input-and-output-in-GroIMP|here]].+Many file types are supported in GroIMP. 
  
 +See more:
 +  * Find the complete list [[:GroIMP-Platform:Input-and-output-in-GroIMP|here]].
 +
 +Tutorial:
 +  * [[:dev-guide:create-new-mimetypes-and-file-types|How to add a new object type importer/exporter]]
 +  * [[:tutorials:import-object-in-groimp|How to import objects in GroIMP]]
 ==== Import a Project ==== ==== Import a Project ====
  
-To import a file as project you need to click on //file>open...//. The list of supported project type is : +To import a file as project you need to click on //File>Open...//. The list of supported project types is : 
   * gs   * gs
   * gsz   * gsz
Line 67: Line 76:
 ==== Import an Object in the Graph ==== ==== Import an Object in the Graph ====
  
-To import an object you need to have a project open. Then in //object>Insert File// will help you select the object you want to import in your project. +To import an object you need to have a project open. Then//Object>Insert File// will help you select the object you want to import into your project. 
  
 An object is imported as a node in your project. It can be added under either the root of the project, or the RGGRoot.  An object is imported as a node in your project. It can be added under either the root of the project, or the RGGRoot. 
Line 73: Line 82:
 ==== Import an Object in an Explorer ==== ==== Import an Object in an Explorer ====
  
-GroIMP also include many repositories for external objects. They usually are manager from explorers.  +GroIMP also includes many repositories for external objects. They usually are managed from explorers.  
-In these explorer you can click on //object>new>...// to add a new object of the correct type in the explorer.+In these explorers you can click on //Object>New>...// to add a new object of the correct type in the explorer.
  
-For instance, for files, withing the file explorer: //object>new>Add file// will help you select the file you want to add to your project.+For instance, for files, within the File explorer: //Object>New>Add file// will help you select the file you want to add to your project.
 ==== MTG ==== ==== MTG ====
 Follow this [[:Tutorials:import_mtg|tutorial]] on how to import MTG in GroIMP. Follow this [[:Tutorials:import_mtg|tutorial]] on how to import MTG in GroIMP.
  
 +===== Resource Drag and Drop =====
 +
 +Starting with GroIMP 2.1.6 it is possible to select items from a explorer and drop them to the CodeEditor, to create a reference to this resource. For example a shader called "leaf" could be selected in the shader explorer and dragged into the text editor. After dropping it the reference ''shader("leaf")'' will be created.
user-manual/ch02.1714400310.txt.gz · Last modified: 2024/04/29 16:18 by gaetan