Material: Material editor enhancements

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

View File

@@ -48,15 +48,13 @@ class MaterialTestCases(unittest.TestCase):
self.assertTrue(steel.hasPhysicalModel(self.uuids.IsotropicLinearElastic))
self.assertTrue(steel.hasPhysicalModel(self.uuids.Thermal))
self.assertFalse(steel.hasPhysicalModel(self.uuids.LinearElastic)) # Not in the model
# inherited from Steel.FCMat
self.assertTrue(steel.hasAppearanceModel(self.uuids.BasicRendering))
self.assertTrue(steel.hasAppearanceModel(self.uuids.BasicRendering)) # inherited from Steel.FCMat
self.assertTrue(steel.isPhysicalModelComplete(self.uuids.Density))
self.assertFalse(steel.isPhysicalModelComplete(self.uuids.IsotropicLinearElastic))
self.assertTrue(steel.isPhysicalModelComplete(self.uuids.Thermal))
self.assertFalse(steel.isPhysicalModelComplete(self.uuids.LinearElastic)) # Not in the model
# inherited from Steel.FCMat
self.assertTrue(steel.isAppearanceModelComplete(self.uuids.BasicRendering))
self.assertTrue(steel.isAppearanceModelComplete(self.uuids.BasicRendering)) # inherited from Steel.FCMat
self.assertTrue(steel.hasPhysicalProperty("Density"))
self.assertTrue(steel.hasPhysicalProperty("BulkModulus"))
@@ -159,19 +157,16 @@ class MaterialTestCases(unittest.TestCase):
self.assertEqual(properties["Density"], parseQuantity("7900.00 kg/m^3").UserString)
# self.assertEqual(properties["BulkModulus"], "")
self.assertAlmostEqual(parseQuantity(properties["PoissonRatio"]).Value,
parseQuantity("0.3").Value)
self.assertAlmostEqual(parseQuantity(properties["PoissonRatio"]).Value, parseQuantity("0.3").Value)
self.assertEqual(properties["YoungsModulus"], parseQuantity("210.00 GPa").UserString)
# self.assertEqual(properties["ShearModulus"], "")
self.assertEqual(properties["SpecificHeat"], parseQuantity("590.00 J/kg/K").UserString)
self.assertEqual(properties["ThermalConductivity"], parseQuantity("43.00 W/m/K").UserString)
self.assertEqual(properties["ThermalExpansionCoefficient"],
parseQuantity("12.00 µm/m/K").UserString)
self.assertEqual(properties["ThermalExpansionCoefficient"], parseQuantity("12.00 µm/m/K").UserString)
self.assertEqual(properties["AmbientColor"], "(0.0020, 0.0020, 0.0020, 1.0)")
self.assertEqual(properties["DiffuseColor"], "(0.0000, 0.0000, 0.0000, 1.0)")
self.assertEqual(properties["EmissiveColor"], "(0.0000, 0.0000, 0.0000, 1.0)")
self.assertAlmostEqual(parseQuantity(properties["Shininess"]).Value,
parseQuantity("0.06").Value)
self.assertAlmostEqual(parseQuantity(properties["Shininess"]).Value, parseQuantity("0.06").Value)
self.assertEqual(properties["SpecularColor"], "(0.9800, 0.9800, 0.9800, 1.0)")
self.assertAlmostEqual(parseQuantity(properties["Transparency"]).Value, parseQuantity("0").Value)
@@ -204,15 +199,12 @@ class MaterialTestCases(unittest.TestCase):
self.assertAlmostEqual(steel.getAppearanceValue("Transparency"), 0.0)
def testMaterialsWithModel(self):
# IsotropicLinearElastic
materials = self.MaterialManager.materialsWithModel('f6f9e48c-b116-4e82-ad7f-3659a9219c50')
materialsComplete = self.MaterialManager.materialsWithModelComplete(
'f6f9e48c-b116-4e82-ad7f-3659a9219c50')
materials = self.MaterialManager.materialsWithModel('f6f9e48c-b116-4e82-ad7f-3659a9219c50') # IsotropicLinearElastic
materialsComplete = self.MaterialManager.materialsWithModelComplete('f6f9e48c-b116-4e82-ad7f-3659a9219c50') # IsotropicLinearElastic
self.assertTrue(len(materialsComplete) <= len(materials)) # Not all will be complete
# LinearElastic
materialsLinearElastic = self.MaterialManager.materialsWithModel(
'7b561d1d-fb9b-44f6-9da9-56a4f74d7536')
materialsLinearElastic = self.MaterialManager.materialsWithModel('7b561d1d-fb9b-44f6-9da9-56a4f74d7536') # LinearElastic
# All LinearElastic models should be in IsotropicLinearElastic since it is inherited
self.assertTrue(len(materialsLinearElastic) <= len(materials))
@@ -220,22 +212,203 @@ class MaterialTestCases(unittest.TestCase):
self.assertIn(mat, materials)
def testMaterialByPath(self):
steel = self.MaterialManager.getMaterialByPath(
'Standard/Metal/Steel/CalculiX-Steel.FCMat', 'System')
steel = self.MaterialManager.getMaterialByPath('Standard/Metal/Steel/CalculiX-Steel.FCMat', 'System')
self.assertIsNotNone(steel)
self.assertEqual(steel.Name, "CalculiX-Steel")
self.assertEqual(steel.UUID, "92589471-a6cb-4bbc-b748-d425a17dea7d")
# Same with leading '/'
steel2 = self.MaterialManager.getMaterialByPath(
'/Standard/Metal/Steel/CalculiX-Steel.FCMat', 'System')
steel2 = self.MaterialManager.getMaterialByPath('/Standard/Metal/Steel/CalculiX-Steel.FCMat', 'System')
self.assertIsNotNone(steel2)
self.assertEqual(steel2.Name, "CalculiX-Steel")
self.assertEqual(steel2.UUID, "92589471-a6cb-4bbc-b748-d425a17dea7d")
# Same with leading '/System'
steel3 = self.MaterialManager.getMaterialByPath(
'/System/Standard/Metal/Steel/CalculiX-Steel.FCMat', 'System')
steel3 = self.MaterialManager.getMaterialByPath('/System/Standard/Metal/Steel/CalculiX-Steel.FCMat', 'System')
self.assertIsNotNone(steel3)
self.assertEqual(steel3.Name, "CalculiX-Steel")
self.assertEqual(steel3.UUID, "92589471-a6cb-4bbc-b748-d425a17dea7d")
def testLists(self):
mat = self.MaterialManager.getMaterial("c6c64159-19c1-40b5-859c-10561f20f979")
self.assertIsNotNone(mat)
self.assertEqual(mat.Name, "Test Material")
self.assertEqual(mat.UUID, "c6c64159-19c1-40b5-859c-10561f20f979")
self.assertTrue(mat.hasPhysicalModel(self.uuids.TestModel))
self.assertFalse(mat.isPhysicalModelComplete(self.uuids.TestModel))
self.assertTrue(mat.hasPhysicalProperty("TestList"))
list = mat.getPhysicalValue("TestList")
self.assertEqual(len(list), 6)
self.assertEqual(list[0], "Now is the time for all good men to come to the aid of the party")
self.assertEqual(list[1], "The quick brown fox jumps over the lazy dogs back")
self.assertEqual(list[2], "Lore Ipsum")
self.assertEqual(list[3], "Single quote '")
self.assertEqual(list[4], "Double quote \"")
self.assertEqual(list[5], "Backslash \\")
properties = mat.Properties
self.assertIn("TestList", properties)
self.assertTrue(len(properties["TestList"]) == 0)
def test2DArray(self):
mat = self.MaterialManager.getMaterial("c6c64159-19c1-40b5-859c-10561f20f979")
self.assertIsNotNone(mat)
self.assertEqual(mat.Name, "Test Material")
self.assertEqual(mat.UUID, "c6c64159-19c1-40b5-859c-10561f20f979")
self.assertTrue(mat.hasPhysicalModel(self.uuids.TestModel))
self.assertTrue(mat.isPhysicalModelComplete(self.uuids.TestModel))
self.assertTrue(mat.hasPhysicalProperty("TestArray2D"))
array = mat.getPhysicalValue("TestArray2D")
self.assertIsNotNone(array)
self.assertEqual(array.Rows, 3)
self.assertEqual(array.Columns, 2)
arrayData = array.Array
self.assertIsNotNone(arrayData)
self.assertEqual(len(arrayData), 3)
self.assertEqual(len(arrayData[0]), 2)
self.assertEqual(len(arrayData[1]), 2)
self.assertEqual(len(arrayData[2]), 2)
self.assertEqual(arrayData[0][0].UserString, parseQuantity("10.00 C").UserString)
self.assertEqual(arrayData[0][1].UserString, parseQuantity("10.00 kg/m^3").UserString)
self.assertEqual(arrayData[1][0].UserString, parseQuantity("20.00 C").UserString)
self.assertEqual(arrayData[1][1].UserString, parseQuantity("20.00 kg/m^3").UserString)
self.assertEqual(arrayData[2][0].UserString, parseQuantity("30.00 C").UserString)
self.assertEqual(arrayData[2][1].UserString, parseQuantity("30.00 kg/m^3").UserString)
self.assertAlmostEqual(arrayData[0][0].Value, 10.0)
self.assertAlmostEqual(arrayData[0][1].Value, 1e-8)
self.assertAlmostEqual(arrayData[1][0].Value, 20.0)
self.assertAlmostEqual(arrayData[1][1].Value, 2e-8)
self.assertAlmostEqual(arrayData[2][0].Value, 30.0)
self.assertAlmostEqual(arrayData[2][1].Value, 3e-8)
self.assertAlmostEqual(arrayData[-1][0].Value, 30.0) # Last in list
with self.assertRaises(IndexError):
self.assertAlmostEqual(arrayData[3][0].Value, 10.0)
self.assertAlmostEqual(arrayData[0][-1].Value, 1e-8)
with self.assertRaises(IndexError):
self.assertAlmostEqual(arrayData[0][2].Value, 10.0)
self.assertEqual(array.getValue(0,0).UserString, parseQuantity("10.00 C").UserString)
self.assertEqual(array.getValue(0,1).UserString, parseQuantity("10.00 kg/m^3").UserString)
self.assertEqual(array.getValue(1,0).UserString, parseQuantity("20.00 C").UserString)
self.assertEqual(array.getValue(1,1).UserString, parseQuantity("20.00 kg/m^3").UserString)
self.assertEqual(array.getValue(2,0).UserString, parseQuantity("30.00 C").UserString)
self.assertEqual(array.getValue(2,1).UserString, parseQuantity("30.00 kg/m^3").UserString)
self.assertAlmostEqual(array.getValue(0,0).Value, 10.0)
self.assertAlmostEqual(array.getValue(0,1).Value, 1e-8)
self.assertAlmostEqual(array.getValue(1,0).Value, 20.0)
self.assertAlmostEqual(array.getValue(1,1).Value, 2e-8)
self.assertAlmostEqual(array.getValue(2,0).Value, 30.0)
self.assertAlmostEqual(array.getValue(2,1).Value, 3e-8)
with self.assertRaises(IndexError):
self.assertAlmostEqual(array.getValue(-1,0).Value, 10.0)
with self.assertRaises(IndexError):
self.assertAlmostEqual(array.getValue(3,0).Value, 10.0)
with self.assertRaises(IndexError):
self.assertAlmostEqual(array.getValue(0,-1).Value, 10.0)
with self.assertRaises(IndexError):
self.assertAlmostEqual(array.getValue(0,2).Value, 10.0)
for rowIndex in range(0, array.Rows):
row = array.getRow(rowIndex)
self.assertIsNotNone(row)
self.assertEqual(len(row), 2)
with self.assertRaises(IndexError):
row = array.getRow(-1)
with self.assertRaises(IndexError):
row = array.getRow(3)
def test2DArray(self):
mat = self.MaterialManager.getMaterial("c6c64159-19c1-40b5-859c-10561f20f979")
self.assertIsNotNone(mat)
self.assertEqual(mat.Name, "Test Material")
self.assertEqual(mat.UUID, "c6c64159-19c1-40b5-859c-10561f20f979")
self.assertTrue(mat.hasPhysicalModel(self.uuids.TestModel))
self.assertFalse(mat.isPhysicalModelComplete(self.uuids.TestModel))
self.assertTrue(mat.hasPhysicalProperty("TestArray3D"))
array = mat.getPhysicalValue("TestArray3D")
self.assertIsNotNone(array)
self.assertEqual(array.Depth, 3)
self.assertEqual(array.Columns, 2)
self.assertEqual(array.getRows(), 2)
self.assertEqual(array.getRows(0), 2)
self.assertEqual(array.getRows(1), 0)
self.assertEqual(array.getRows(2), 3)
arrayData = array.Array
self.assertIsNotNone(arrayData)
self.assertEqual(len(arrayData), 3)
self.assertEqual(len(arrayData[0]), 2)
self.assertEqual(len(arrayData[1]), 0)
self.assertEqual(len(arrayData[2]), 3)
self.assertEqual(arrayData[0][0][0].UserString, parseQuantity("11.00 Pa").UserString)
self.assertEqual(arrayData[0][0][1].UserString, parseQuantity("12.00 Pa").UserString)
self.assertEqual(arrayData[0][1][0].UserString, parseQuantity("21.00 Pa").UserString)
self.assertEqual(arrayData[0][1][1].UserString, parseQuantity("22.00 Pa").UserString)
self.assertEqual(arrayData[2][0][0].UserString, parseQuantity("10.00 Pa").UserString)
self.assertEqual(arrayData[2][0][1].UserString, parseQuantity("11.00 Pa").UserString)
self.assertEqual(arrayData[2][1][0].UserString, parseQuantity("20.00 Pa").UserString)
self.assertEqual(arrayData[2][1][1].UserString, parseQuantity("21.00 Pa").UserString)
self.assertEqual(arrayData[2][2][0].UserString, parseQuantity("30.00 Pa").UserString)
self.assertEqual(arrayData[2][2][1].UserString, parseQuantity("31.00 Pa").UserString)
self.assertEqual(array.getDepthValue(0).UserString, parseQuantity("10.00 C").UserString)
self.assertEqual(array.getDepthValue(1).UserString, parseQuantity("20.00 C").UserString)
self.assertEqual(array.getDepthValue(2).UserString, parseQuantity("30.00 C").UserString)
self.assertEqual(arrayData[0][0][-1].UserString, parseQuantity("12.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(arrayData[0][0][2].UserString, parseQuantity("11.00 Pa").UserString)
self.assertEqual(arrayData[0][-1][0].UserString, parseQuantity("21.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(arrayData[0][2][0].UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(arrayData[1][0][0].UserString, parseQuantity("11.00 Pa").UserString)
self.assertEqual(arrayData[-1][0][0].UserString, parseQuantity("10.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(arrayData[3][0][0].UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getDepthValue(-1).UserString, parseQuantity("10.00 C").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getDepthValue(3).UserString, parseQuantity("10.00 C").UserString)
self.assertEqual(array.getValue(0,0,0).UserString, parseQuantity("11.00 Pa").UserString)
self.assertEqual(array.getValue(0,0,1).UserString, parseQuantity("12.00 Pa").UserString)
self.assertEqual(array.getValue(0,1,0).UserString, parseQuantity("21.00 Pa").UserString)
self.assertEqual(array.getValue(0,1,1).UserString, parseQuantity("22.00 Pa").UserString)
self.assertEqual(array.getValue(2,0,0).UserString, parseQuantity("10.00 Pa").UserString)
self.assertEqual(array.getValue(2,0,1).UserString, parseQuantity("11.00 Pa").UserString)
self.assertEqual(array.getValue(2,1,0).UserString, parseQuantity("20.00 Pa").UserString)
self.assertEqual(array.getValue(2,1,1).UserString, parseQuantity("21.00 Pa").UserString)
self.assertEqual(array.getValue(2,2,0).UserString, parseQuantity("30.00 Pa").UserString)
self.assertEqual(array.getValue(2,2,1).UserString, parseQuantity("31.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getValue(0,0,-1).UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getValue(0,0,2).UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getValue(0,-1,0).UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getValue(0,2,0).UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getValue(1,0,0).UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getValue(-1,0,0).UserString, parseQuantity("11.00 Pa").UserString)
with self.assertRaises(IndexError):
self.assertEqual(array.getValue(3,0,0).UserString, parseQuantity("11.00 Pa").UserString)

View File

@@ -56,6 +56,7 @@ class ModelTestCases(unittest.TestCase):
self.assertTrue(self.uuids.Electromagnetic, "b2eb5f48-74b3-4193-9fbb-948674f427f3")
self.assertTrue(self.uuids.Architectural, "32439c3b-262f-4b7b-99a8-f7f44e5894c8")
self.assertTrue(self.uuids.ArchitecturalRendering, "27e48ac9-54e1-4a1f-aa49-d5d690242705")
self.assertTrue(self.uuids.Costs, "881df808-8726-4c2e-be38-688bb6cce466")
@@ -64,6 +65,25 @@ class ModelTestCases(unittest.TestCase):
self.assertTrue(self.uuids.AdvancedRendering, "c880f092-cdae-43d6-a24b-55e884aacbbf")
self.assertTrue(self.uuids.VectorRendering, "fdf5a80e-de50-4157-b2e5-b6e5f88b680e")
self.assertTrue(self.uuids.RenderAppleseed, "b0a10f70-13bf-4598-ab63-bcfbbcd813e3")
self.assertTrue(self.uuids.RenderCarpaint, "4d2cc163-0707-40e2-a9f7-14288c4b97bd")
self.assertTrue(self.uuids.RenderCycles, "a6da1b66-929c-48bf-ae80-3b0495c7b50b")
self.assertTrue(self.uuids.RenderDiffuse, "c19b2d30-c55b-48aa-a938-df9e2f7779cf")
self.assertTrue(self.uuids.RenderDisney, "f8723572-4470-4c39-a749-6d3b71358a5b")
self.assertTrue(self.uuids.RenderEmission, "9f6cb588-c89d-4a74-9d0f-2786a8568cec")
self.assertTrue(self.uuids.RenderGlass, "d76a56f5-7250-4efb-bb89-8ea0a9ccaa6b")
self.assertTrue(self.uuids.RenderLuxcore, "6b992304-33e0-490b-a391-e9d0af79bb69")
self.assertTrue(self.uuids.RenderLuxrender, "67ac6a63-e173-4e05-898b-af743f1f9563")
self.assertTrue(self.uuids.RenderMixed, "84bab333-984f-47fe-a512-d17c7cb2daa9")
self.assertTrue(self.uuids.RenderOspray, "a4792c23-0be9-47c2-b16d-47b2d2d5efd6")
self.assertTrue(self.uuids.RenderPbrt, "35b34b82-4325-4d27-97bd-d10bb2c56586")
self.assertTrue(self.uuids.RenderPovray, "6ec8b415-4c7b-4206-a80b-2ea64101f34b")
self.assertTrue(self.uuids.RenderSubstancePBR, "f212b643-db96-452e-8428-376a4534e5ab")
self.assertTrue(self.uuids.RenderTexture, "fc9b6135-95cd-4ba8-ad9a-0972caeebad2")
self.assertTrue(self.uuids.RenderWB, "344008be-a837-43af-90bc-f795f277b309")
self.assertTrue(self.uuids.TestModel, "34d0583d-f999-49ba-99e6-aa40bd5c3a6b")
def testModelLoad(self):
density = self.ModelManager.getModel(self.uuids.Density)
self.assertIsNotNone(density)