.github/workflows/all-builds.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   Qtk:
     env:
-      CONFIG: -DQTK_SUBMODULES=ON -DQTK_DEBUG=OFF -DQTK_CCACHE=OFF -DQTK_GUI=ON -DQTK_LIBRARY=ON -DQTK_PLUGINS=OFF -DQTK_EXAMPLE=ON
+      CONFIG: -DQTK_SUBMODULES=ON -DQTK_DEBUG=OFF -DQTK_CCACHE=OFF -DQTK_GUI=ON -DQTK_PLUGINS=OFF -DQTK_EXAMPLE=ON
     strategy:
       fail-fast: false
       matrix:
@@ -138,7 +138,7 @@ jobs:
 
   Qtk-Library:
     env:
-      CONFIG: -DQTK_SUBMODULES=ON -DQTK_DEBUG=OFF -DQTK_CCACHE=OFF -DQTK_GUI=OFF -DQTK_LIBRARY=ON -DQTK_PLUGINS=OFF -DQTK_EXAMPLE=OFF
+      CONFIG: -DQTK_SUBMODULES=ON -DQTK_DEBUG=OFF -DQTK_CCACHE=OFF -DQTK_GUI=OFF -DQTK_PLUGINS=OFF -DQTK_EXAMPLE=OFF
     strategy:
       fail-fast: false
       matrix:
@@ -176,7 +176,7 @@ jobs:
       - name: Build Qtk Library (Windows)
         if: matrix.os == 'windows-latest'
         shell: bash
-        run: cmake --build build/ --config Release
+        run: cmake --build build/ --config Release --target qtk_library
 
       # OSX / Linux
 
@@ -254,7 +254,7 @@ jobs:
 
   Qtk-Plugins:
     env:
-      CONFIG: -DQTK_SUBMODULES=ON -DQTK_DEBUG=OFF -DQTK_CCACHE=OFF -DQTK_GUI=OFF -DQTK_LIBRARY=OFF -DQTK_PLUGINS=ON -DQTK_EXAMPLE=OFF
+      CONFIG: -DQTK_SUBMODULES=ON -DQTK_DEBUG=OFF -DQTK_CCACHE=OFF -DQTK_GUI=OFF -DQTK_PLUGINS=ON -DQTK_EXAMPLE=OFF
     strategy:
       fail-fast: false
       matrix:

.github/workflows/linting.yml

@@ -21,8 +21,8 @@ jobs:
 
       - name: Build Qtk
         run: |
-          cmake -B build -DQTK_UPDATE_SUBMODULES=OFF -DQTK_ENABLE_CCACHE=OFF
-          cmake --build build
+          cmake -B build -DQTK_SUBMODULES=OFF -DQTK_CCACHE=OFF -DQTK_PLUGINS=OFF -DQTK_GUI=ON
+          cmake --build build --target qtk_gui -- -j $(nproc)
 
       - uses: cpp-linter/cpp-linter-action@v2
         id: linter

README.md

@@ -241,7 +241,7 @@ Last we need to run `clang-format`, this can be done with the command directly.
 This will reformat all the code in the repository.
 
 ```bash
-clang-format -i --style=file:.clang-format src/*.cpp src/*.h app/*.cpp app/*.h
+clang-format -i --style=file:.clang-format src/app/*.cpp src/app/*.h src/qtk/*.cpp src/qtk/*.h example-app/*.cpp example-app/*.h
 ```
 
 `clang-format` can be run with git integration (or CLion if you prefer).

example-app/examplescene.cpp

@@ -11,7 +11,7 @@
 
 using namespace Qtk;
 
