kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Material: Material editor enhancements

Browse Source 
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.
This commit is contained in:
David Carter
2023-12-03 13:22:43 -05:00
committed by Chris Hennes
parent 703561f7bc
commit 3dd6a67804
72 changed files with 4248 additions and 1334 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
tests/src/Mod/Material/App/TestMaterialCards.cpp
View File

@@ -35,6 +35,7 @@
#include <Mod/Material/App/MaterialLibrary.h>
#include <Mod/Material/App/MaterialManager.h>
#include <Mod/Material/App/MaterialValue.h>
#include <Mod/Material/App/Model.h>
#include <Mod/Material/App/ModelManager.h>
#include <Mod/Material/App/ModelUuids.h>
@@ -42,34 +43,37 @@
// clang-format off
class TestMaterialCards : public ::testing::Test {
protected:
static void SetUpTestSuite() {
if (App::Application::GetARGC() == 0) {
constexpr int argc = 1;
std::array<char*, argc> argv {"FreeCAD"};
App::Application::Config()["ExeName"] = "FreeCAD";
App::Application::init(argc, argv.data());
protected:
static void SetUpTestSuite() {
if (App::Application::GetARGC() == 0) {
constexpr int argc = 1;
std::array<char*, argc> argv {"FreeCAD"};
App::Application::Config()["ExeName"] = "FreeCAD";
App::Application::init(argc, argv.data());
}
}
}
void SetUp() override {
// Create a temporary library
QString libPath = QDir::tempPath() + QString::fromStdString("/TestMaterialCards");
QDir libDir(libPath);
libDir.removeRecursively(); // Clear old run data
libDir.mkdir(libPath);
_library = std::make_shared<Materials::MaterialLibrary>(QString::fromStdString("Testing"),
libPath,
QString::fromStdString(":/icons/preferences-general.svg"),
false);
_modelManager = new Materials::ModelManager();
_materialManager = new Materials::MaterialManager();
}
void SetUp() override {
// Create a temporary library
QString libPath = QDir::tempPath() + QString::fromStdString("/TestMaterialCards");
QDir libDir(libPath);
libDir.removeRecursively(); // Clear old run data
libDir.mkdir(libPath);
_library = std::make_shared<Materials::MaterialLibrary>(QString::fromStdString("Testing"),
libPath,
QString::fromStdString(":/icons/preferences-general.svg"),
false);
_modelManager = new Materials::ModelManager();
_materialManager = new Materials::MaterialManager();
// void TearDown() override {}
Materials::ModelManager* _modelManager;
Materials::MaterialManager* _materialManager;
std::shared_ptr<Materials::MaterialLibrary> _library;
_testMaterialUUID = QString::fromStdString("c6c64159-19c1-40b5-859c-10561f20f979");
}
// void TearDown() override {}
Materials::ModelManager* _modelManager;
Materials::MaterialManager* _materialManager;
std::shared_ptr<Materials::MaterialLibrary> _library;
QString _testMaterialUUID;
};
TEST_F(TestMaterialCards, TestCopy)
@@ -78,11 +82,11 @@ TEST_F(TestMaterialCards, TestCopy)
EXPECT_TRUE(_library);
// FAIL() << "Test library " << _library->getDirectoryPath().toStdString() << "\n";
auto testMaterial = _materialManager->getMaterial(Materials::ModelUUIDs::ModelUUID_Test_Material);
auto testMaterial = _materialManager->getMaterial(_testMaterialUUID);
auto newMaterial = std::make_shared<Materials::Material>(*testMaterial);
EXPECT_EQ(testMaterial->getUUID(), Materials::ModelUUIDs::ModelUUID_Test_Material);
EXPECT_EQ(newMaterial->getUUID(), Materials::ModelUUIDs::ModelUUID_Test_Material);
EXPECT_EQ(testMaterial->getUUID(), _testMaterialUUID);
EXPECT_EQ(newMaterial->getUUID(), _testMaterialUUID);
// Save the material
_materialManager->saveMaterial(_library,
@@ -91,7 +95,7 @@ TEST_F(TestMaterialCards, TestCopy)
false, // overwrite
true, // saveAsCopy
false); // saveInherited
EXPECT_EQ(newMaterial->getUUID(), Materials::ModelUUIDs::ModelUUID_Test_Material);
EXPECT_EQ(newMaterial->getUUID(), _testMaterialUUID);
EXPECT_EQ(newMaterial->getName(), QString::fromStdString("Test Material2"));
// Save it when it already exists throwing an error
@@ -102,7 +106,7 @@ TEST_F(TestMaterialCards, TestCopy)
true, // saveAsCopy
false) // saveInherited
, Materials::MaterialExists);
EXPECT_EQ(newMaterial->getUUID(), Materials::ModelUUIDs::ModelUUID_Test_Material);
EXPECT_EQ(newMaterial->getUUID(), _testMaterialUUID);
EXPECT_EQ(newMaterial->getName(), QString::fromStdString("Test Material2"));
// Overwrite the existing file
@@ -112,7 +116,7 @@ TEST_F(TestMaterialCards, TestCopy)
true, // overwrite
true, // saveAsCopy
false);// saveInherited
EXPECT_EQ(newMaterial->getUUID(), Materials::ModelUUIDs::ModelUUID_Test_Material);
EXPECT_EQ(newMaterial->getUUID(), _testMaterialUUID);
EXPECT_EQ(newMaterial->getName(), QString::fromStdString("Test Material2"));
// Save to a new file, inheritance mode
@@ -122,7 +126,7 @@ TEST_F(TestMaterialCards, TestCopy)
false, // overwrite
true, // saveAsCopy
true);// saveInherited
EXPECT_EQ(newMaterial->getUUID(), Materials::ModelUUIDs::ModelUUID_Test_Material);
EXPECT_EQ(newMaterial->getUUID(), _testMaterialUUID);
EXPECT_EQ(newMaterial->getName(), QString::fromStdString("Test Material3"));
// Save to a new file, inheritance mode. no copy
@@ -132,7 +136,7 @@ TEST_F(TestMaterialCards, TestCopy)
false, // overwrite
false, // saveAsCopy
true);// saveInherited
EXPECT_NE(newMaterial->getUUID(), Materials::ModelUUIDs::ModelUUID_Test_Material);
EXPECT_NE(newMaterial->getUUID(), _testMaterialUUID);
EXPECT_EQ(newMaterial->getName(), QString::fromStdString("Test Material4"));
QString uuid1 = newMaterial->getUUID();
@@ -175,4 +179,27 @@ TEST_F(TestMaterialCards, TestCopy)
EXPECT_EQ(newMaterial->getName(), QString::fromStdString("Test Material6"));
}
TEST_F(TestMaterialCards, TestColumns)
{
EXPECT_NE(_modelManager, nullptr);
EXPECT_TRUE(_library);
auto testMaterial = _materialManager->getMaterial(_testMaterialUUID);
EXPECT_TRUE(testMaterial->hasPhysicalProperty(QString::fromStdString("TestArray2D")));
auto array2d = testMaterial->getPhysicalProperty(QString::fromStdString("TestArray2D"))->getMaterialValue();
EXPECT_TRUE(array2d);
EXPECT_EQ(static_cast<Materials::Material2DArray &>(*array2d).columns(), 2);
EXPECT_TRUE(testMaterial->hasPhysicalProperty(QString::fromStdString("TestArray2D3Column")));
auto array2d3Column = testMaterial->getPhysicalProperty(QString::fromStdString("TestArray2D3Column"))->getMaterialValue();
EXPECT_TRUE(array2d3Column);
EXPECT_EQ(static_cast<Materials::Material2DArray &>(*array2d3Column).columns(), 3);
EXPECT_TRUE(testMaterial->hasPhysicalProperty(QString::fromStdString("TestArray3D")));
auto array3d = testMaterial->getPhysicalProperty(QString::fromStdString("TestArray3D"))->getMaterialValue();
EXPECT_TRUE(array3d);
EXPECT_EQ(static_cast<Materials::Material3DArray &>(*array3d).columns(), 2);
}
// clang-format on

