380 lines
15 KiB
Python
380 lines
15 KiB
Python
# ***************************************************************************
|
|
# * Copyright (c) 2019 Bernd Hahnebach <bernd@bimstatik.org> *
|
|
# * *
|
|
# * This program is free software; you can redistribute it and/or modify *
|
|
# * it under the terms of the GNU Lesser General Public License (LGPL) *
|
|
# * as published by the Free Software Foundation; either version 2 of *
|
|
# * the License, or (at your option) any later version. *
|
|
# * for detail see the LICENCE text file. *
|
|
# * *
|
|
# * This program 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 Library General Public License for more details. *
|
|
# * *
|
|
# * You should have received a copy of the GNU Library General Public *
|
|
# * License along with this program; if not, write to the Free Software *
|
|
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
# * USA *
|
|
# * *
|
|
# ***************************************************************************
|
|
|
|
__title__ = "material cards utilities"
|
|
__author__ = "Bernd Hahnebach"
|
|
__url__ = "http://www.freecadweb.org"
|
|
|
|
import os
|
|
import sys
|
|
from os.path import join
|
|
|
|
import FreeCAD
|
|
|
|
|
|
if sys.version_info.major >= 3:
|
|
unicode = str
|
|
|
|
|
|
# ***** get resources for cards ******************************************************************
|
|
def get_material_resources(category='Solid'):
|
|
|
|
resources = {} # { resource_path: icon_path, ... }
|
|
|
|
# TODO: move GUI preferences from FEM to a new side tab Material
|
|
# https://forum.freecadweb.org/viewtopic.php?f=10&t=35515
|
|
mat_prefs = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Material/Resources")
|
|
use_built_in_materials = mat_prefs.GetBool("UseBuiltInMaterials", True)
|
|
use_mat_from_config_dir = mat_prefs.GetBool("UseMaterialsFromConfigDir", True)
|
|
use_mat_from_custom_dir = mat_prefs.GetBool("UseMaterialsFromCustomDir", True)
|
|
|
|
if use_built_in_materials:
|
|
if category == 'Fluid':
|
|
builtin_mat_dir = join(
|
|
FreeCAD.getResourceDir(), "Mod", "Material", "FluidMaterial"
|
|
)
|
|
|
|
else:
|
|
builtin_mat_dir = join(
|
|
FreeCAD.getResourceDir(), "Mod", "Material", "StandardMaterial"
|
|
)
|
|
resources[builtin_mat_dir] = ":/icons/freecad.svg"
|
|
|
|
if use_mat_from_config_dir:
|
|
config_mat_dir = join(
|
|
FreeCAD.ConfigGet("UserAppData"), "Material"
|
|
)
|
|
resources[config_mat_dir] = ":/icons/preferences-general.svg"
|
|
|
|
if use_mat_from_custom_dir:
|
|
custom_mat_dir = mat_prefs.GetString("CustomMaterialsDir", "")
|
|
if os.path.exists(custom_mat_dir):
|
|
resources[custom_mat_dir] = ":/icons/user.svg"
|
|
else:
|
|
FreeCAD.Console.PrintError(
|
|
'Custom material directory set by user: {} does not exist.\n'
|
|
.format(custom_mat_dir)
|
|
)
|
|
|
|
return resources
|
|
|
|
|
|
def output_resources(resources):
|
|
FreeCAD.Console.PrintMessage('Directories we gone look for material cards:\n')
|
|
for path in resources.keys():
|
|
FreeCAD.Console.PrintMessage(' {}\n'.format(path))
|
|
|
|
|
|
# ***** card handling ****************************************************************************
|
|
# used in material editor and FEM material task panels
|
|
|
|
def import_materials(category='Solid'):
|
|
|
|
resources = get_material_resources(category)
|
|
|
|
materials = {}
|
|
cards = {}
|
|
icons = {}
|
|
for path in resources.keys():
|
|
materials, cards, icons = add_cards_from_a_dir(
|
|
materials,
|
|
cards,
|
|
icons,
|
|
path,
|
|
resources[path]
|
|
)
|
|
|
|
return (materials, cards, icons)
|
|
|
|
|
|
def add_cards_from_a_dir(materials, cards, icons, mat_dir, icon):
|
|
# fill materials and icons
|
|
import glob
|
|
from importFCMat import read
|
|
dir_path_list = glob.glob(mat_dir + '/*' + ".FCMat")
|
|
mat_prefs = FreeCAD.ParamGet("User parameter:BaseApp/Preferences/Mod/Material/Cards")
|
|
delete_duplicates = mat_prefs.GetBool("DeleteDuplicates", True)
|
|
# duplicates are indicated on equality of mat dict
|
|
# TODO if the unit is different two cards would be different too
|
|
for a_path in dir_path_list:
|
|
mat_dict = read(a_path)
|
|
card_name = os.path.splitext(os.path.basename(a_path))[0]
|
|
if delete_duplicates is False:
|
|
materials[a_path] = mat_dict
|
|
cards[a_path] = card_name
|
|
icons[a_path] = icon
|
|
else:
|
|
if mat_dict not in materials.values():
|
|
materials[a_path] = mat_dict
|
|
cards[a_path] = card_name
|
|
icons[a_path] = icon
|
|
|
|
return (materials, cards, icons)
|
|
|
|
|
|
def output_trio(trio):
|
|
materials, cards, icons = trio
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
for mat_card in materials:
|
|
FreeCAD.Console.PrintMessage(
|
|
'{} --> {} -->{}\n'
|
|
.format(cards[mat_card], mat_card, icons[mat_card])
|
|
)
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
|
|
|
|
def output_cards(cards):
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
for mat_card in cards:
|
|
FreeCAD.Console.PrintMessage('{} --> {}\n'.format(mat_card, cards[mat_card]))
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
|
|
|
|
def output_icons(icons):
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
for mat_card in icons:
|
|
FreeCAD.Console.PrintMessage('{} --> {}\n'.format(mat_card, icons[mat_card]))
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
|
|
|
|
def output_materials(materials):
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
for mat_card in materials:
|
|
FreeCAD.Console.PrintMessage('{}\n'.format(mat_card))
|
|
output_material_param(materials[mat_card])
|
|
FreeCAD.Console.PrintMessage('\n\n')
|
|
|
|
|
|
def output_material_param(mat_dict):
|
|
# thus we check for None
|
|
if not mat_dict:
|
|
FreeCAD.Console.PrintMessage(' empty matdict\n')
|
|
else:
|
|
for p in mat_dict:
|
|
FreeCAD.Console.PrintMessage(' {} --> {}\n'.format(p, mat_dict[p]))
|
|
FreeCAD.Console.PrintMessage('\n')
|
|
|
|
|
|
# ***** material card template *******************************************************************
|
|
def get_material_template(withSpaces=False):
|
|
# material properties
|
|
# see the following resources in the FreeCAD wiki for more
|
|
# information about the material specific properties:
|
|
# https://www.freecadweb.org/wiki/Material_data_model
|
|
# https://www.freecadweb.org/wiki/Material
|
|
|
|
import yaml
|
|
template_data = yaml.safe_load(
|
|
open(join(FreeCAD.ConfigGet('AppHomePath'), 'Mod/Material/Templatematerial.yml'))
|
|
)
|
|
if withSpaces:
|
|
# on attributes, add a space before a capital letter
|
|
# will be used for better display in the ui
|
|
import re
|
|
for group in template_data:
|
|
gg = list(group.keys())[0] # group dict has only one key
|
|
# iterating over a dict and changing it is not allowed
|
|
# thus it is iterated over a list of the keys
|
|
for proper in list(group[gg].keys()):
|
|
new_proper = re.sub(r"(\w)([A-Z]+)", r"\1 \2", proper)
|
|
group[gg][new_proper] = group[gg][proper]
|
|
del group[gg][proper]
|
|
return template_data
|
|
|
|
|
|
def create_mat_tools_header():
|
|
headers = join(get_source_path(), 'src/Mod/Material/StandardMaterial/Tools/headers')
|
|
print(headers)
|
|
if not os.path.isfile(headers):
|
|
FreeCAD.Console.PrintError(
|
|
'file not found: {}'.format(headers)
|
|
)
|
|
return
|
|
template_data = get_material_template()
|
|
f = open(headers, "w")
|
|
for group in template_data:
|
|
gg = list(group.keys())[0] # group dict has only one key
|
|
# do not write group UserDefined
|
|
if gg != 'UserDefined':
|
|
for prop_name in group[gg]:
|
|
if prop_name != 'None':
|
|
f.write(prop_name + '\n')
|
|
f.close
|
|
|
|
|
|
def create_mat_template_card(write_group_section=True):
|
|
template_card = join(get_source_path(), 'src/Mod/Material/StandardMaterial/TEMPLATE.FCMat')
|
|
if not os.path.isfile(template_card):
|
|
FreeCAD.Console.PrintError(
|
|
'file not found: {}'.format(template_card)
|
|
)
|
|
return
|
|
rev = "{}.{}.{}".format(
|
|
FreeCAD.ConfigGet("BuildVersionMajor"),
|
|
FreeCAD.ConfigGet("BuildVersionMinor"),
|
|
FreeCAD.ConfigGet("BuildRevision")
|
|
)
|
|
template_data = get_material_template()
|
|
f = open(template_card, "w")
|
|
f.write('; TEMPLATE\n')
|
|
f.write('; (c) 2013-2015 Juergen Riegel (CC-BY 3.0)\n')
|
|
f.write('; information about the content of such cards can be found on the wiki:\n')
|
|
f.write('; https://www.freecadweb.org/wiki/Material\n')
|
|
f.write(': this template card was created by FreeCAD ' + rev + '\n\n')
|
|
f.write('; localized Name, Description and KindOfMaterial uses 2 letter codes\n')
|
|
f.write('; defined in ISO-639-1, see https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\n')
|
|
f.write('; find unit information in src/App/FreeCADInit.py')
|
|
# write sections
|
|
# write standard FCMat section if write group section parameter is set to False
|
|
if write_group_section is False:
|
|
f.write("\n[FCMat]\n")
|
|
for group in template_data:
|
|
gg = list(group.keys())[0] # group dict has only one key
|
|
# do not write groups Meta and UserDefined
|
|
if (gg != 'Meta') and (gg != 'UserDefined'):
|
|
# only write group section if write group section parameter is set to True
|
|
if write_group_section is True:
|
|
f.write("\n\n[" + gg + "]")
|
|
for prop_name in group[gg]:
|
|
f.write('\n')
|
|
description = group[gg][prop_name]['Description']
|
|
if not description.strip():
|
|
f.write('; Description to be updated\n')
|
|
else:
|
|
f.write('; ' + description + '\n')
|
|
url = group[gg][prop_name]['URL']
|
|
if url.strip():
|
|
f.write('; ' + url + '\n')
|
|
f.write(prop_name + ' =\n')
|
|
f.close
|
|
|
|
|
|
# card tools will not be copied into build ... thus they are not there ...
|
|
# thus the source dir is needed, this might not work on windows
|
|
def get_source_path():
|
|
# in the file 'Makefile' in build directory the cmake variable CMAKE_SOURCE_DIR has the dir
|
|
source_dir = ''
|
|
make_file = join(FreeCAD.ConfigGet('AppHomePath'), 'Makefile')
|
|
f = open(make_file, 'r')
|
|
lines = f.readlines()
|
|
f.close()
|
|
for line in lines:
|
|
if line.startswith('CMAKE_SOURCE_DIR'):
|
|
source_dir = line.lstrip('CMAKE_SOURCE_DIR = ')
|
|
source_dir = source_dir.rstrip() # get rid on new line and white spaces etc.
|
|
break
|
|
# print(source_dir)
|
|
return source_dir
|
|
|
|
|
|
# ***** debug known and not known material parameter *********************************************
|
|
def get_and_output_all_carddata(cards):
|
|
print('\n\n\nSTART--get_and_output_all_carddata\n--------------------')
|
|
# get all registered material property keys
|
|
registed_cardkeys = []
|
|
template_data = get_material_template()
|
|
# print(template_data)
|
|
for group in template_data:
|
|
gg = list(group.keys())[0] # group dict has only one key
|
|
for key in group[gg]:
|
|
registed_cardkeys.append(key)
|
|
registed_cardkeys = sorted(registed_cardkeys)
|
|
# print(registed_cardkeys)
|
|
|
|
# get all data from all known cards
|
|
all_cards_and_data = {} # {cardfilename: ['path', materialdict]}
|
|
for card in cards:
|
|
from importFCMat import read
|
|
d = read(cards[card])
|
|
all_cards_and_data[card] = [cards[card], d]
|
|
'''
|
|
for card in all_cards_and_data:
|
|
print(card)
|
|
print(all_cards_and_data[card][0])
|
|
print(all_cards_and_data[card][1])
|
|
print('\n')
|
|
'''
|
|
|
|
# find not registered and registered keys in the used data
|
|
used_and_registered_cardkeys = []
|
|
used_and_not_registered_cardkeys = []
|
|
registered_and_not_used_cardkeys = []
|
|
for card in all_cards_and_data:
|
|
for k in all_cards_and_data[card][1]:
|
|
if k in registed_cardkeys:
|
|
used_and_registered_cardkeys.append(k)
|
|
else:
|
|
used_and_not_registered_cardkeys.append(k)
|
|
for k in registed_cardkeys:
|
|
if (k not in used_and_registered_cardkeys) and (k not in used_and_not_registered_cardkeys):
|
|
registered_and_not_used_cardkeys.append(k)
|
|
|
|
used_and_registered_cardkeys = sorted(list(set(used_and_registered_cardkeys)))
|
|
used_and_not_registered_cardkeys = sorted(list(set(used_and_not_registered_cardkeys)))
|
|
registered_and_not_used_cardkeys = sorted(list(set(registered_and_not_used_cardkeys)))
|
|
FreeCAD.Console.PrintMessage(
|
|
'\nused_and_registered_cardkeys:\n{}\n'
|
|
.format(used_and_registered_cardkeys)
|
|
)
|
|
FreeCAD.Console.PrintMessage(
|
|
'\nused_and_not_registered_cardkeys:\n{}\n'
|
|
.format(used_and_not_registered_cardkeys)
|
|
)
|
|
FreeCAD.Console.PrintMessage(
|
|
'\nregistered_and_not_used_cardkeys:\n{}\n'
|
|
.format(registered_and_not_used_cardkeys)
|
|
)
|
|
|
|
# still there might be lots of properties in the template
|
|
# which are not used in other materials
|
|
# but the tmplate is handled here like a material
|
|
print('--------------------\nget_and_output_all_carddata--END\n\n\n')
|
|
|
|
|
|
# ***** process multiple material cards **********************************************************
|
|
def read_cards_from_path(cards_path):
|
|
from os import listdir
|
|
from os.path import isfile, join, basename, splitext
|
|
from importFCMat import read
|
|
only_files = [f for f in listdir(cards_path) if isfile(join(cards_path, f))]
|
|
# to make sure all file lower and upper and mixed endings are found, use upper and .FCMAT
|
|
mat_files = [f for f in only_files if basename(splitext(f)[1]).upper() == '.FCMAT']
|
|
# print(mat_files)
|
|
mat_cards = []
|
|
for f in sorted(mat_files):
|
|
mat_cards.append(read(join(cards_path, f)))
|
|
return mat_cards
|
|
|
|
|
|
def write_cards_to_path(cards_path, cards_data, write_group_section=True, write_template=False):
|
|
from importFCMat import write
|
|
from os.path import join
|
|
for card_data in cards_data:
|
|
if (card_data['CardName'] == 'TEMPLATE') and (write_template is False):
|
|
continue
|
|
else:
|
|
card_path = join(cards_path, (card_data['CardName'] + '.FCMat'))
|
|
print(card_path)
|
|
if write_group_section is True:
|
|
write(card_path, card_data, True)
|
|
else:
|
|
write(card_path, card_data, False)
|