-ExampleScene::ExampleScene(Qtk::Scene *scene) : Qtk::SceneInterface(scene) {
+ExampleScene::ExampleScene(Qtk::Scene * scene) : Qtk::SceneInterface(scene) {
   setSceneName("Example Scene");
   getCamera().getTransform().setTranslation(-8.0f, 0.0f, 10.0f);
   getCamera().getTransform().setRotation(-5.0f, 0.0f, 1.0f, 0.0f);
@@ -24,8 +24,8 @@ void ExampleScene::init() {
   setSkybox(skybox);
 
   auto spartan = new Model(
-      "spartan", std::string(QTK_EXAMPLE_SOURCE_DIR) +
-                 "/../resources/models/spartan/spartan.obj");
+      "spartan", std::string(QTK_EXAMPLE_SOURCE_DIR)
+                     + "/../resources/models/spartan/spartan.obj");
   addObject(spartan);
   spartan->getTransform().setTranslation(-4.0f, 0.0f, 0.0f);
 

src/qtk/model.h

@@ -27,184 +27,185 @@ namespace Qtk {
    * Top-level object that represents 3D models stored within a scene.
    */
   class QTKAPI Model : public Object {
-  public:
-    /*************************************************************************
-     * Typedefs
-     ************************************************************************/
+    public:
+      /*************************************************************************
+       * Typedefs
+       ************************************************************************/
 
-    /** ModelManager typedef that will manage global model access. */
-    typedef QHash<QString, Model *> ModelManager;
+      /** ModelManager typedef that will manage global model access. */
+      typedef QHash<QString, Model *> ModelManager;
 
-    /*************************************************************************
-     * Constructors, Destructors
-     ************************************************************************/
+      /*************************************************************************
+       * Constructors, Destructors
+       ************************************************************************/
 
-    /**
-     * Constructs a Model
-     * If no shaders are provided we will use default shaders.
-     *
-     * @param name Name to use for the Model's objectName.
-     * @param path Path to the model to load for construction.
-     * @param vertexShader Optional path to custom vertex shader.
-     * @param fragmentShader Optional path to custom fragment shader.
-     */
-    inline Model(
-        const char *name, const char *path,
-        const char *vertexShader = ":/shaders/model-basic.vert",
-        const char *fragmentShader = ":/shaders/model-basic.frag") :
-        Object(name, QTK_MODEL),
-        mModelPath(path), mVertexShader(vertexShader),
-        mFragmentShader(fragmentShader) {
-      loadModel(mModelPath);
-    }
+      /**
+       * Constructs a Model
+       * If no shaders are provided we will use default shaders.
+       *
+       * @param name Name to use for the Model's objectName.
+       * @param path Path to the model to load for construction.
+       * @param vertexShader Optional path to custom vertex shader.
+       * @param fragmentShader Optional path to custom fragment shader.
+       */
+      inline Model(
+          const char * name, const char * path,
+          const char * vertexShader = ":/shaders/model-basic.vert",
+          const char * fragmentShader = ":/shaders/model-basic.frag") :
+          Object(name, QTK_MODEL),
+          mModelPath(path), mVertexShader(vertexShader),
+          mFragmentShader(fragmentShader) {
+        loadModel(mModelPath);
+      }
 
-    inline Model(
-        std::string name, std::string path,
-        std::string vertexShader = ":/shaders/model-basic.vert",
-        std::string fragmentShader = ":/shaders/model-basic.frag") :
-        Model(name.c_str(), path.c_str(), vertexShader.c_str(),
+      inline Model(
+          std::string name, std::string path,
+          std::string vertexShader = ":/shaders/model-basic.vert",
+          std::string fragmentShader = ":/shaders/model-basic.frag") :
+          Model(
+              name.c_str(), path.c_str(), vertexShader.c_str(),
               fragmentShader.c_str()) {}
 
-    inline ~Model() override { mManager.remove(getName().c_str()); }
+      inline ~Model() override { mManager.remove(getName().c_str()); }
 
-    /*************************************************************************
-     * Public Methods
-     ************************************************************************/
+      /*************************************************************************
+       * Public Methods
+       ************************************************************************/
 
-    /**
-     * Draws the model using attached shader program.
-     */
-    void draw();
+      /**
+       * Draws the model using attached shader program.
+       */
+      void draw();
 
-    /**
-     * Draws the model using a custom shader program.
-     *
-     * @param shader Shader program to use to draw the model.
-     */
-    void draw(QOpenGLShaderProgram &shader);
+      /**
+       * Draws the model using a custom shader program.
+       *
+       * @param shader Shader program to use to draw the model.
+       */
+      void draw(QOpenGLShaderProgram & shader);
 
-    /**
-     * Flip a texture associated with this model
-     *
-     * @param fileName The name of the texture to flip as it is stored on disk
-     * @param flipX Flip the texture along the X axis
-     * @param flipY Flip the texture along the Y axis
-     */
-    void flipTexture(
-        const std::string &fileName, bool flipX = false, bool flipY = true);
+      /**
+       * Flip a texture associated with this model
+       *
+       * @param fileName The name of the texture to flip as it is stored on disk
+       * @param flipX Flip the texture along the X axis
+       * @param flipY Flip the texture along the Y axis
+       */
+      void flipTexture(
+          const std::string & fileName, bool flipX = false, bool flipY = true);
 
-    /*************************************************************************
-     * Setters
-     ************************************************************************/
+      /*************************************************************************
+       * Setters
+       ************************************************************************/
 
-    /**
-     * Sets a uniform value for each ModelMesh within this Model.
-     *
-     * @tparam T The type of the value we are settings
-     * @param location The uniform location
-     * @param value The value to assign to the uniform
-     */
-    template<typename T>
-    inline void setUniform(const char *location, T value) {
-      for (auto &mesh: mMeshes) {
-        mesh.mProgram->bind();
-        mesh.mProgram->setUniformValue(location, value);
-        mesh.mProgram->release();
+      /**
+       * Sets a uniform value for each ModelMesh within this Model.
+       *
+       * @tparam T The type of the value we are settings
+       * @param location The uniform location
+       * @param value The value to assign to the uniform
+       */
+      template <typename T>
+      inline void setUniform(const char * location, T value) {
+        for(auto & mesh : mMeshes) {
+          mesh.mProgram->bind();
+          mesh.mProgram->setUniformValue(location, value);
+          mesh.mProgram->release();
+        }
       }
-    }
 
-    /*************************************************************************
-     * Accessors
-     ************************************************************************/
+      /*************************************************************************
+       * Accessors
+       ************************************************************************/
 
-    /**
-     * Accessor function for retrieving a ModelMesh globally.
-     * The mesh is retrieved from the mManager private member.
-     *
-     * @param name The name of the model to load as it was constructed.
-     * @return Pointer to the model stored within the scene.
-     */
-    [[nodiscard]] static Model *getInstance(const char *name);
+      /**
+       * Accessor function for retrieving a ModelMesh globally.
+       * The mesh is retrieved from the mManager private member.
+       *
+       * @param name The name of the model to load as it was constructed.
+       * @return Pointer to the model stored within the scene.
+       */
+      [[nodiscard]] static Model * getInstance(const char * name);
 
-    /**
-     * @return Transform3D attached to this Model.
-     */
-    inline Transform3D &getTransform() { return mTransform; }
+      /**
+       * @return Transform3D attached to this Model.
+       */
+      inline Transform3D & getTransform() { return mTransform; }
 
-  private:
-    /*************************************************************************
-     * Private Methods
-     ************************************************************************/
+    private:
+      /*************************************************************************
+       * Private Methods
+       ************************************************************************/
 
-    /**
-     * Loads a model in .obj, .fbx, .gltf, and other formats.
-     * For a full list of formats see assimp documentation:
-     *  https://github.com/assimp/assimp/blob/master/doc/Fileformats.md
-     *
-     * Large models should not be loaded into Qt resource system.
-     * Instead pass an *absolute* path to this function.
-     * Relative paths will break if Qtk is executed from different locations.
-     *
-     * @param path Absolute path to a model in .obj or another format accepted
-     * by assimp.
-     */
-    void loadModel(const std::string &path);
+      /**
+       * Loads a model in .obj, .fbx, .gltf, and other formats.
+       * For a full list of formats see assimp documentation:
+       *  https://github.com/assimp/assimp/blob/master/doc/Fileformats.md
+       *
+       * Large models should not be loaded into Qt resource system.
+       * Instead pass an *absolute* path to this function.
+       * Relative paths will break if Qtk is executed from different locations.
+       *
+       * @param path Absolute path to a model in .obj or another format accepted
+       * by assimp.
+       */
+      void loadModel(const std::string & path);
 
-    /**
-     * Process a node in the model's geometry using Assimp.
-     *
-     * @param node The Assimp node to process.
-     * @param scene The Assimp scene for the loaded model.
-     */
-    void processNode(aiNode *node, const aiScene *scene);
+      /**
+       * Process a node in the model's geometry using Assimp.
+       *
+       * @param node The Assimp node to process.
+       * @param scene The Assimp scene for the loaded model.
+       */
+      void processNode(aiNode * node, const aiScene * scene);
 
-    /**
-     * Process a mesh within a node using Assimp.
-     *
-     * @param mesh The Assimp mesh to process.
-     * @param scene The Assimp scene for the loaded model.
-     * @return
-     */
-    ModelMesh processMesh(aiMesh *mesh, const aiScene *scene);
+      /**
+       * Process a mesh within a node using Assimp.
+       *
+       * @param mesh The Assimp mesh to process.
+       * @param scene The Assimp scene for the loaded model.
+       * @return
+       */
+      ModelMesh processMesh(aiMesh * mesh, const aiScene * scene);
 
-    /**
-     * Load a collection of material texture using Assimp.
-     * This function loads diffuse, specular, and narmal material textures.
-     * A Mesh may have many of any or all of the texture types above.
-     * Models can have many Meshes attached.
-     * This function returns all textures for a single Mesh within a Model.
-     *
-     * @param mat Loaded Assimp material.
-     * @param type Type of the material.
-     * @param typeName Texture type name in string format.
-     * @return Collection of all textures for a single ModelMesh.
-     */
-    ModelMesh::Textures loadMaterialTextures(
-        aiMaterial *mat, aiTextureType type, const std::string &typeName);
+      /**
+       * Load a collection of material texture using Assimp.
+       * This function loads diffuse, specular, and narmal material textures.
+       * A Mesh may have many of any or all of the texture types above.
+       * Models can have many Meshes attached.
+       * This function returns all textures for a single Mesh within a Model.
+       *
+       * @param mat Loaded Assimp material.
+       * @param type Type of the material.
+       * @param typeName Texture type name in string format.
+       * @return Collection of all textures for a single ModelMesh.
+       */
+      ModelMesh::Textures loadMaterialTextures(
+          aiMaterial * mat, aiTextureType type, const std::string & typeName);
 
-    /**
-     * Sorts each mesh in the Model based on distance from the camera.
-     * This is for efficient drawing in OpenGL by preventing the drawing of
-     * objects not visible due to being partially or entirely behind another
-     * object.
-     */
-    void sortModelMeshes();
+      /**
+       * Sorts each mesh in the Model based on distance from the camera.
+       * This is for efficient drawing in OpenGL by preventing the drawing of
+       * objects not visible due to being partially or entirely behind another
+       * object.
+       */
+      void sortModelMeshes();
 
-    /*************************************************************************
-     * Private Members
-     ************************************************************************/
+      /*************************************************************************
+       * Private Members
+       ************************************************************************/
 
-    /** Static QHash used to store and access models globally. */
-    static ModelManager mManager;
+      /** Static QHash used to store and access models globally. */
+      static ModelManager mManager;
 
-    /** Container to store N loaded textures for this model. */
-    ModelMesh::Textures mTexturesLoaded{};
-    /** Container to store N loaded meshes for this model. */
-    std::vector<ModelMesh> mMeshes{};
-    /** The directory this model and it's textures are stored. */
-    std::string mDirectory{};
-    /** File names for shaders and 3D model on disk. */
-    std::string mVertexShader, mFragmentShader, mModelPath;
+      /** Container to store N loaded textures for this model. */
+      ModelMesh::Textures mTexturesLoaded {};
+      /** Container to store N loaded meshes for this model. */
+      std::vector<ModelMesh> mMeshes {};
+      /** The directory this model and it's textures are stored. */
+      std::string mDirectory {};
+      /** File names for shaders and 3D model on disk. */
+      std::string mVertexShader, mFragmentShader, mModelPath;
   };
 }  // namespace Qtk