10
tests/src/Mod/Material/App/TestMaterialProperties.cpp
View File

@@ -140,13 +140,8 @@ void check2DArray(Materials::MaterialProperty& prop)
EXPECT_EQ(prop.getType(), Materials::MaterialValue::Array2D);
EXPECT_TRUE(prop.isNull());
auto array = std::static_pointer_cast<Materials::Material2DArray>(prop.getMaterialValue());
EXPECT_FALSE(array->defaultSet());
EXPECT_EQ(array->rows(), 0);
auto variant = prop.getValue(); // Throw an error?
// Getting a default value is not yet defined or implemented
// EXPECT_TRUE(variant.canConvert<Base::Quantity>());
// EXPECT_TRUE(variant.isNull());
// EXPECT_FALSE(variant.value<Base::Quantity>().isValid()); -- the variant is null
EXPECT_FALSE(variant.canConvert<QString>());
EXPECT_TRUE(variant.toString().isNull());
EXPECT_TRUE(variant.toString().isEmpty());
@@ -183,13 +178,8 @@ void check3DArray(Materials::MaterialProperty& prop)
EXPECT_EQ(prop.getType(), Materials::MaterialValue::Array3D);
EXPECT_TRUE(prop.isNull());
auto array = std::static_pointer_cast<Materials::Material3DArray>(prop.getMaterialValue());
EXPECT_FALSE(array->defaultSet());
EXPECT_EQ(array->depth(), 0);
auto variant = prop.getValue(); // Throw an error?
// Getting a default value is not yet defined or implemented
// EXPECT_TRUE(variant.canConvert<Base::Quantity>());
// EXPECT_TRUE(variant.isNull());
// EXPECT_FALSE(variant.value<Base::Quantity>().isValid()); -- the variant is null
EXPECT_FALSE(variant.canConvert<QString>());
EXPECT_TRUE(variant.toString().isNull());
EXPECT_TRUE(variant.toString().isEmpty());

