i_o.py 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959
  1. # this is the I/O part of mantis. I eventually intend to make this a markup language. not right now tho lol
  2. from .utilities import (prRed, prGreen, prPurple, prWhite,
  3. prOrange,
  4. wrapRed, wrapGreen, wrapPurple, wrapWhite,
  5. wrapOrange,)
  6. from mathutils import Vector
  7. NODES_REMOVED=["xFormRootNode"]
  8. # Node bl_idname, # Socket Name
  9. SOCKETS_REMOVED=[("UtilityDriverVariable", "Transform Channel"),
  10. ("xFormRootNode","World Out"),
  11. ("UtilitySwitch","xForm"),
  12. ("LinkDrivenParameter", "Enable")]
  13. # Node Class #Prior bl_idname # prior name # new bl_idname # new name, # Multi
  14. # ignore these because they are either unrelated python stuff or useless or borked
  15. prop_ignore = [ "__dict__", "__doc__", "__module__", "__weakref__",# "name",
  16. "bl_height_default", "bl_height_max", "bl_height_min",
  17. "bl_icon", "bl_rna", "bl_static_type", "bl_description",
  18. "bl_width_default", "bl_width_max", "bl_width_min",
  19. "__annotations__", "original", "rna_type", "view_center",
  20. "links", "nodes", "internal_links", "inputs", "outputs",
  21. "__slots__", "dimensions", "type", "interface",
  22. "library_weak_reference", "parsed_tree", "node_tree_updater",
  23. "asset_data", "preview", # blender asset stuff
  24. "object_reference", # this one is here to hold on to widgets when appending
  25. "color_tag" , # added in blender 4.4, not used by Mantis, readonly.
  26. # more blender properties...
  27. "bl_use_group_interface", "default_group_node_width", "id_type",
  28. # blender runtime stuff
  29. "animation_data", "description", "grease_pencil", "is_editable",
  30. "is_embedded_data", "is_evaluated", "is_library_indirect", "is_missing",
  31. "is_runtime_data", "library", "name_full", "override_library",
  32. "session_uid", "tag", "use_extra_user", "use_fake_user", "users",
  33. # some Mantis stuff I don't need to save
  34. "do_live_update", "is_executing", "is_exporting", "hash", "filepath",
  35. "prevent_next_exec", "execution_id", "num_links", "tree_valid",
  36. "interface_helper",
  37. # node stuff
  38. "mantis_node_class_name", "color", "height", "initialized", "select",
  39. "show_options", "show_preview", "show_texture", "use_custom_color",
  40. "warning_propagation",
  41. # these are in Bone
  42. "socket_count", "display_bb_settings", "display_def_settings",
  43. "display_ik_settings", "display_vp_settings",
  44. ]
  45. # don't ignore: "bl_idname", "bl_label",
  46. # ignore the name, it's the dict - key for the node props
  47. # no that's stupid don't ignore the name good grief
  48. # I am doing this because these are interactions with other addons that cause problems and probably don't exist for any given user
  49. prop_ignore.extend(['keymesh'])
  50. # trees
  51. prop_ignore_tree = prop_ignore.copy()
  52. prop_ignore_tree.extend(["bl_label", "name"])
  53. from bpy.app import version
  54. if version >= (4,5,0):
  55. SOCKETS_REMOVED.append( ("LinkSplineIK", "Use Original Scale"))
  56. add_inputs_bl_idnames = [
  57. "UtilityDriver", "UtilityFCurve", "DeformerMorphTargetDeform",
  58. "LinkArmature",
  59. ]
  60. # this works but it is really ugly and probably quite inneficient
  61. # TODO: make hotkeys for export and import and reload from file
  62. # we need to give the tree a filepath attribute and update it on saving
  63. # then we need to use the filepath attribute to load from
  64. # finally we need to use a few operators to choose whether to open a menu or not
  65. # and we need a message to display on save/load so that the user knows it is happening
  66. # TODO:
  67. # Additionally export MetaRig and Curve and other referenced data
  68. # Meshes can be exported as .obj and imported via GN
  69. def TellClasses():
  70. return [ MantisExportNodeTreeSaveAs, MantisExportNodeTreeSave, MantisExportNodeTree, MantisImportNodeTree, MantisReloadNodeTree]
  71. # https://stackoverflow.com/questions/42033142/is-there-an-easy-way-to-check-if-an-object-is-json-serializable-in-python - thanks!
  72. def is_jsonable(x):
  73. import json
  74. try:
  75. json.dumps(x)
  76. return True
  77. except (TypeError, OverflowError):
  78. return False
  79. # https://stackoverflow.com/questions/295135/turn-a-stritree-into-a-valid-filename - thank you user "Sophie Gage"
  80. def remove_special_characters(name):
  81. import re; return re.sub('[^\w_.)( -]', '', name)# re = regular expressions
  82. def fix_custom_parameter(n, property_definition, ):
  83. if n.bl_idname in ['xFormNullNode', 'xFormBoneNode', 'xFormArmatureNode', 'xFormGeometryObjectNode',]:
  84. prop_name = property_definition["name"]
  85. prop_type = property_definition["bl_idname"]
  86. if prop_type in ['ParameterBoolSocket', 'ParameterIntSocket', 'ParameterFloatSocket', 'ParameterVectorSocket' ]:
  87. # is it good to make both of them?
  88. input = n.inputs.new( prop_type, prop_name)
  89. output = n.outputs.new( prop_type, prop_name)
  90. if property_definition["is_output"] == True:
  91. return output
  92. return input
  93. elif n.bl_idname in ['LinkArmature']:
  94. prop_name = property_definition["name"]
  95. prop_type = property_definition["bl_idname"]
  96. input = n.inputs.new( prop_type, prop_name)
  97. return input
  98. return None
  99. def get_socket_data(socket, ignore_if_default=False):
  100. # TODO: don't get stuff in the socket templates
  101. # PROBLEM: I don't have easy access to this from the ui class (or mantis class)
  102. socket_data = {}
  103. socket_data["name"] = socket.name
  104. socket_data["bl_idname"] = socket.bl_idname
  105. socket_data["is_output"] = socket.is_output
  106. socket_data["is_multi_input"] = socket.is_multi_input
  107. # here is where we'll handle a socket_data'socket special data
  108. if socket.bl_idname == "EnumMetaBoneSocket":
  109. socket_data["bone"] = socket.bone
  110. if socket.bl_idname in ["EnumMetaBoneSocket", "EnumMetaRigSocket", "EnumCurveSocket"]:
  111. if sp := socket.get("search_prop"): # may be None
  112. socket_data["search_prop"] = sp.name # this is an object.
  113. #
  114. if hasattr(socket, "default_value"):
  115. value = socket.default_value
  116. else:
  117. value = None
  118. return socket_data # we don't need to store any more.
  119. if not is_jsonable(value): # FIRST try and make a tuple out of it because JSON doesn't like mutables
  120. value = tuple(value)
  121. if not is_jsonable(value): # now see if it worked and crash out if it didn't
  122. raise RuntimeError(f"Error serializing data in {socket.node.name}::{socket.name} for value of type {type(value)}")
  123. socket_data["default_value"] = value
  124. # TODO TODO implement "ignore if default" feature here
  125. # at this point we can get the custom parameter ui hints if we want
  126. if not socket.is_output:
  127. # try and get this data
  128. if value := getattr(socket,'min', None):
  129. socket_data["min"] = value
  130. if value := getattr(socket,'max', None):
  131. socket_data["max"] = value
  132. if value := getattr(socket,'soft_min', None):
  133. socket_data["soft_min"] = value
  134. if value := getattr(socket,'soft_max', None):
  135. socket_data["soft_max"] = value
  136. if value := getattr(socket,'description', None):
  137. socket_data["description"] = value
  138. return socket_data
  139. #
  140. def get_node_data(ui_node):
  141. # if this is a node-group, force it to update its interface, because it may be messed up.
  142. # can remove this HACK when I have stronger guarentees about node-group's keeping the interface
  143. from .base_definitions import node_group_update
  144. if hasattr(ui_node, "node_tree"):
  145. ui_node.is_updating = True
  146. try: # HERE BE DANGER
  147. node_group_update(ui_node, force=True)
  148. finally: # ensure this line is run even if there is an error
  149. ui_node.is_updating = False
  150. node_props, sockets = {}, {}
  151. for propname in dir(ui_node):
  152. value = getattr(ui_node, propname)
  153. if propname in ['fake_fcurve_ob']:
  154. value=value.name
  155. if (propname in prop_ignore) or ( callable(value) ):
  156. continue
  157. if value.__class__.__name__ in ["Vector", "Color"]:
  158. value = tuple(value)
  159. if isinstance(value, bpy.types.NodeTree):
  160. value = value.name
  161. if isinstance(value, bpy.types.bpy_prop_array):
  162. value = tuple(value)
  163. if propname == "parent" and value:
  164. value = value.name
  165. if not is_jsonable(value):
  166. raise RuntimeError(f"Could not export... {ui_node.name}, {propname}, {type(value)}")
  167. if value is None:
  168. continue
  169. node_props[propname] = value
  170. # so we have to accumulate the parent location because the location is not absolute
  171. if propname == "location" and ui_node.parent is not None:
  172. location_acc = Vector((0,0))
  173. parent = ui_node.parent
  174. while (parent):
  175. location_acc += parent.location
  176. parent = parent.parent
  177. location_acc += getattr(ui_node, propname)
  178. node_props[propname] = tuple(location_acc)
  179. # this works!
  180. for i, ui_socket in enumerate(ui_node.inputs):
  181. if ui_socket.is_linked: continue # not necessary to save it since it doesn't affect the tree
  182. socket = get_socket_data(ui_socket)
  183. socket["index"]=i
  184. sockets[ui_socket.identifier] = socket
  185. for i, ui_socket in enumerate(ui_node.outputs):
  186. if ui_socket.is_linked: continue # see above
  187. socket = get_socket_data(ui_socket)
  188. socket["index"]=i
  189. sockets[ui_socket.identifier] = socket
  190. node_props["sockets"] = sockets
  191. return node_props
  192. def get_tree_data(tree):
  193. tree_info = {}
  194. for propname in dir(tree):
  195. # if getattr(tree, propname):
  196. # pass
  197. if (propname in prop_ignore_tree) or ( callable(getattr(tree, propname)) ):
  198. continue
  199. v = getattr(tree, propname)
  200. if isinstance(getattr(tree, propname), bpy.types.bpy_prop_array):
  201. v = tuple(getattr(tree, propname))
  202. if not is_jsonable( v ):
  203. raise RuntimeError(f"Not JSON-able: {propname}, type: {type(v)}")
  204. tree_info[propname] = v
  205. tree_info["name"]=tree.name
  206. return tree_info
  207. def get_interface_data(tree, tree_in_out):
  208. for sock in tree.interface.items_tree:
  209. sock_data={}
  210. if sock.item_type == 'PANEL':
  211. sock_data["name"] = sock.name
  212. sock_data["item_type"] = sock.item_type
  213. sock_data["description"] = sock.description
  214. sock_data["default_closed"] = sock.default_closed
  215. tree_in_out[sock.name] = sock_data
  216. # if it is a socket....
  217. else:
  218. # we need to get the socket class from the bl_idname
  219. bl_socket_idname = sock.bl_socket_idname
  220. # try and import it
  221. from . import socket_definitions
  222. # WANT an attribute error if this fails.
  223. socket_class = getattr(socket_definitions, bl_socket_idname)
  224. sock_parent = None
  225. if sock.parent:
  226. sock_parent = sock.parent.name
  227. for propname in dir(sock):
  228. v = getattr(sock, propname)
  229. if (propname in prop_ignore) or ( callable(v) ):
  230. continue
  231. if (propname == "parent"):
  232. sock_data[propname] = sock_parent
  233. continue
  234. if isinstance(getattr(sock, propname), bpy.types.bpy_prop_array):
  235. v = tuple(getattr(sock, propname))
  236. if not is_jsonable( v ):
  237. raise RuntimeError(f"{propname}, {type(v)}")
  238. sock_data[propname] = v
  239. # this is a property. pain.
  240. sock_data["socket_type"] = socket_class.interface_type.fget(socket_class)
  241. tree_in_out[sock.identifier] = sock_data
  242. def export_to_json(trees, path="", write_file=True, only_selected=False):
  243. export_data = {}
  244. for tree in trees:
  245. current_tree_is_base_tree = False
  246. if tree is trees[-1]:
  247. current_tree_is_base_tree = True
  248. tree_info, tree_in_out = {}, {}
  249. tree_info = get_tree_data(tree)
  250. # if only_selected:
  251. # # all in/out links, relative to the selection, should be marked and used to initialize tree properties
  252. if not only_selected: # we'll handle this later with the links
  253. for sock in tree.interface.items_tree:
  254. get_interface_data(tree, tree_in_out) # it concerns me that this one modifies
  255. # the collection instead of getting the data and returning it. TODO refactor this
  256. nodes = {}
  257. for node in tree.nodes:
  258. if only_selected and node.select == False:
  259. continue
  260. nodes[node.name] = get_node_data(node)
  261. links = []
  262. in_sockets, out_sockets = {}, {}
  263. unique_sockets_from, unique_sockets_to = {}, {}
  264. in_node = {"name":"MANTIS_AUTOGEN_GROUP_INPUT", "bl_idname":"NodeGroupInput", "sockets":in_sockets}
  265. out_node = {"name":"MANTIS_AUTOGEN_GROUP_OUTPUT", "bl_idname":"NodeGroupOutput", "sockets":out_sockets}
  266. add_input_node, add_output_node = False, False
  267. for link in tree.links:
  268. from_node_name, from_socket_id = link.from_node.name, link.from_socket.identifier
  269. to_node_name, to_socket_id = link.to_node.name, link.to_socket.identifier
  270. from_socket_name, to_socket_name = link.from_socket.name, link.to_socket.name
  271. # get the indices of the sockets to be absolutely sure
  272. for from_outoput_index, outp in enumerate(link.from_node.outputs):
  273. # for some reason, 'is' does not return True no matter what...
  274. # so we are gonn compare the memory address directly, this is stupid
  275. if (outp.as_pointer() == link.from_socket.as_pointer()): break
  276. else:
  277. problem=link.from_node.name + "::" + link.from_socket.name
  278. raise RuntimeError(wrapRed(f"Error saving index of socket: {problem}"))
  279. for to_input_index, inp in enumerate(link.to_node.inputs):
  280. if (inp.as_pointer() == link.to_socket.as_pointer()): break
  281. else:
  282. problem = link.to_node.name + "::" + link.to_socket.name
  283. raise RuntimeError(wrapRed(f"Error saving index of socket: {problem}"))
  284. if current_tree_is_base_tree:
  285. if (only_selected and link.from_node.select) and (not link.to_node.select):
  286. # handle an output in the tree
  287. add_output_node=True
  288. if not (sock_name := unique_sockets_to.get(link.from_socket.node.name+link.from_socket.identifier)):
  289. sock_name = link.to_socket.name; name_stub = sock_name
  290. used_names = list(tree_in_out.keys()); i=0
  291. while sock_name in used_names:
  292. sock_name=name_stub+'.'+str(i).zfill(3); i+=1
  293. unique_sockets_to[link.from_socket.node.name+link.from_socket.identifier]=sock_name
  294. out_sock = out_sockets.get(sock_name)
  295. if not out_sock:
  296. out_sock = {}; out_sockets[sock_name] = out_sock
  297. out_sock["index"]=len(out_sockets) # zero indexed, so zero length makes zero the first index and so on, this works
  298. # what in the bad word is happening here?
  299. # why?
  300. # why no de-duplication?
  301. # what was I thinking?
  302. # TODO REFACTOR THIS SOON
  303. out_sock["name"] = sock_name
  304. out_sock["identifier"] = sock_name
  305. out_sock["bl_idname"] = link.to_socket.bl_idname
  306. out_sock["is_output"] = False
  307. out_sock["source"]=[link.to_socket.node.name,link.to_socket.identifier]
  308. out_sock["is_multi_input"] = False # this is not something I can even set on tree interface items, and this code is not intended for making Schema
  309. sock_data={}
  310. sock_data["name"] = sock_name
  311. sock_data["item_type"] = "SOCKET"
  312. sock_data["default_closed"] = False
  313. # record the actual bl_idname and the proper interface type.
  314. sock_data["socket_type"] = link.from_socket.interface_type
  315. sock_data["bl_socket_idname"] = link.from_socket.bl_idname
  316. sock_data["identifier"] = sock_name
  317. sock_data["in_out"]="OUTPUT"
  318. sock_data["index"]=out_sock["index"]
  319. tree_in_out[sock_name] = sock_data
  320. to_node_name=out_node["name"]
  321. to_socket_id=out_sock["identifier"]
  322. to_input_index=out_sock["index"]
  323. to_socket_name=out_sock["name"]
  324. elif (only_selected and (not link.from_node.select)) and link.to_node.select:
  325. add_input_node=True
  326. # we need to get a unique name for this
  327. # use the Tree IN/Out because we are dealing with Group in/out
  328. if not (sock_name := unique_sockets_from.get(link.from_socket.node.name+link.from_socket.identifier)):
  329. sock_name = link.from_socket.name; name_stub = sock_name
  330. used_names = list(tree_in_out.keys()); i=0
  331. while sock_name in used_names:
  332. sock_name=name_stub+'.'+str(i).zfill(3); i+=1
  333. unique_sockets_from[link.from_socket.node.name+link.from_socket.identifier]=sock_name
  334. in_sock = in_sockets.get(sock_name)
  335. if not in_sock:
  336. in_sock = {}; in_sockets[sock_name] = in_sock
  337. in_sock["index"]=len(in_sockets) # zero indexed, so zero length makes zero the first index and so on, this works
  338. #
  339. in_sock["name"] = sock_name
  340. in_sock["identifier"] = sock_name
  341. in_sock["bl_idname"] = link.from_socket.bl_idname
  342. in_sock["is_output"] = True
  343. in_sock["is_multi_input"] = False # this is not something I can even set on tree interface items, and this code is not intended for making Schema
  344. in_sock["source"] = [link.from_socket.node.name,link.from_socket.identifier]
  345. sock_data={}
  346. sock_data["name"] = sock_name
  347. sock_data["item_type"] = "SOCKET"
  348. sock_data["default_closed"] = False
  349. # record the actual bl_idname and the proper interface type.
  350. sock_data["socket_type"] = link.from_socket.interface_type
  351. sock_data["bl_socket_idname"] = link.from_socket.bl_idname
  352. sock_data["identifier"] = sock_name
  353. sock_data["in_out"]="INPUT"
  354. sock_data["index"]=in_sock["index"]
  355. tree_in_out[sock_name] = sock_data
  356. from_node_name=in_node.get("name")
  357. from_socket_id=in_sock["identifier"]
  358. from_outoput_index=in_sock["index"]
  359. from_socket_name=in_node.get("name")
  360. # parentheses matter here...
  361. elif (only_selected and not (link.from_node.select and link.to_node.select)):
  362. continue
  363. elif only_selected and not (link.from_node.select and link.to_node.select):
  364. continue # pass if both links are not selected
  365. links.append( (from_node_name,
  366. from_socket_id,
  367. to_node_name,
  368. to_socket_id,
  369. from_outoput_index,
  370. to_input_index,
  371. from_socket_name,
  372. to_socket_name) ) # it's a tuple
  373. if add_input_node or add_output_node:
  374. all_nodes_bounding_box=[Vector((float("inf"),float("inf"))), Vector((-float("inf"),-float("inf")))]
  375. for n in nodes.values():
  376. if n["location"][0] < all_nodes_bounding_box[0].x:
  377. all_nodes_bounding_box[0].x = n["location"][0]
  378. if n["location"][1] < all_nodes_bounding_box[0].y:
  379. all_nodes_bounding_box[0].y = n["location"][1]
  380. #
  381. if n["location"][0] > all_nodes_bounding_box[1].x:
  382. all_nodes_bounding_box[1].x = n["location"][0]
  383. if n["location"][1] > all_nodes_bounding_box[1].y:
  384. all_nodes_bounding_box[1].y = n["location"][1]
  385. if add_input_node:
  386. in_node["location"] = Vector((all_nodes_bounding_box[0].x-400, all_nodes_bounding_box[0].lerp(all_nodes_bounding_box[1], 0.5).y))
  387. nodes["MANTIS_AUTOGEN_GROUP_INPUT"]=in_node
  388. if add_output_node:
  389. out_node["location"] = Vector((all_nodes_bounding_box[1].x+400, all_nodes_bounding_box[0].lerp(all_nodes_bounding_box[1], 0.5).y))
  390. nodes["MANTIS_AUTOGEN_GROUP_OUTPUT"]=out_node
  391. export_data[tree.name] = (tree_info, tree_in_out, nodes, links,) # f_curves)
  392. import json
  393. if not write_file:
  394. return export_data # gross to have a different type of return value... but I don't care
  395. with open(path, "w") as file:
  396. print(wrapWhite("Writing mantis tree data to: "), wrapGreen(file.name))
  397. file.write( json.dumps(export_data, indent = 4) )
  398. # I'm gonna do this in a totally naive way, because this should already be sorted properly
  399. # for the sake of dependency satisfaction. So the current "tree" should be the "main" tree
  400. tree.filepath = path
  401. def do_import_from_file(filepath, context):
  402. import json
  403. all_trees = [n_tree for n_tree in bpy.data.node_groups if n_tree.bl_idname in ["MantisTree", "SchemaTree"]]
  404. for tree in all_trees:
  405. tree.is_exporting = True
  406. tree.do_live_update = False
  407. def do_cleanup(tree):
  408. tree.is_exporting = False
  409. tree.do_live_update = True
  410. tree.prevent_next_exec = True
  411. with open(filepath, 'r', encoding='utf-8') as f:
  412. data = json.load(f)
  413. do_import(data,context)
  414. for tree in all_trees:
  415. do_cleanup(tree)
  416. tree = bpy.data.node_groups[list(data.keys())[-1]]
  417. try:
  418. context.space_data.node_tree = tree
  419. except AttributeError: # not hovering over the Node Editor
  420. pass
  421. return {'FINISHED'}
  422. # otherwise:
  423. # repeat this because we left the with, this is bad and ugly but I don't care
  424. for tree in all_trees:
  425. do_cleanup(tree)
  426. return {'CANCELLED'}
  427. def do_import(data, context):
  428. trees = []
  429. tree_sock_id_maps = {}
  430. # First: init the interface of the node graph
  431. for tree_name, tree_data in data.items():
  432. tree_info = tree_data[0]
  433. tree_in_out = tree_data[1]
  434. # need to make a new tree; first, try to get it:
  435. tree = bpy.data.node_groups.get(tree_info["name"])
  436. if tree is None:
  437. tree = bpy.data.node_groups.new(tree_info["name"], tree_info["bl_idname"])
  438. tree.nodes.clear(); tree.links.clear(); tree.interface.clear()
  439. # this may be a bad bad thing to do without some kind of warning TODO TODO
  440. tree.is_executing = True
  441. tree.do_live_update = False
  442. trees.append(tree)
  443. tree_sock_id_map = {}
  444. tree_sock_id_maps[tree.name] = tree_sock_id_map
  445. interface_parent_me = {}
  446. # I need to guarantee that the interface items are in the right order.
  447. interface_sockets = [] # I'll just sort them afterwards so I hold them here.
  448. default_position=0 # We'll use this if the position attribute is not set when e.g. making groups.
  449. for s_name, s_props in tree_in_out.items():
  450. if s_props["item_type"] == 'SOCKET':
  451. if s_props["socket_type"] == "LayerMaskSocket":
  452. continue
  453. if (socket_type := s_props["socket_type"]) == "NodeSocketColor":
  454. socket_type = "VectorSocket"
  455. if bpy.app.version != (4,5,0):
  456. sock = tree.interface.new_socket(s_props["name"], in_out=s_props["in_out"], socket_type=socket_type)
  457. else: # blender 4.5.0 LTS, have to workaround a bug!
  458. from .versioning import workaround_4_5_0_interface_update
  459. sock = workaround_4_5_0_interface_update(tree=tree, name=s_props["name"], in_out=s_props["in_out"],
  460. sock_type=socket_type, parent_name=s_props.get("parent", ''))
  461. tree_sock_id_map[s_name] = sock.identifier
  462. if not (socket_position := s_props.get('position')):
  463. socket_position=default_position; default_position+=1
  464. interface_sockets.append( (sock, socket_position) )
  465. # TODO: set whatever properties are needed (default, etc)
  466. if panel := s_props.get("parent"): # this get is just to maintain compatibility with an older form of this script... and it is harmless
  467. interface_parent_me[sock] = (panel, s_props["position"])
  468. else: # it's a panel
  469. panel = tree.interface.new_panel(s_props["name"], description=s_props.get("description"), default_closed=s_props.get("default_closed"))
  470. for socket, (panel, index) in interface_parent_me.items():
  471. tree.interface.move_to_parent(
  472. socket,
  473. tree.interface.items_tree.get(panel),
  474. index,
  475. )
  476. # BUG this was screwing up the order of things
  477. # so I wan tot fix it and re-enable it
  478. if False:
  479. # Go BACK through and set the index/position now that all items exist.
  480. interface_sockets.sort(key=lambda a : a[1])
  481. for (socket, position) in interface_sockets:
  482. tree.interface.move(socket, position)
  483. # Now go and do nodes and links
  484. for tree_name, tree_data in data.items():
  485. print ("Importing sub-graph: %s with %s nodes" % (wrapGreen(tree_name), wrapPurple(len(tree_data[2]))) )
  486. tree_info = tree_data[0]
  487. nodes = tree_data[2]
  488. links = tree_data[3]
  489. parent_me = []
  490. tree = bpy.data.node_groups.get(tree_info["name"])
  491. tree.is_executing = True
  492. tree.do_live_update = False
  493. trees.append(tree)
  494. tree_sock_id_map=tree_sock_id_maps[tree.name]
  495. interface_parent_me = {}
  496. # from mantis.utilities import prRed, prWhite, prOrange, prGreen
  497. for name, propslist in nodes.items():
  498. bl_idname = propslist["bl_idname"]
  499. if bl_idname in NODES_REMOVED:
  500. prWhite(f"INFO: Ignoring import of node {name} of type {bl_idname}; it has been removed.")
  501. continue
  502. n = tree.nodes.new(bl_idname)
  503. if bl_idname in ["DeformerMorphTargetDeform"]:
  504. n.inputs.remove(n.inputs[-1]) # get rid of the wildcard
  505. if n.bl_idname in [ "SchemaArrayInput",
  506. "SchemaArrayInputGet",
  507. "SchemaArrayOutput",
  508. "SchemaConstInput",
  509. "SchemaConstOutput",
  510. "SchemaOutgoingConnection",
  511. "SchemaIncomingConnection",]:
  512. n.update()
  513. if sub_tree := propslist.get("node_tree"):
  514. n.node_tree = bpy.data.node_groups.get(sub_tree)
  515. from .base_definitions import node_group_update
  516. n.is_updating = True
  517. try:
  518. node_group_update(n, force = True)
  519. finally:
  520. n.is_updating=False
  521. sockets_removed = []
  522. for i, (s_id, s_val) in enumerate(propslist["sockets"].items()):
  523. for socket_removed in SOCKETS_REMOVED:
  524. if n.bl_idname == socket_removed[0] and s_id == socket_removed[1]:
  525. prWhite(f"INFO: Ignoring import of socket {s_id}; it has been removed.")
  526. sockets_removed.append(s_val["index"])
  527. sockets_removed.sort()
  528. continue
  529. try:
  530. if s_val["is_output"]: # for some reason it thinks the index is a string?
  531. if n.bl_idname in "MantisSchemaGroup":
  532. n.is_updating = True
  533. try:
  534. socket = n.outputs.new(s_val["bl_idname"], s_val["name"], identifier=s_id)
  535. finally:
  536. n.is_updating=False
  537. else: # IT IS NOT CLEAR but this is what throws the index error below BAD
  538. for socket in n.outputs:
  539. if socket.identifier == s_val['identifier']:
  540. break
  541. else: # otherwise try to get the index
  542. prRed("Getting Imported Socket by Index. Maybe there will be an error.")
  543. socket = n.outputs[int(s_val["index"])]
  544. else:
  545. for removed_index in sockets_removed:
  546. if s_val["index"] > removed_index:
  547. s_val["index"]-=1
  548. if s_val["index"] >= len(n.inputs):
  549. if n.bl_idname in add_inputs_bl_idnames:
  550. socket = n.inputs.new(s_val["bl_idname"], s_val["name"], identifier=s_id, use_multi_input=s_val["is_multi_input"])
  551. elif n.bl_idname in ["MantisSchemaGroup"]:
  552. n.is_updating = True
  553. try:
  554. socket = n.inputs.new(s_val["bl_idname"], s_val["name"], identifier=s_id, use_multi_input=s_val["is_multi_input"])
  555. finally:
  556. n.is_updating=False
  557. elif n.bl_idname in ["NodeGroupOutput"]:
  558. pass # this is dealt with separately
  559. else:
  560. prWhite("Not found: ", n.name, s_val["name"], s_id)
  561. prRed("Index: ", s_val["index"], "Number of inputs", len(n.inputs))
  562. raise NotImplementedError(wrapRed(f"{n.bl_idname} needs to be handled in JSON load."))
  563. else:
  564. # IT IS NOT CLEAR but this is what throws the index error below BAD
  565. # first try to get by ID
  566. for socket in n.inputs:
  567. if socket.identifier == s_val['identifier']:
  568. break
  569. else: # otherwise try to get the index
  570. prRed("Getting Imported Socket by Index. Maybe there will be an error.")
  571. socket = n.inputs[int(s_val["index"])]
  572. except IndexError:
  573. socket = fix_custom_parameter(n, propslist["sockets"][s_id])
  574. if socket is None:
  575. is_output = "output" if {s_val["is_output"]} else "input"
  576. prRed(s_val, type(s_val))
  577. raise RuntimeError(is_output, n.name, s_val["name"], s_id, len(n.inputs))
  578. for s_p, s_v in s_val.items():
  579. if s_p not in ["default_value"]:
  580. if s_p == "search_prop" and n.bl_idname == 'UtilityMetaRig':
  581. socket.node.armature= s_v
  582. socket.search_prop=bpy.data.objects.get(s_v)
  583. if s_p == "search_prop" and n.bl_idname in ['UtilityMatrixFromCurve', 'UtilityMatricesFromCurve']:
  584. socket.search_prop=bpy.data.objects.get(s_v)
  585. elif s_p == "bone" and socket.bl_idname == 'EnumMetaBoneSocket':
  586. socket.bone = s_v
  587. socket.node.pose_bone = s_v
  588. continue # not editable and NOT SAFE
  589. #
  590. if socket.bl_idname in ["BooleanThreeTupleSocket"]:
  591. value = bool(s_v[0]), bool(s_v[1]), bool(s_v[2]),
  592. s_v = value
  593. try:
  594. setattr(socket, s_p , s_v)
  595. except TypeError as e:
  596. prRed("Can't set socket due to type mismatch: ", n.name, socket.name, s_p, s_v)
  597. # raise e
  598. except ValueError as e:
  599. prRed("Can't set socket due to type mismatch: ", n.name, socket.name, s_p, s_v)
  600. # raise e
  601. except AttributeError as e:
  602. prWhite("Tried to write a read-only property, ignoring...")
  603. prWhite(f"{socket.node.name}[{socket.name}].{s_p} is read only, cannot set value to {s_v}")
  604. for p, v in propslist.items():
  605. if p in ["node_tree", "sockets", "warning_propagation", "socket_idname"]:
  606. continue
  607. # will throw AttributeError if read-only
  608. # will throw TypeError if wrong type...
  609. if n.bl_idname == "NodeFrame" and p in ["width, height, location"]:
  610. continue
  611. if version < (4,4,0) and p == 'location_absolute':
  612. continue
  613. if p == "parent" and v is not None:
  614. parent_me.append( (n.name, v) )
  615. v = None # for now) #TODO
  616. try:
  617. setattr(n, p, v)
  618. except Exception as e:
  619. print (p)
  620. raise e
  621. for l in links:
  622. id1 = l[1]
  623. id2 = l[3]
  624. #
  625. name1=l[6]
  626. name2=l[7]
  627. # if the from/to socket or node has been removed, continue
  628. from_node = tree.nodes.get(l[0])
  629. if not from_node:
  630. prWhite(f"INFO: cannot create link {l[0]}:{l[1]} --> {l[2]}:{l[3]}")
  631. continue
  632. if hasattr(from_node, "node_tree"): # now we have to map by name actually
  633. try:
  634. id1 = from_node.outputs[l[4]].identifier
  635. except IndexError:
  636. prRed ("Index incorrect")
  637. id1 = None
  638. elif from_node.bl_idname in ["NodeGroupInput"]:
  639. id1 = tree_sock_id_map.get(l[1])
  640. if id1 is None:
  641. prRed(l[1])
  642. # prOrange (l[1], id1)
  643. elif from_node.bl_idname in ["SchemaArrayInput", "SchemaConstInput", "SchemaIncomingConnection"]:
  644. # try the index instead
  645. id1 = from_node.outputs[l[4]].identifier
  646. for from_sock in from_node.outputs:
  647. if from_sock.identifier == id1: break
  648. else: # we can raise a runtime error here actually
  649. from_sock = None
  650. to_node = tree.nodes[l[2]]
  651. if hasattr(to_node, "node_tree"):
  652. try:
  653. id2 = to_node.inputs[l[5]].identifier
  654. except IndexError:
  655. prRed ("Index incorrect")
  656. id2 = None
  657. elif to_node.bl_idname in ["NodeGroupOutput"]:
  658. id2 = tree_sock_id_map.get(l[3])
  659. elif to_node.bl_idname in ["SchemaArrayOutput", "SchemaConstOutput", "SchemaOutgoingConnection"]:
  660. # try the index instead
  661. id2 = to_node.inputs[l[5]].identifier
  662. for to_sock in to_node.inputs:
  663. if to_sock.identifier == id2: break
  664. else:
  665. to_sock = None
  666. try:
  667. link = tree.links.new(from_sock, to_sock)
  668. except TypeError:
  669. if ((id1 is not None) and ("Layer Mask" in id1)) or ((id2 is not None) and ("Layer Mask" in id2)):
  670. pass
  671. else:
  672. prWhite(f"looking for... {name1}:{id1}, {name2}:{id2}")
  673. prRed (f"Failed: {l[0]}:{l[1]} --> {l[2]}:{l[3]}")
  674. prRed (f" got node: {from_node.name}, {to_node.name}")
  675. prRed (f" got socket: {from_sock}, {to_sock}")
  676. prOrange(to_node.inputs.keys())
  677. if from_sock is None:
  678. prOrange ("Candidates...")
  679. for out in from_node.outputs:
  680. prOrange(" %s, id=%s" % (out.name, out.identifier))
  681. for k, v in tree_sock_id_map.items():
  682. print (wrapOrange(k), wrapPurple(v))
  683. if to_sock is None:
  684. prOrange ("Candidates...")
  685. for inp in to_node.inputs:
  686. prOrange(" %s, id=%s" % (inp.name, inp.identifier))
  687. for k, v in tree_sock_id_map.items():
  688. print (wrapOrange(k), wrapPurple(v))
  689. raise RuntimeError
  690. # if at this point it doesn't work... we need to fix
  691. for name, p in parent_me:
  692. if (n := tree.nodes.get(name)) and (p := tree.nodes.get(p)):
  693. n.parent = p
  694. # otherwise the frame node is missing because it was not included in the data e.g. when grouping nodes.
  695. tree.is_executing = False
  696. tree.do_live_update = True
  697. import bpy
  698. from bpy_extras.io_utils import ImportHelper, ExportHelper
  699. from bpy.props import StringProperty, BoolProperty, EnumProperty
  700. from bpy.types import Operator
  701. # Save As
  702. class MantisExportNodeTreeSaveAs(Operator, ExportHelper):
  703. """Export a Mantis Node Tree by filename."""
  704. bl_idname = "mantis.export_save_as"
  705. bl_label = "Export Mantis Tree as ...(JSON)"
  706. # ExportHelper mix-in class uses this.
  707. filename_ext = ".rig"
  708. filter_glob: StringProperty(
  709. default="*.rig",
  710. options={'HIDDEN'},
  711. maxlen=255, # Max internal buffer length, longer would be clamped.
  712. )
  713. @classmethod
  714. def poll(cls, context):
  715. return hasattr(context.space_data, 'path')
  716. def execute(self, context):
  717. # we need to get the dependent trees from self.tree...
  718. # there is no self.tree
  719. # how do I choose a tree?
  720. base_tree=context.space_data.path[-1].node_tree
  721. from .utilities import all_trees_in_tree
  722. trees = all_trees_in_tree(base_tree)[::-1]
  723. prGreen("Exporting node graph with dependencies...")
  724. for t in trees:
  725. prGreen ("Node graph: \"%s\"" % (t.name))
  726. base_tree.is_exporting = True
  727. export_to_json(trees, self.filepath)
  728. base_tree.is_exporting = False
  729. base_tree.prevent_next_exec = True
  730. return {'FINISHED'}
  731. # Save
  732. class MantisExportNodeTreeSave(Operator):
  733. """Save a Mantis Node Tree to disk."""
  734. bl_idname = "mantis.export_save"
  735. bl_label = "Export Mantis Tree (JSON)"
  736. @classmethod
  737. def poll(cls, context):
  738. return hasattr(context.space_data, 'path')
  739. def execute(self, context):
  740. base_tree=context.space_data.path[-1].node_tree
  741. from .utilities import all_trees_in_tree
  742. trees = all_trees_in_tree(base_tree)[::-1]
  743. prGreen("Exporting node graph with dependencies...")
  744. for t in trees:
  745. prGreen ("Node graph: \"%s\"" % (t.name))
  746. base_tree.is_exporting = True
  747. export_to_json(trees, self.filepath)
  748. base_tree.is_exporting = False
  749. base_tree.prevent_next_exec = True
  750. return {'FINISHED'}
  751. # Save Choose:
  752. class MantisExportNodeTree(Operator):
  753. """Save a Mantis Node Tree to disk."""
  754. bl_idname = "mantis.export_save_choose"
  755. bl_label = "Export Mantis Tree (JSON)"
  756. @classmethod
  757. def poll(cls, context):
  758. return hasattr(context.space_data, 'path')
  759. def execute(self, context):
  760. base_tree=context.space_data.path[-1].node_tree
  761. if base_tree.filepath:
  762. prRed(base_tree.filepath)
  763. return bpy.ops.mantis.export_save()
  764. else:
  765. return bpy.ops.mantis.export_save_as('INVOKE_DEFAULT')
  766. # here is what needs to be done...
  767. # - modify this to work with a sort of parsed-tree instead (sort of)
  768. # - this needs to treat each sub-graph on its own
  769. # - is this a problem? do I need to reconsider how I treat the graph data in mantis?
  770. # - I should learn functional programming / currying
  771. # - then the parsed-tree this builds must be executed as Blender nodes
  772. # - I think... this is not important right now. not yet.
  773. # - KEEP IT SIMPLE, STUPID
  774. class MantisImportNodeTree(Operator, ImportHelper):
  775. """Import a Mantis Node Tree."""
  776. bl_idname = "mantis.import_tree"
  777. bl_label = "Import Mantis Tree (JSON)"
  778. # ImportHelper mixin class uses this
  779. filename_ext = ".rig"
  780. filter_glob : StringProperty(
  781. default="*.rig",
  782. options={'HIDDEN'},
  783. maxlen=255, # Max internal buffer length, longer would be clamped.
  784. )
  785. def execute(self, context):
  786. return do_import_from_file(self.filepath, context)
  787. # this is useful:
  788. # https://blender.stackexchange.com/questions/73286/how-to-call-a-confirmation-dialog-box
  789. # class MantisReloadConfirmMenu(bpy.types.Panel):
  790. # bl_label = "Confirm?"
  791. # bl_idname = "OBJECT_MT_mantis_reload_confirm"
  792. # def draw(self, context):
  793. # layout = self.layout
  794. # layout.operator("mantis.reload_tree")
  795. class MantisReloadNodeTree(Operator):
  796. # """Import a Mantis Node Tree."""
  797. # bl_idname = "mantis.reload_tree"
  798. # bl_label = "Import Mantis Tree"
  799. """Reload Mantis Tree"""
  800. bl_idname = "mantis.reload_tree"
  801. bl_label = "Confirm reload tree?"
  802. bl_options = {'REGISTER', 'INTERNAL'}
  803. @classmethod
  804. def poll(cls, context):
  805. if hasattr(context.space_data, 'path'):
  806. return True
  807. return False
  808. def invoke(self, context, event):
  809. return context.window_manager.invoke_confirm(self, event)
  810. def execute(self, context):
  811. base_tree=context.space_data.path[-1].node_tree
  812. if not base_tree.filepath:
  813. self.report({'ERROR'}, "Tree has not been saved - so it cannot be reloaded.")
  814. return {'CANCELLED'}
  815. self.report({'INFO'}, "reloading tree")
  816. return do_import_from_file(base_tree.filepath, context)
  817. # todo:
  818. # - export metarig and option to import it
  819. # - same with controls
  820. # - it would be nice to have a library of these that can be imported alongside the mantis graph