09f67f2f6b
Continues the work of the material subsystem improvements. This merge covers the continued development of the material editor. The primary improvements are the addition of new data types, a new appearance preview UI, and changes in the array data types. New data types were added to support more advanced workflows, such as the Render Workbench.The Image datatype allows the material to embed the image in the card instead of pointing to an image in an external file. Multi-buyte strings span multiple lines as the name implies. It preserves formatting accross those lines. Also several list types are now supported, with the primary difference being the editors. List is a list of strings, FileList is a list of file path names, and ImageList is a list of embedded images. For the appearance preview, the UI now uses the same Coin library as is used in the documents, meaning the preview will look exactly the same as the material will be shown in the documents. The array data types are now more complete. The default value wasn't being used as originially envisioned and was tehrefore removed. For 3D arrays, the Python API was implemented. There were a lot of code clean ups. This involved removing logging statements used for debugging during development, reduction of lint warnings, and code refactoring. The editor can automatically convert from previous format files to the current format. This has been extended to material files generated by the Render WB. Old format files are displayed in the editor with a warning icon. Selecting one will require saving the file in the new format before it can be used.
147 lines
5.3 KiB
C++
147 lines
5.3 KiB
C++
/***************************************************************************
|
|
* Copyright (c) 2023 David Carter <dcarter@david.carter.ca> *
|
|
* *
|
|
* This file is part of FreeCAD. *
|
|
* *
|
|
* FreeCAD is free software: you can redistribute it and/or modify it *
|
|
* under the terms of the GNU Lesser General Public License as *
|
|
* published by the Free Software Foundation, either version 2.1 of the *
|
|
* License, or (at your option) any later version. *
|
|
* *
|
|
* FreeCAD is distributed in the hope that it will be useful, but *
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
|
|
* Lesser General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Lesser General Public *
|
|
* License along with FreeCAD. If not, see *
|
|
* <https://www.gnu.org/licenses/>. *
|
|
* *
|
|
**************************************************************************/
|
|
|
|
#ifndef MATERIAL_MATERIALLOADER_H
|
|
#define MATERIAL_MATERIALLOADER_H
|
|
|
|
#include <memory>
|
|
|
|
#include <QDir>
|
|
#include <QString>
|
|
#include <yaml-cpp/yaml.h>
|
|
|
|
#include "Materials.h"
|
|
#include "trim.h"
|
|
|
|
namespace Materials
|
|
{
|
|
|
|
class MaterialEntry
|
|
{
|
|
public:
|
|
MaterialEntry() = default;
|
|
MaterialEntry(const std::shared_ptr<MaterialLibrary>& library,
|
|
const QString& modelName,
|
|
const QString& dir,
|
|
const QString& modelUuid);
|
|
virtual ~MaterialEntry() = default;
|
|
|
|
virtual void
|
|
addToTree(std::shared_ptr<std::map<QString, std::shared_ptr<Material>>> materialMap) = 0;
|
|
|
|
std::shared_ptr<MaterialLibrary> getLibrary() const
|
|
{
|
|
return _library;
|
|
}
|
|
QString getName() const
|
|
{
|
|
return _name;
|
|
}
|
|
QString getDirectory() const
|
|
{
|
|
return _directory;
|
|
}
|
|
QString getUUID() const
|
|
{
|
|
return _uuid;
|
|
}
|
|
|
|
protected:
|
|
std::shared_ptr<MaterialLibrary> _library;
|
|
QString _name;
|
|
QString _directory;
|
|
QString _uuid;
|
|
};
|
|
|
|
class MaterialYamlEntry: public MaterialEntry
|
|
{
|
|
public:
|
|
MaterialYamlEntry(const std::shared_ptr<MaterialLibrary>& library,
|
|
const QString& modelName,
|
|
const QString& dir,
|
|
const QString& modelUuid,
|
|
const YAML::Node& modelData);
|
|
~MaterialYamlEntry() override = default;
|
|
|
|
void
|
|
addToTree(std::shared_ptr<std::map<QString, std::shared_ptr<Material>>> materialMap) override;
|
|
|
|
const YAML::Node& getModel() const
|
|
{
|
|
return _model;
|
|
}
|
|
YAML::Node* getModelPtr()
|
|
{
|
|
return &_model;
|
|
}
|
|
|
|
private:
|
|
MaterialYamlEntry();
|
|
|
|
static QString
|
|
yamlValue(const YAML::Node& node, const std::string& key, const std::string& defaultValue);
|
|
static std::shared_ptr<QList<QVariant>> readList(const YAML::Node& node,
|
|
bool isImageList = false);
|
|
static std::shared_ptr<QList<QVariant>> readImageList(const YAML::Node& node);
|
|
static std::shared_ptr<Material2DArray> read2DArray(const YAML::Node& node, int columns);
|
|
static std::shared_ptr<Material3DArray> read3DArray(const YAML::Node& node, int columns);
|
|
|
|
YAML::Node _model;
|
|
};
|
|
|
|
class MaterialLoader
|
|
{
|
|
public:
|
|
MaterialLoader(const std::shared_ptr<std::map<QString, std::shared_ptr<Material>>>& materialMap,
|
|
const std::shared_ptr<std::list<std::shared_ptr<MaterialLibrary>>>& libraryList);
|
|
~MaterialLoader() = default;
|
|
|
|
std::shared_ptr<std::list<std::shared_ptr<MaterialLibrary>>> getMaterialLibraries();
|
|
static std::shared_ptr<std::list<QString>> getMaterialFolders(const MaterialLibrary& library);
|
|
static void showYaml(const YAML::Node& yaml);
|
|
static void
|
|
dereference(const std::shared_ptr<std::map<QString, std::shared_ptr<Material>>>& materialMap,
|
|
const std::shared_ptr<Material>& material);
|
|
static std::shared_ptr<MaterialEntry>
|
|
getMaterialFromYAML(const std::shared_ptr<MaterialLibrary>& library,
|
|
YAML::Node& yamlroot,
|
|
const QString& path);
|
|
|
|
private:
|
|
MaterialLoader();
|
|
|
|
void addToTree(std::shared_ptr<MaterialEntry> model);
|
|
void dereference(const std::shared_ptr<Material>& material);
|
|
std::shared_ptr<MaterialEntry>
|
|
getMaterialFromPath(const std::shared_ptr<MaterialLibrary>& library, const QString& path) const;
|
|
void addLibrary(const std::shared_ptr<MaterialLibrary>& model);
|
|
void loadLibrary(const std::shared_ptr<MaterialLibrary>& library);
|
|
void loadLibraries();
|
|
|
|
static std::unique_ptr<std::map<QString, std::shared_ptr<MaterialEntry>>> _materialEntryMap;
|
|
std::shared_ptr<std::map<QString, std::shared_ptr<Material>>> _materialMap;
|
|
std::shared_ptr<std::list<std::shared_ptr<MaterialLibrary>>> _libraryList;
|
|
};
|
|
|
|
} // namespace Materials
|
|
|
|
#endif // MATERIAL_MATERIALLOADER_H
|