26
tests/src/Mod/Material/App/TestMaterialValue.cpp
View File

@@ -190,13 +190,6 @@ TEST_F(TestMaterialValue, TestArray2DType)
auto mat2 = Materials::Material2DArray();
EXPECT_EQ(mat2.getType(), Materials::MaterialValue::Array2D);
EXPECT_TRUE(mat2.isNull());
auto variant = mat2.getDefault();
EXPECT_TRUE(variant.isNull());
EXPECT_FALSE(variant.canConvert<QString>());
EXPECT_TRUE(variant.toString().isNull());
EXPECT_TRUE(variant.toString().isEmpty());
EXPECT_EQ(variant.toString().size(), 0);
EXPECT_EQ(mat2.rows(), 0);
}
@@ -205,19 +198,14 @@ TEST_F(TestMaterialValue, TestArray3DType)
EXPECT_THROW(auto mat1 = Materials::MaterialValue(Materials::MaterialValue::Array3D), Materials::InvalidMaterialType);
auto mat2 = Materials::Material3DArray();
mat2.setColumns(2);
EXPECT_EQ(mat2.getType(), Materials::MaterialValue::Array3D);
EXPECT_TRUE(mat2.isNull());
auto variant = mat2.getDefault();
EXPECT_TRUE(variant.isNull());
EXPECT_FALSE(variant.canConvert<QString>());
EXPECT_TRUE(variant.toString().isNull());
EXPECT_TRUE(variant.toString().isEmpty());
EXPECT_EQ(variant.toString().size(), 0);
EXPECT_EQ(mat2.depth(), 0);
EXPECT_EQ(mat2.rows(), 0);
EXPECT_EQ(mat2.rows(0), 0);
EXPECT_THROW(mat2.rows(1), Materials::InvalidDepth);
EXPECT_THROW(mat2.rows(1), Materials::InvalidIndex);
Base::Quantity quantity;
quantity.setInvalid();
@@ -225,19 +213,19 @@ TEST_F(TestMaterialValue, TestArray3DType)
EXPECT_EQ(mat2.addDepth(0, quantity), 0);
EXPECT_EQ(mat2.depth(), 1);
EXPECT_EQ(mat2.rows(0), 0);
EXPECT_THROW(mat2.rows(1), Materials::InvalidDepth);
EXPECT_THROW(mat2.rows(1), Materials::InvalidIndex);
EXPECT_EQ(mat2.addDepth(quantity), 1);
EXPECT_EQ(mat2.depth(), 2);
EXPECT_EQ(mat2.rows(1), 0);
EXPECT_THROW(mat2.addDepth(99, quantity), Materials::InvalidDepth);
EXPECT_THROW(mat2.addDepth(99, quantity), Materials::InvalidIndex);
EXPECT_EQ(mat2.addDepth(2, quantity), 2);
EXPECT_EQ(mat2.depth(), 3);
EXPECT_EQ(mat2.rows(2), 0);
// Add rows
auto row = std::make_shared<std::vector<Base::Quantity>>();
auto row = std::make_shared<QList<Base::Quantity>>();
row->push_back(quantity);
row->push_back(quantity);
@@ -296,7 +284,7 @@ TEST_F(TestMaterialValue, TestArray3DType)
EXPECT_EQ(mat2.getDepthValue(2), Base::Quantity::parse(QString::fromStdString("32 C")));
// Rows are currently empty
EXPECT_THROW(mat2.getValue(2, 0), Materials::InvalidRow);
EXPECT_THROW(mat2.getValue(2, 0), Materials::InvalidIndex);
EXPECT_NO_THROW(mat2.getValue(0, 0));
EXPECT_FALSE(mat2.getValue(0, 0).isValid());
EXPECT_FALSE(mat2.getValue(0, 1).isValid());
@@ -306,7 +294,7 @@ TEST_F(TestMaterialValue, TestArray3DType)
EXPECT_TRUE(mat2.getValue(0, 0).isValid());
mat2.setValue(0, 1, Base::Quantity::parse(QString::fromStdString("9.8 m/s/s")));
EXPECT_TRUE(mat2.getValue(0, 1).isValid());
EXPECT_THROW(mat2.setValue(0, 2, Base::Quantity::parse(QString::fromStdString("32 C"))), Materials::InvalidColumn);
EXPECT_THROW(mat2.setValue(0, 2, Base::Quantity::parse(QString::fromStdString("32 C"))), Materials::InvalidIndex);
}

