--- /dev/null
+// Special file to define and describe the modules (goups)
+
+/**
+ * \defgroup DataModel Data model
+ *
+ * \brief Structures for storage and management the application data.
+ *
+ * Data structures are unified and splitted in universal <b>ModelAPI</b> package.
+ * The OCCT specialized implementation of ModelAPI interfaces is located in the <b>Model</b>.
+ * The geometrical primitives interfaces in <b>GeomAPI</b> package are supported by geometrical
+ * persistence elements in <b>GeomDatAPI</b> interface and has OCCT-specific implementation in GeomData package.
+ *
+ */
+
+/**
+ * \defgroup DataAlgo Algorithms
+ *
+ * \brief Different algorithm used in the application
+ *
+ * The geometrical algorithms implementation (basing on OCCT libraries) are located in <b>GeomAlgoAPI</b>.
+ *
+ */
+
+/**
+ * \defgroup Plugins Plugins
+ *
+ * \brief Implementation of specific features of the application is concentrated in plugins.
+ *
+ * The C++ and Python features implementations are located in plugins: specially organized libraries
+ * and configuration files that allows to define the user interface and specific algorithms.
+ * There are many plugins that should be extended wit hthe development of the application. The names
+ * of plugin-packages are ended with "Plugin" string:
+ * <b>PartSetPlugin</b>, <b>ConstructionPlugin</b>, <b>SketchPlugin</b>, <b>FeaturesPlugins</b>, etc.
+ *
+ */
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = @PROJECT_SOURCE_DIR@/src
+INPUT = @PROJECT_SOURCE_DIR@/src @CMAKE_CURRENT_SOURCE_DIR@
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
FILE_PATTERNS = *.h \
*.cpp \
*.hxx \
- *.cxx
+ *.cxx \
+ *.doc
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# directories that contain image that are included in the documentation (see
# the \image command).
-IMAGE_PATH =
+IMAGE_PATH = @CMAKE_CURRENT_SOURCE_DIR@
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
--- /dev/null
+/*!
+\page general_architecture General Architecture
+
+New GEOM is used either as a stand-alone application or as a Module integrated to the SALOME environment in order to, ultimately, replace the old GEOM.
+
+<h2>Stand-alone New GEOM</h2>
+
+When used outside SALOME, New GEOM must be hosted by an application window implementing the general ergonomics of New GEOM (the GUI), including the layout of the user interface, organization of menus, runtime help, etc.
+\n
+It is proposed that this application window can host several so-called Modules. Below, this main application window is named the Workshop.
+\n\n
+Each Module hosted by the Workshop deals with one type of document only, saved in a format supported by the Module. One document type per Module. Also, in a Workshop window, only one document of a given type can be newed. So, when launching the Workshop, the user selects a type of document to be created. Then, from the application session, creating a new document will launch a new instance of the Workshop.
+\n\n
+The geometric model (i.e. the whole geometry produce by New GEOM) is created through operations, or features, which define a meaningful piece of design (e.g. NewPart, Extrusion, Revolution, Cut, Transformation). In order to easily create dedicated variants of the modeler, also to gradually develop New GEOM, each feature is implemented as a <i>Plug-in</i> (A Plug-in is a piece of application including its own GUI, built separately from the application. It is loaded dynamically to the application). In other words, a Module is made of a collection of Plug-in.
+\n\n
+The Workshop structures the features by related functionality presented in a tabbed interface. Each tab displays a set of available actions. These sets of features are called below <i>Workbenches</i>.
+\n\n
+Additionally, a Module can either reference or include other Modules:
+<ul>
+<li>
+A Module references another one when the document it produces references a document created by the other Module.
+In this case, each document is edited from the corresponding Module running in separate instances of the Workshop. The Workbenches of each Module are presented into distinct windows.
+</li>
+<li>
+A Module include another Module when additionally, the Module of referenced document runs into the same Workshop.
+In this context, both documents can be edited from a single instance of the Workshop. The Workbenches of both Modules are presented into the same window.
+</li>
+</ul>
+
+
+
+<h2>Application to New GEOM</h2>
+
+New GEOM is made of one Module, Set of Parts (a Set of Parts is a flat list of Parts, on the contrary of an Assembly in which the Parts are structured), including two other Modules, <i>Part</i> and <i>Properties</i>. The Set of Parts Module produces a <i>PartSet</i> document which references a list of Parts (one document per Part), the PartSet document being referenced by a Properties document (one document per PartSet).
+\n\n
+The Set of Parts, its Properties and the Parts it references are all edited from the same Workshop window. The Properties and Part documents cannot be open independently of PartSet (the corresponding Modules being available only as included in Set of Parts).
+\n
+When creating a new PartSet, a Property document is automatically created. The Workbench of the Set of Parts Module includes a feature for creating a new Part. Once the first Part is created, the Workbenches of Part Module are activated. One Part of the ParSet being always active, the features of Part Module apply to this Part.
+\n
+When the user saves its session, all documents are saved: the PartSet, its Properties and each Part.
+\n\n
+\image html general_architecture_1.png
+\n
+
+<b>Summary of the general architecture of New GEOM:</b>
+<ul>
+<li> New GEOM consists of several Modules running within a Workshop.</li>
+<li> Each Module produces one type of Document only.</li>
+<li> A Module is made of Plug-in implementing the Features supported by the Module.</li>
+<li> These Features are structured by Workbenches.</li>
+<li> A Module can provide access to the Workbenches of other Modules by including these Modules.</li>
+<li> The Modules communicate with the Workshop through Interfaces.</li>
+<li> The API of New GEOM consists of the Interface of the Workshop and of Modules.</li>
+<li> A configuration file describes the composition of the Workshop where the Modules and the Plug-in are referenced by their Global Unique Identifier (GUID).</li>
+</ul>
+
+
+
+<h2>New GEOM as SALOME module</h2>
+
+The NewGeom package allows to launch the application as one of the module of SALOME platform. In that case all user interface elements are integrated into SALOME platform: the \b NewGeom package is used for this connection.
+
+Initially the New GEOM application is defined as a Light SALOME module, later it may be changed in order to manage the communication with other SALOME modules correctly.
+\n
+To integrate New GEOM into SALOME the next steps are done:
+<ol>
+<li> LightApp_Module class from SALOME GUI LightApp package is redefined. This redefined class provides a connection between LightApp_Module interface and Workshop object of the application.</li>
+<li>Provide Workshop with a <i>module</i> mode of launching in SALOME environment. In this case it is launched without its own main window, 3d viewer and main menu.</li>
+<li>In <i>module</i> mode workshop uses:
+ <ol>
+ <li>SALOME desktop as a main window.</li>
+ <li>OCC viewer from SALOME platform instead of its own 3d viewer.</li>
+ <li>SALOME main menu and toolbars for creation of workbenches commands.</li>
+ <li>Object Browser of New GEOM application is used instead of SALOME Object Browser.</li>
+ <li>Creation of a New GEOM property panel as a docking window of SALOME desktop.</li>
+ <li>Use SALOME Python console instead of console in main window. Since 3 packages from SALOME GUI module become shared between this project and SALOME mod-ules and they are independed from other SALOME parts, it is proposed in the future to detach it from SALOME platform into separated prerequisite product to avoid code duplication.</li>
+ </ol>
+</li>
+<li>Each workbench will be defined as a menu in main menu bar of SALOME desktop and as a toolbar with corresponded title.</li>
+<li>Each feature in the workbench will be defined as a menu item in the corresponded menu and a button in the corresponded toolbar.</li>
+<li>Object Browser of SALOME is hidden on activation of NewGEOM and restored on its deactivation.</li>
+<li>Object Browser and Property panel of NewGEOM is shown on activation of the module and hidden on its deactivation.</li>
+<li>Persistent of NewGEOM is compatible with persistent of SALOME. On saving of SALOME study the content of NewGEOM data structure is saved into study also and restored on restoring of study.</li>
+</ol>
+
+*/
--- /dev/null
+/*! \mainpage
+
+To browse the New GEOM module Developer Documentation, follow the links below or use navigation menu at the top and left of the page:
+<ul>
+<li> <a href="modules.html">Modules</a> - documentation of functionality splitted into groups.</li>
+<li> <a href="hierarchy.html">Class hierarchy</a></li> - graphical representation of classes hierarchy.</li>
+<li> <a href="annotated.html">Data Structures</a> - list of all data structures and classes with brief descriptions.</li>
+<li> <a href="files.html">Files</a> - list of all files with brief descriptions.</li>
+</ul>
+
+Also you may see \subpage general_architecture document that describes
+the main principles and terms of the development.
+
+The creation of new feature in C++ or python can be done with help of \subpage first_feature_help .
+
+*/
const std::string POINT_ATTR_SECOND = "secondPoint";
/**\class ConstructionPlugin_Axis
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new axis in PartSet.
*/
class ConstructionPlugin_Axis : public ModelAPI_Feature, public GeomAPI_ICustomPrs
const std::string DISTANCE_ATTR = "distance";
/**\class ConstructionPlugin_Plane
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new planar surface in PartSet.
*/
class ConstructionPlugin_Plane : public ModelAPI_Feature, public GeomAPI_ICustomPrs
const std::string POINT_ATTR_Z = "z";
/**\class ConstructionPlugin_Point
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new part in PartSet.
*/
class ConstructionPlugin_Point : public ModelAPI_Feature
namespace BREPImport {
+/// Implementation of the import BREP files algorithms
GEOMALGOAPI_EXPORT
TopoDS_Shape Import(const TCollection_AsciiString& theFileName,
const TCollection_AsciiString& theFormatName,
#include <GeomAlgoAPI_MakeShape.h>
#include <GeomAPI_DataMapOfShapeShape.h>
#include <memory>
+
/**\class GeomAlgoAPI_Extrusion
* \ingroup DataAlgo
* \brief Allows to create the prism based on a given face and a direction
#include <GeomAlgoAPI.h>
/**\class GeomAlgoAPI_MakeShape
- * \ingroup DataModel
+ * \ingroup DataAlgo
* \brief Interface to the root class of all topological shapes constructions
*/
class GeomAlgoAPI_MakeShape : public GeomAPI_Interface
namespace STEPImport {
+/// Implementation of the import parameter from the STEP file
GEOMALGOAPI_EXPORT
Handle(TCollection_HAsciiString) GetValue(const TCollection_AsciiString& theFileName,
const TCollection_AsciiString& theParameterName,
TCollection_AsciiString& theError);
+
+/// Implementation of the import STEP files algorithms
GEOMALGOAPI_EXPORT
TopoDS_Shape Import(const TCollection_AsciiString& theFileName,
const TCollection_AsciiString& theFormatName, TCollection_AsciiString& theError,
#include "PartSetPlugin_Part.h"
/**\class PartSetPlugin_Duplicate
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Duplicates the active part (not root). Creates a new "part" feature.
*/
class PartSetPlugin_Duplicate : public PartSetPlugin_Part
#include <ModelAPI_Feature.h>
/**\class PartSetPlugin_Part
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new part in PartSet.
*/
class PartSetPlugin_Part : public ModelAPI_Feature
#include <ModelAPI_Feature.h>
/**\class PartSetPlugin_Remove
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new part in PartSet.
*/
class PartSetPlugin_Remove : public ModelAPI_Feature
#include <GeomAPI_IPresentable.h>
/**\class SketchPlugin_Arc
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new arc of circle in PartSet.
* The visualization of this object is separated in two parts. The first one is an AIS object
* calculated when there is non-initialized attributes of the arc. The second is a result and
#include <GeomAPI_IPresentable.h>
/**\class SketchPlugin_Circle
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new circle in PartSet.
*/
class SketchPlugin_Circle : public SketchPlugin_Feature
#include <list>
-/* Description:
+/** Description:
* Each constraint uses a set of parameters. In the SolveSpace library
* these parameters are named "valA", "ptA", "ptB", "entityA", "entityB".
* The "ptA" and "ptB" parameters represents a point in the constraint.
*/
/** \class SketchPlugin_ConstraintBase
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint between other features.
* Some feature's methods implemented here as dummy to
* Base class for all constraints.
#include <list>
/** \class SketchPlugin_ConstraintCoincidence
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint which defines equivalence of two points
*
* This constraint has two attributes:
#define DISTANCE_COLOR "#ff00ff"
/** \class SketchPlugin_ConstraintDistance
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint which defines a distance
* between a point and another feature (point, line, plane or face)
*
#define LENGTH_COLOR "#ff00ff"
/** \class SketchPlugin_ConstraintLength
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint which defines a length of a line segment
*
* This constraint has two attributes:
#define PARALLEL_COLOR "#ffff00"
/** \class SketchPlugin_ConstraintParallel
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint parallelism of two lines
*
* This constraint has two attributes:
#define PERPENDICULAR_COLOR "#ffff00"
/** \class SketchPlugin_ConstraintPerpendicular
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint for perpendicularity of two lines
*
* This constraint has two attributes:
#define RADIUS_COLOR "#ff00ff"
/** \class SketchPlugin_ConstraintRadius
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint which defines
* a radius of a circle or an arc of circle
*
#define FIXING_COLOR "#ffff00"
/** \class SketchPlugin_ConstraintRigid
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new constraint which defines immovable object
*
* This constraint has one attribute:
class Handle_AIS_InteractiveObject;
/**\class SketchPlugin_Feature
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
* an interface to create the sketch feature preview.
*/
#include <list>
/**\class SketchPlugin_Line
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new part in PartSet.
*/
class SketchPlugin_Line : public SketchPlugin_Feature
#include <ModelAPI_Events.h>
/**\class SketchPlugin_Plugin
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Interface common for any plugin: allows to use plugin by the plugins manager.
*/
class SKETCHPLUGIN_EXPORT SketchPlugin_Plugin : public ModelAPI_Plugin, public Events_Listener
#include <list>
/**\class SketchPlugin_Point
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of a new point.
*/
class SketchPlugin_Point : public SketchPlugin_Feature
#define PLANE_SIZE "200"
/**\class SketchPlugin_Sketch
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Feature for creation of the new part in PartSet.
*/
class SketchPlugin_Sketch : public ModelAPI_CompositeFeature//, public GeomAPI_IPresentable
#include <vector>
/** \class SketchSolver_Constraint
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Obtain information about SketchPlugin's constraint
*/
class SketchSolver_Constraint
ConstraintMap;
/** \class SketchSolver_ConstraintGroup
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Keeps the group of constraints which based on the same entities
*/
class SketchSolver_ConstraintGroup
#include <set>
/** \class SketchSolver_ConstraintManager
- * \ingroup DataModel
+ * \ingroup Plugins
* \brief Listens the changes of SketchPlugin features and transforms the Constraint
* feature into the format understandable by SolveSpace library.
*
