d1e96a5195
Continues the work of the material subsystem improvements. This merge covers the continued development of the material editor. The primary improvements are in the handling of 2D and 3D array properties. These properties are now fully editable, and can be saved and restored. The cards now separate the author and license. These were previously saved as a single item. Future support will be provided for standard open source licenses. Saving operations validate the cards to ensure UUIDs of materials are considered. Warnings are given when a save could potentially impact the models, such as saving over a material instead of creating a new instance. The editor is still not complete. There are a number of functional elements, such as drag/drop operations, folder creation, and deletion operations that need to be added to the main tree. State needs to be saved and restored to improve the user experience. The appearance preview also needs significant work. This will be handled in a future PR.
379 lines
13 KiB
C++
379 lines
13 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/>. *
|
|
* *
|
|
**************************************************************************/
|
|
|
|
#include "PreCompiled.h"
|
|
#ifndef _PreComp_
|
|
#include <QVector>
|
|
#endif
|
|
|
|
#include <QDirIterator>
|
|
#include <QFileInfo>
|
|
|
|
#include <App/Application.h>
|
|
|
|
#include "MaterialLibrary.h"
|
|
#include "MaterialLoader.h"
|
|
#include "MaterialManager.h"
|
|
#include "Materials.h"
|
|
#include "ModelManager.h"
|
|
|
|
|
|
using namespace Materials;
|
|
|
|
/* TRANSLATOR Material::Materials */
|
|
|
|
TYPESYSTEM_SOURCE(Materials::MaterialLibrary, LibraryBase)
|
|
|
|
MaterialLibrary::MaterialLibrary()
|
|
{}
|
|
|
|
MaterialLibrary::MaterialLibrary(const QString& libraryName,
|
|
const QString& dir,
|
|
const QString& icon,
|
|
bool readOnly)
|
|
: LibraryBase(libraryName, dir, icon)
|
|
, _readOnly(readOnly)
|
|
, _materialPathMap(std::make_unique<std::map<QString, std::shared_ptr<Material>>>())
|
|
{}
|
|
|
|
void MaterialLibrary::createFolder(const QString& path)
|
|
{
|
|
QString filePath = getLocalPath(path);
|
|
// Base::Console().Log("\tfilePath = '%s'\n", filePath.toStdString().c_str());
|
|
|
|
QDir fileDir(filePath);
|
|
if (!fileDir.exists()) {
|
|
if (!fileDir.mkpath(filePath)) {
|
|
Base::Console().Error("Unable to create directory path '%s'\n",
|
|
filePath.toStdString().c_str());
|
|
}
|
|
}
|
|
}
|
|
|
|
// This accepts the filesystem path as returned from getLocalPath
|
|
void MaterialLibrary::deleteDir(MaterialManager& manager, const QString& path)
|
|
{
|
|
// Base::Console().Log("Removing directory '%s'\n", path.toStdString().c_str());
|
|
|
|
// Remove the children first
|
|
QDirIterator it(path, QDir::Dirs | QDir::Files | QDir::NoDotAndDotDot);
|
|
|
|
// Add paths to a list so there are no iterator errors
|
|
QVector<QString> dirList;
|
|
QVector<QString> fileList;
|
|
while (it.hasNext()) {
|
|
auto pathname = it.next();
|
|
QFileInfo file(pathname);
|
|
if (file.isFile()) {
|
|
fileList.push_back(pathname);
|
|
}
|
|
else if (file.isDir()) {
|
|
dirList.push_back(pathname);
|
|
}
|
|
}
|
|
|
|
// Remove the subdirs first
|
|
while (!dirList.isEmpty()) {
|
|
QString dirPath = dirList.takeFirst();
|
|
deleteDir(manager, dirPath);
|
|
}
|
|
|
|
// Remove the files
|
|
while (!fileList.isEmpty()) {
|
|
QString filePath = fileList.takeFirst();
|
|
deleteFile(manager, filePath);
|
|
}
|
|
|
|
// Finally, remove ourself
|
|
QDir dir;
|
|
if (!dir.rmdir(path)) {
|
|
throw DeleteError(path);
|
|
}
|
|
}
|
|
|
|
// This accepts the filesystem path as returned from getLocalPath
|
|
void MaterialLibrary::deleteFile(MaterialManager& manager, const QString& path)
|
|
{
|
|
// Base::Console().Log("Removing file '%s'\n", path.toStdString().c_str());
|
|
|
|
if (QFile::remove(path)) {
|
|
// Remove from the map
|
|
QString rPath = getRelativePath(path);
|
|
// Base::Console().Log("\trpath '%s'\n", rPath.toStdString().c_str());
|
|
try {
|
|
auto material = getMaterialByPath(rPath);
|
|
manager.remove(material->getUUID());
|
|
}
|
|
catch (const MaterialNotFound&) {
|
|
Base::Console().Log("Unable to remove file from materials list\n");
|
|
}
|
|
_materialPathMap->erase(rPath);
|
|
}
|
|
else {
|
|
QString error = QString::fromStdString("DeleteError: Unable to delete ") + path;
|
|
throw DeleteError(error);
|
|
}
|
|
}
|
|
|
|
void MaterialLibrary::deleteRecursive(const QString& path)
|
|
{
|
|
std::string pstring = path.toStdString();
|
|
Base::Console().Log("\tdeleteRecursive '%s'\n", pstring.c_str());
|
|
|
|
if (isRoot(path)) {
|
|
return;
|
|
}
|
|
|
|
QString filePath = getLocalPath(path);
|
|
// Base::Console().Log("\tfilePath = '%s'\n", filePath.toStdString().c_str());
|
|
MaterialManager manager;
|
|
|
|
QFileInfo info(filePath);
|
|
if (info.isDir()) {
|
|
deleteDir(manager, filePath);
|
|
}
|
|
else {
|
|
deleteFile(manager, filePath);
|
|
}
|
|
}
|
|
|
|
void MaterialLibrary::updatePaths(const QString& oldPath, const QString& newPath)
|
|
{
|
|
// Update the path map
|
|
QString op = getRelativePath(oldPath);
|
|
QString np = getRelativePath(newPath);
|
|
std::unique_ptr<std::map<QString, std::shared_ptr<Material>>> pathMap =
|
|
std::make_unique<std::map<QString, std::shared_ptr<Material>>>();
|
|
for (auto itp = _materialPathMap->begin(); itp != _materialPathMap->end(); itp++) {
|
|
QString path = itp->first;
|
|
if (path.startsWith(op)) {
|
|
path = np + path.remove(0, op.size());
|
|
}
|
|
Base::Console().Error("Path '%s' -> '%s'\n",
|
|
itp->first.toStdString().c_str(),
|
|
path.toStdString().c_str());
|
|
itp->second->setDirectory(path);
|
|
(*pathMap)[path] = itp->second;
|
|
}
|
|
|
|
_materialPathMap = std::move(pathMap);
|
|
}
|
|
|
|
void MaterialLibrary::renameFolder(const QString& oldPath, const QString& newPath)
|
|
{
|
|
QString filePath = getLocalPath(oldPath);
|
|
// Base::Console().Log("\tfilePath = '%s'\n", filePath.toStdString().c_str());
|
|
QString newFilePath = getLocalPath(newPath);
|
|
// Base::Console().Log("\tnew filePath = '%s'\n", newFilePath.toStdString().c_str());
|
|
|
|
QDir fileDir(filePath);
|
|
if (fileDir.exists()) {
|
|
if (!fileDir.rename(filePath, newFilePath)) {
|
|
Base::Console().Error("Unable to rename directory path '%s'\n",
|
|
filePath.toStdString().c_str());
|
|
}
|
|
}
|
|
|
|
updatePaths(oldPath, newPath);
|
|
}
|
|
|
|
std::shared_ptr<Material> MaterialLibrary::saveMaterial(std::shared_ptr<Material> material,
|
|
const QString& path,
|
|
bool overwrite,
|
|
bool saveAsCopy,
|
|
bool saveInherited)
|
|
{
|
|
QString filePath = getLocalPath(path);
|
|
// Base::Console().Log("\tfilePath = '%s'\n", filePath.toStdString().c_str());
|
|
QFile file(filePath);
|
|
|
|
// Update UUID if required
|
|
// if name changed true
|
|
// if (material->getName() != file.fileName()) {
|
|
// material->newUuid();
|
|
// }
|
|
// if overwrite false having warned the user
|
|
// if old format true, but already set
|
|
|
|
|
|
QFileInfo info(file);
|
|
QDir fileDir(info.path());
|
|
if (!fileDir.exists()) {
|
|
if (!fileDir.mkpath(info.path())) {
|
|
Base::Console().Error("Unable to create directory path '%s'\n",
|
|
info.path().toStdString().c_str());
|
|
}
|
|
}
|
|
|
|
if (info.exists()) {
|
|
if (!overwrite) {
|
|
Base::Console().Error("File already exists '%s'\n", info.path().toStdString().c_str());
|
|
throw MaterialExists();
|
|
}
|
|
}
|
|
|
|
if (file.open(QIODevice::WriteOnly | QIODevice::Text)) {
|
|
QTextStream stream(&file);
|
|
stream.setCodec("UTF-8");
|
|
stream.setGenerateByteOrderMark(true);
|
|
|
|
// Write the contents
|
|
material->setLibrary(getptr());
|
|
material->setDirectory(getRelativePath(path));
|
|
material->save(stream, saveAsCopy, saveInherited);
|
|
}
|
|
|
|
return addMaterial(material, path);
|
|
}
|
|
|
|
bool MaterialLibrary::fileExists(const QString& path) const
|
|
{
|
|
QString filePath = getLocalPath(path);
|
|
QFileInfo info(filePath);
|
|
|
|
return info.exists();
|
|
}
|
|
|
|
std::shared_ptr<Material> MaterialLibrary::addMaterial(std::shared_ptr<Material> material,
|
|
const QString& path)
|
|
{
|
|
QString filePath = getRelativePath(path);
|
|
std::shared_ptr<Material> newMaterial = std::make_shared<Material>(*material);
|
|
newMaterial->setLibrary(getptr());
|
|
newMaterial->setDirectory(filePath);
|
|
|
|
(*_materialPathMap)[filePath] = newMaterial;
|
|
|
|
return newMaterial;
|
|
}
|
|
|
|
std::shared_ptr<Material> MaterialLibrary::getMaterialByPath(const QString& path) const
|
|
{
|
|
// Base::Console().Log("MaterialLibrary::getMaterialByPath(%s)\n", path.toStdString().c_str());
|
|
// for (auto itp = _materialPathMap->begin(); itp != _materialPathMap->end(); itp++) {
|
|
// Base::Console().Log("\tpath = '%s'\n", itp->first.toStdString().c_str());
|
|
// }
|
|
|
|
QString filePath = getRelativePath(path);
|
|
try {
|
|
auto material = _materialPathMap->at(filePath);
|
|
return material;
|
|
}
|
|
catch (std::out_of_range& e) {
|
|
throw MaterialNotFound();
|
|
}
|
|
}
|
|
|
|
const QString MaterialLibrary::getUUIDFromPath(const QString& path) const
|
|
{
|
|
QString filePath = getRelativePath(path);
|
|
try {
|
|
auto material = _materialPathMap->at(filePath);
|
|
return material->getUUID();
|
|
}
|
|
catch (std::out_of_range& e) {
|
|
throw MaterialNotFound();
|
|
}
|
|
}
|
|
|
|
std::shared_ptr<std::map<QString, std::shared_ptr<MaterialTreeNode>>>
|
|
MaterialLibrary::getMaterialTree() const
|
|
{
|
|
std::shared_ptr<std::map<QString, std::shared_ptr<MaterialTreeNode>>> materialTree =
|
|
std::make_shared<std::map<QString, std::shared_ptr<MaterialTreeNode>>>();
|
|
|
|
for (auto it = _materialPathMap->begin(); it != _materialPathMap->end(); it++) {
|
|
auto filename = it->first;
|
|
auto material = it->second;
|
|
|
|
// Base::Console().Log("Relative path '%s'\n\t", filename.toStdString().c_str());
|
|
QStringList list = filename.split(QString::fromStdString("/"));
|
|
|
|
// Start at the root
|
|
std::shared_ptr<std::map<QString, std::shared_ptr<MaterialTreeNode>>> node = materialTree;
|
|
for (auto itp = list.begin(); itp != list.end(); itp++) {
|
|
// Base::Console().Log("\t%s", itp->toStdString().c_str());
|
|
if (itp->endsWith(QString::fromStdString(".FCMat"))) {
|
|
std::shared_ptr<MaterialTreeNode> child = std::make_shared<MaterialTreeNode>();
|
|
child->setData(material);
|
|
(*node)[*itp] = child;
|
|
}
|
|
else {
|
|
// Add the folder only if it's not already there
|
|
if (node->count(*itp) == 0) {
|
|
auto mapPtr =
|
|
std::make_shared<std::map<QString, std::shared_ptr<MaterialTreeNode>>>();
|
|
std::shared_ptr<MaterialTreeNode> child = std::make_shared<MaterialTreeNode>();
|
|
child->setFolder(mapPtr);
|
|
(*node)[*itp] = child;
|
|
node = mapPtr;
|
|
}
|
|
else {
|
|
node = (*node)[*itp]->getFolder();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Empty folders aren't included in _materialPathMap, so we add them by looking at the file
|
|
// system
|
|
auto folderList = MaterialLoader::getMaterialFolders(*this);
|
|
for (auto folder : *folderList) {
|
|
QStringList list = folder.split(QString::fromStdString("/"));
|
|
|
|
// Start at the root
|
|
auto node = materialTree;
|
|
for (auto itp = list.begin(); itp != list.end(); itp++) {
|
|
// Add the folder only if it's not already there
|
|
if (node->count(*itp) == 0) {
|
|
std::shared_ptr<std::map<QString, std::shared_ptr<MaterialTreeNode>>> mapPtr =
|
|
std::make_shared<std::map<QString, std::shared_ptr<MaterialTreeNode>>>();
|
|
std::shared_ptr<MaterialTreeNode> child = std::make_shared<MaterialTreeNode>();
|
|
child->setFolder(mapPtr);
|
|
(*node)[*itp] = child;
|
|
node = mapPtr;
|
|
}
|
|
else {
|
|
node = (*node)[*itp]->getFolder();
|
|
}
|
|
}
|
|
}
|
|
|
|
return materialTree;
|
|
}
|
|
|
|
TYPESYSTEM_SOURCE(Materials::MaterialExternalLibrary, MaterialLibrary::MaterialLibrary)
|
|
|
|
MaterialExternalLibrary::MaterialExternalLibrary()
|
|
{}
|
|
|
|
MaterialExternalLibrary::MaterialExternalLibrary(const QString& libraryName,
|
|
const QString& dir,
|
|
const QString& icon,
|
|
bool readOnly)
|
|
: MaterialLibrary(libraryName, dir, icon, readOnly)
|
|
{}
|
|
|
|
MaterialExternalLibrary::~MaterialExternalLibrary()
|
|
{
|
|
// delete directory;
|
|
}
|