29
tests/src/Mod/Material/App/TestMaterials.cpp
View File

@@ -340,4 +340,33 @@ TEST_F(TestMaterial, TestCalculiXSteel)
}
TEST_F(TestMaterial, TestColumns)
{
// Start with an empty material
Materials::Material testMaterial;
auto models = testMaterial.getPhysicalModels();
EXPECT_NE(&models, nullptr);
EXPECT_EQ(models->size(), 0);
// Add a model
testMaterial.addPhysical(Materials::ModelUUIDs::ModelUUID_Test_Model);
models = testMaterial.getPhysicalModels();
EXPECT_EQ(models->size(), 1);
EXPECT_TRUE(testMaterial.hasPhysicalProperty(QString::fromStdString("TestArray2D")));
auto array2d = testMaterial.getPhysicalProperty(QString::fromStdString("TestArray2D"))->getMaterialValue();
EXPECT_TRUE(array2d);
EXPECT_EQ(static_cast<Materials::Material2DArray &>(*array2d).columns(), 2);
EXPECT_TRUE(testMaterial.hasPhysicalProperty(QString::fromStdString("TestArray2D3Column")));
auto array2d3Column = testMaterial.getPhysicalProperty(QString::fromStdString("TestArray2D3Column"))->getMaterialValue();
EXPECT_TRUE(array2d3Column);
EXPECT_EQ(static_cast<Materials::Material2DArray &>(*array2d3Column).columns(), 3);
EXPECT_TRUE(testMaterial.hasPhysicalProperty(QString::fromStdString("TestArray3D")));
auto array3d = testMaterial.getPhysicalProperty(QString::fromStdString("TestArray3D"))->getMaterialValue();
EXPECT_TRUE(array3d);
EXPECT_EQ(static_cast<Materials::Material3DArray &>(*array3d).columns(), 2);
}
// clang-format on