Commit 5181c888 authored by Jan Möbius's avatar Jan Möbius
Browse files

Updated building documentation

parent 5dc78ff3
...@@ -73,6 +73,7 @@ directory. ...@@ -73,6 +73,7 @@ directory.
\image html 06_choose_generator_a.png \image html 06_choose_generator_a.png
<li>We will use Visual Studio 2017 64-bit mode.</li> <li>We will use Visual Studio 2017 64-bit mode.</li>
\image html 06_choose_generator_b.png \image html 06_choose_generator_b.png
<li>After selection, the window should look like this.</li>
\image html 06_choose_generator_c.png \image html 06_choose_generator_c.png
<li>Afterwards, cmake will ask if we want to create the build directory, if it did not exist before. Choose yes here.</li> <li>Afterwards, cmake will ask if we want to create the build directory, if it did not exist before. Choose yes here.</li>
\image html 06_create_folder.png \image html 06_create_folder.png
...@@ -90,8 +91,9 @@ directory. ...@@ -90,8 +91,9 @@ directory.
\image html 11_configure_done.png \image html 11_configure_done.png
<li>If everything went fine, you should also have a "Generating done" in the log.</li> <li>If everything went fine, you should also have a "Generating done" in the log.</li>
\image html 12_generation_done.png \image html 12_generation_done.png
<li>Now you can open the generated Visual Studio project. Either by pressing the "Open Project" Button" or by navigating with the explorer to the build folder and opening the "OpenFlipper.sln" file.</li> <li>Now you can open the generated Visual Studio project. Either by pressing the "Open Project" Button"</li>
\image html 13_open_project.png \image html 13_open_project.png
<li>Or by navigating with the explorer to the build folder and opening the "OpenFlipper.sln" file.</li>
\image html 13_navigate_to_solution_file.png \image html 13_navigate_to_solution_file.png
<li>Make sure that OpenFlipper is the startup project.</li> <li>Make sure that OpenFlipper is the startup project.</li>
\image html 14_set_as_startup_project.png \image html 14_set_as_startup_project.png
......
...@@ -4,12 +4,12 @@ ...@@ -4,12 +4,12 @@
- <b>OpenFlipper 4.0 ( 25/02/2019 )</b> - <b>OpenFlipper 4.0 ( 25/02/2019 )</b>
- <b>Breaking changes</b> - <b>Breaking changes</b>
- Picking functions use size_t instead of unsigned int now (Required to get rid of a lot of warnings during compilation) - Picking functions use size_t instead of unsigned int now (Required to get rid of a lot of warnings during compilation)
- Enabled AUTOMOC in cmake for QT ( If you get redefinition errors, guard the corresponding headers with a #pragma once ; If you get gl.h before glew.h errors, move your widgets not using OpenGL into a subdir and add that to the DIRS macro in your CMakeLists.txt) - Enabled AUTOMOC in cmake for QT ( If you get redefinition errors, guard the corresponding headers with a pragma once ; If you get gl.h before glew.h errors, move your widgets not using OpenGL into a subdir and add that to the DIRS macro in your CMakeLists.txt)
- Enabled AUTOUIC in cmake for QT ( If you get trouble finding generated ui_*.hh headers, change your include to ui_*.h to get them generated correctly) - Enabled AUTOUIC in cmake for QT ( If you get trouble finding generated ui_*.hh headers, change your include to ui_*.h to get them generated correctly)
- Removed a lot of Scenegraph includes in BaseObjectData to reduce gl qt collisions and replaced them with forward declarations. (You have to include the scenegraph headers yourself now!) - Removed a lot of Scenegraph includes in BaseObjectData to reduce gl qt collisions and replaced them with forward declarations. (You have to include the scenegraph headers yourself now!)
- Removed a lot of unnecessary large QT includes from the Interfaces (Mostly QtWidgets). You have to add your own include statements in your plugins now. - Removed a lot of unnecessary large QT includes from the Interfaces (Mostly QtWidgets). You have to add your own include statements in your plugins now.
- Removed WhatsThisGenerator include from BaseInterface. You have to include it in the plugins now if you use it. - Removed WhatsThisGenerator include from BaseInterface. You have to include it in the plugins now if you use it.
- Removed the classical ObjectTypes CMake search. Please use the nex style ( Type-<Typename>/ObjectTypes/<Typename> + Type-<Typename>/Plugin-Type<TypeName> ) scheme - Removed the classical ObjectTypes CMake search. Please use the new style ( Type-Typename/ObjectTypes/<Typename> + Type-Typename/Plugin-TypeTypeName ) scheme
- Removed GlutExaminer and GlutViewer from ACG library - Removed GlutExaminer and GlutViewer from ACG library
- Removed glut from OpenFlipper - Removed glut from OpenFlipper
- Shipping with integrated glew to simplify build process - Shipping with integrated glew to simplify build process
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
* OpenGL Options:\n * OpenGL Options:\n
* -profile < compat | core > : request Compatibility or %Core context ( Default = %Core )\n * -profile < compat | core > : request Compatibility or %Core context ( Default = %Core )\n
* -glVersion <int.int> : request specified OpenGL version (Default = 3.2)\n * -glVersion <int.int> : request specified OpenGL version (Default = 3.2)\n
* -samples <int> : request MSAA with <int> samples (Default = 16)\n * -samples <int> : request MSAA with given number of samples (Default = 16)\n
* -glStereo <true | false> : request creation of stereo buffers * -glStereo <true | false> : request creation of stereo buffers
* \note The OpenGL command line parameters override stored settings temporarily. To permanently store an OpenGL setting, use the options dialog. * \note The OpenGL command line parameters override stored settings temporarily. To permanently store an OpenGL setting, use the options dialog.
* *
......
...@@ -914,6 +914,7 @@ IMAGE_PATH = @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperH ...@@ -914,6 +914,7 @@ IMAGE_PATH = @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperH
@CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/screenshots/ \ @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/screenshots/ \
@CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/building-screenshots/ \ @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/building-screenshots/ \
@CMAKE_SOURCE_DIR@/OpenFlipper/libs_required/OpenMesh/Doc/images/ \ @CMAKE_SOURCE_DIR@/OpenFlipper/libs_required/OpenMesh/Doc/images/ \
@CMAKE_SOURCE_DIR@/OpenFlipper/libs_required/ACG/Docu/ \
@CMAKE_SOURCE_DIR@/Type-OpenVolumeMesh/libs/OpenVolumeMesh/documentation/images/ \ @CMAKE_SOURCE_DIR@/Type-OpenVolumeMesh/libs/OpenVolumeMesh/documentation/images/ \
@CMAKE_SOURCE_DIR@/Type-Skeleton/ObjectTypes/Skeleton/doc/pics/ @CMAKE_SOURCE_DIR@/Type-Skeleton/ObjectTypes/Skeleton/doc/pics/
......
...@@ -914,6 +914,7 @@ IMAGE_PATH = @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperH ...@@ -914,6 +914,7 @@ IMAGE_PATH = @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperH
@CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/screenshots/ \ @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/screenshots/ \
@CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/building-screenshots/ \ @CMAKE_SOURCE_DIR@/OpenFlipper/Documentation/DeveloperHelpSources/building-screenshots/ \
@CMAKE_SOURCE_DIR@/OpenFlipper/libs_required/OpenMesh/Doc/images/ \ @CMAKE_SOURCE_DIR@/OpenFlipper/libs_required/OpenMesh/Doc/images/ \
@CMAKE_SOURCE_DIR@/OpenFlipper/libs_required/ACG/Docu/ \
@CMAKE_SOURCE_DIR@/Type-OpenVolumeMesh/libs/OpenVolumeMesh/documentation/images/ \ @CMAKE_SOURCE_DIR@/Type-OpenVolumeMesh/libs/OpenVolumeMesh/documentation/images/ \
@CMAKE_SOURCE_DIR@/Type-Skeleton/ObjectTypes/Skeleton/doc/pics/ @CMAKE_SOURCE_DIR@/Type-Skeleton/ObjectTypes/Skeleton/doc/pics/
......
...@@ -254,6 +254,7 @@ void clearFeatureVertices(MeshT* _mesh); ...@@ -254,6 +254,7 @@ void clearFeatureVertices(MeshT* _mesh);
* @param _mesh Mesh to work on * @param _mesh Mesh to work on
* @param _vertices The vertices belonging to the modeling area * @param _vertices The vertices belonging to the modeling area
* @param _type Bit to be changed ( Normally Modeling area is OpenMesh::Attributes::UNUSED << 1 ) * @param _type Bit to be changed ( Normally Modeling area is OpenMesh::Attributes::UNUSED << 1 )
* @param _state New state to be set
* */ * */
template< typename MeshT > template< typename MeshT >
inline inline
...@@ -276,6 +277,9 @@ inline ...@@ -276,6 +277,9 @@ inline
std::vector< int > getArea(MeshT* _mesh, unsigned int _type); std::vector< int > getArea(MeshT* _mesh, unsigned int _type);
/** Get the current vertex selection /** Get the current vertex selection
*
* @param _mesh Mesh to work on
* @param _type Bit to be changed ( Normally Modeling area is OpenMesh::Attributes::UNUSED << 1 )
* @param _invert if true : vector has been inverted to save mem * @param _invert if true : vector has been inverted to save mem
*/ */
template< typename MeshT > template< typename MeshT >
...@@ -330,6 +334,7 @@ inline ...@@ -330,6 +334,7 @@ inline
std::vector< int > getEdgeSelection(MeshT* _mesh); std::vector< int > getEdgeSelection(MeshT* _mesh);
/** Get the current edge selection /** Get the current edge selection
* @param _mesh Mesh to work on
* @param _invert if true : vector has been inverted to save mem * @param _invert if true : vector has been inverted to save mem
*/ */
template< typename MeshT > template< typename MeshT >
...@@ -338,6 +343,7 @@ std::vector< int > getEdgeSelection(MeshT* _mesh, bool& _invert); ...@@ -338,6 +343,7 @@ std::vector< int > getEdgeSelection(MeshT* _mesh, bool& _invert);
/** /**
* Select for each edge in _edges all incident vertices * Select for each edge in _edges all incident vertices
* @param _mesh Mesh to work on
* @param _edges List of edges to be converted * @param _edges List of edges to be converted
*/ */
template< typename MeshT > template< typename MeshT >
...@@ -353,6 +359,7 @@ void convertEdgeToVertexSelection(MeshT* _mesh); ...@@ -353,6 +359,7 @@ void convertEdgeToVertexSelection(MeshT* _mesh);
/** /**
* Select for each edge in _edges all adjacent faces * Select for each edge in _edges all adjacent faces
* @param _mesh Mesh to work on
* @param _edges List of edges to be converted * @param _edges List of edges to be converted
*/ */
template< typename MeshT > template< typename MeshT >
...@@ -515,6 +522,8 @@ inline ...@@ -515,6 +522,8 @@ inline
std::vector< int > getFaceSelection(MeshT* _mesh); std::vector< int > getFaceSelection(MeshT* _mesh);
/** Get the current face selection /** Get the current face selection
*
* @param _mesh Mesh to work on
* @param _invert if true : vector has been inverted to save mem * @param _invert if true : vector has been inverted to save mem
*/ */
template< typename MeshT > template< typename MeshT >
...@@ -523,6 +532,8 @@ std::vector< int > getFaceSelection(MeshT* _mesh, bool& _invert); ...@@ -523,6 +532,8 @@ std::vector< int > getFaceSelection(MeshT* _mesh, bool& _invert);
/** /**
* Select for each face in _faces all adjacent vertices * Select for each face in _faces all adjacent vertices
*
* @param _mesh Mesh to work on
* @param _faces List of faces to be converted * @param _faces List of faces to be converted
*/ */
template< typename MeshT > template< typename MeshT >
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment