readtree.py 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834
  1. from ..utilities.utilities import prRed, prGreen, prPurple, prWhite, prOrange, \
  2. wrapRed, wrapGreen, wrapPurple, wrapWhite, wrapOrange
  3. # FIXME I don't think these signatures are unique.
  4. # TODO this is a really silly and bad and also really dumb way to do this
  5. def insert_lazy_parents(mantis_node):
  6. from ..link_nodes import LinkInherit
  7. inherit_node = None
  8. if mantis_node.inputs["Relationship"].is_connected:
  9. from ..utilities.node_common import trace_single_line_safe
  10. # BUG this line can create infinite loops
  11. node_line, last_socket = trace_single_line_safe(mantis_node, 'Relationship')
  12. # if last_socket is from a valid XFORM, it is the relationship in
  13. # because it was traversed from the xForm Out... so get the traverse target.
  14. if last_socket.traverse_target is None:
  15. return # this is not a valid lazy parent.
  16. for other_node in node_line[1:]: # skip the first one, it is the same node
  17. if other_node.node_type == 'LINK':
  18. return # this one has a realtionship connection.
  19. elif other_node.node_type == 'XFORM':
  20. break
  21. if other_node.node_type in ["XFORM"] and last_socket.traverse_target.name in ["xForm Out"]:
  22. for link in other_node.outputs['xForm Out'].links:
  23. if link.to_node == mantis_node: link.die()
  24. inherit_node = LinkInherit(("MANTIS_AUTOGENERATED", *mantis_node.signature[1:], "LAZY_INHERIT"), mantis_node.base_tree)
  25. l = other_node.outputs['xForm Out'].connect(inherit_node, 'Parent')
  26. l1 = inherit_node.outputs['Inheritance'].connect(mantis_node, 'Relationship')
  27. inherit_node.parameters = { "Parent":None,
  28. "Inherit Rotation":True,
  29. "Inherit Scale":'FULL',
  30. "Connected":False, }
  31. # because the from node may have already been done.
  32. init_connections(other_node); init_dependencies(other_node)
  33. init_connections(inherit_node); init_dependencies(inherit_node)
  34. return inherit_node
  35. # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #
  36. # DATA FROM NODES #
  37. # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #
  38. from ..base_definitions import replace_types, NodeSocket
  39. def autogen_node(base_tree, ui_socket, signature, mContext):
  40. mantis_node=None
  41. from ..internal_nodes import AutoGenNode
  42. mantis_node = AutoGenNode(signature, base_tree)
  43. mantis_node.mContext = mContext
  44. mantis_node.outputs[ui_socket.name] = NodeSocket(is_input=False, name=ui_socket.name, node=mantis_node)
  45. mantis_node.ui_signature = None # does not exist in the UI
  46. return mantis_node
  47. # TODO: investigate whether I can set the properties in the downstream nodes directly.
  48. # I am doing this in Schema Solver and it seems to work quite efficiently.
  49. def make_connections_to_ng_dummy(base_tree, tree_path_names, local_mantis_nodes, all_mantis_nodes, to_mantis_node):
  50. from ..socket_definitions import no_default_value
  51. for inp in to_mantis_node.ui_node.inputs:
  52. if inp.bl_idname in no_default_value:
  53. continue
  54. from_mantis_node = None
  55. to_s = inp.identifier
  56. if not inp.is_linked: # make an autogenerated NC for the inputs of the group node
  57. # This can be run inside schema. Make it unique with uuid() to be safe.
  58. from uuid import uuid4
  59. signature = ("MANTIS_AUTOGENERATED", *tree_path_names, to_mantis_node.ui_signature[-1], inp.name, inp.identifier, str(uuid4()))
  60. from_mantis_node = all_mantis_nodes.get(signature) # creating this without checking and
  61. # using UUID signature leads to TERRIBLE CONFUSING BUGS.
  62. if from_mantis_node is None:
  63. from_mantis_node = autogen_node(base_tree, inp, signature, to_mantis_node.mContext)
  64. from ..utilities.node_common import get_socket_value
  65. if from_mantis_node: # autogen can fail and we should catch it.
  66. from_mantis_node.parameters = {inp.name:get_socket_value(inp)}
  67. local_mantis_nodes[signature] = from_mantis_node; all_mantis_nodes[signature] = from_mantis_node
  68. from_mantis_node.outputs[inp.name].connect(node=to_mantis_node, socket=to_s, sort_id=0)
  69. else:
  70. prRed("No available auto-generated class for input %s in %s" % (inp.name, np.name))
  71. def gen_mantis_nodes(base_tree, current_tree, tree_path_names, mContext, all_mantis_nodes, local_mantis_nodes, dummy_nodes, group_nodes, schema_nodes, in_schema ):
  72. from ..internal_nodes import DummyNode
  73. for ui_node in current_tree.nodes:
  74. if ui_node.bl_idname in ["NodeFrame", "NodeReroute"]:
  75. continue # not a Mantis Node
  76. if ui_node.bl_idname in ["NodeGroupInput", "NodeGroupOutput"]:
  77. # we only want ONE dummy in/out per tree_path, so use the bl_idname to make a Dummy node
  78. sig = (None, *tree_path_names, ui_node.bl_idname)
  79. ui_sig = (None, *tree_path_names, ui_node.name)
  80. if not local_mantis_nodes.get(sig):
  81. mantis_node = DummyNode( signature=sig , base_tree=base_tree, ui_node=ui_node, ui_signature=ui_sig )
  82. local_mantis_nodes[sig] = mantis_node; all_mantis_nodes[sig] = mantis_node; dummy_nodes[sig] = mantis_node
  83. if ui_node.bl_idname in ["NodeGroupOutput"]:
  84. mantis_node.reroute_links_type = 'out'
  85. elif ui_node.bl_idname in ["MantisNodeGroup", "MantisSchemaGroup"]:
  86. mantis_node = DummyNode( signature= (sig := (None, *tree_path_names, ui_node.name) ), base_tree=base_tree, ui_node=ui_node )
  87. local_mantis_nodes[sig] = mantis_node; all_mantis_nodes[sig] = mantis_node; dummy_nodes[sig] = mantis_node
  88. make_connections_to_ng_dummy(base_tree, tree_path_names, local_mantis_nodes, all_mantis_nodes, mantis_node)
  89. group_nodes.append(mantis_node)
  90. if ui_node.bl_idname == "MantisNodeGroup":
  91. mantis_node.reroute_links_type = 'group'
  92. else:
  93. mantis_node.reroute_links_type = 'schema'
  94. schema_nodes[sig] = mantis_node
  95. # if it wasn't the types we ignore or the types we make a Dummy for, use this to catch all non-special cases.
  96. elif (mantis_class := ui_node.mantis_class):
  97. sig = (None, *tree_path_names, ui_node.name)
  98. if ui_node.bl_idname in replace_types:
  99. sig = (None, *tree_path_names, ui_node.bl_idname)
  100. if local_mantis_nodes.get(sig):
  101. continue # already made
  102. mantis_node = mantis_class( sig , base_tree)
  103. local_mantis_nodes[sig] = mantis_node; all_mantis_nodes[sig] = mantis_node
  104. mantis_node.ui_signature = (*mantis_node.ui_signature[:-1], ui_node.name) # just to ensure it points to a real node.
  105. else:
  106. mantis_node = None
  107. prRed(f"Can't make mantis_node for.. {ui_node.bl_idname}")
  108. # this should be done at init
  109. mantis_node.mContext = mContext
  110. if mantis_node.signature[0] not in ['MANTIS_AUTOGENERATED'] and mantis_node.node_type not in ['SCHEMA', 'DUMMY', 'DUMMY_SCHEMA']:
  111. mantis_node.fill_parameters()
  112. mantis_node.is_schema_prototype = in_schema
  113. def data_from_tree(base_tree, tree_path, mContext, dummy_nodes, all_mantis_nodes, all_schema, in_schema):#
  114. # TODO: it should be relatively easy to make this use a while loop instead of recursion.
  115. local_mantis_nodes, group_nodes = {}, []
  116. tree_path_names = [tree.name for tree in tree_path if hasattr(tree, "name")]
  117. if tree_path[-1]:
  118. current_tree = tree_path[-1].node_tree # this may be None.
  119. else:
  120. current_tree = base_tree
  121. #
  122. if current_tree: # the node-group may not have a tree set - if so, ignore it.
  123. if not in_schema:
  124. in_schema = current_tree.bl_idname in ['SchemaTree']
  125. from ..utilities.utilities import clear_reroutes
  126. links = clear_reroutes(list(current_tree.links))
  127. gen_mantis_nodes(base_tree, current_tree, tree_path_names, mContext, all_mantis_nodes, local_mantis_nodes, dummy_nodes, group_nodes, all_schema, in_schema)
  128. from ..utilities.utilities import link_mantis_nodes
  129. for link in links:
  130. link_mantis_nodes((None, *tree_path_names), link, local_mantis_nodes)
  131. if current_tree == base_tree:
  132. # in the base tree, we need to auto-gen the default values in a slightly different way to node groups.
  133. insert_default_values_base_tree(base_tree, all_mantis_nodes)
  134. # Now, descend into the Node Groups and recurse
  135. for mantis_node in group_nodes:
  136. data_from_tree(base_tree, tree_path+[mantis_node.ui_node], mContext, dummy_nodes, all_mantis_nodes, all_schema, in_schema)
  137. return dummy_nodes, all_mantis_nodes, all_schema
  138. STRING_PADDING = 4
  139. overlay_valid_socket_types = [
  140. "FloatSocket", "FloatPositiveSocket", "FloatFactorSocket",
  141. "FloatAngleSocket", "UnsignedIntSocket", "IntSocket", "StringSocket",
  142. ]
  143. # Do not use these input names as overlay keys:
  144. forbidden_key_names = ["",]
  145. forbidden_in_key_name = ['$',]
  146. def node_scan_overlays(node, socket_id,):
  147. from ..utilities.node_common import GraphError
  148. interface_nodes = node.mContext.interface_nodes
  149. from ..utilities.utilities import get_ui_node
  150. ui_node = get_ui_node(node.ui_signature, node.base_tree)
  151. # we'll assume that the overlay tag system checked if this is linked.
  152. # First let's check if it is a simple input node, by checking outputs that are marked "input"
  153. for socket in ui_node.outputs:
  154. # weird edge case for simple input nodes with unnamed sockets
  155. # the socket.identifier is not used by Mantis but it defaults to 'socket'\
  156. if socket.identifier == socket_id and socket.input == True: break
  157. else:
  158. for socket in ui_node.inputs:
  159. if socket.identifier == socket_id: break
  160. else:
  161. raise KeyError(f"Socket not found by ID {socket_id} in node {node.ui_signature}\n"
  162. f"Candidates: {[socket.identifier for socket in ui_node.inputs]}")
  163. value = socket.default_value # get the ACTUAL UI value
  164. if not isinstance(value, str): return
  165. # First step: get the interface nodes and the overlay keys
  166. # this should only check interfaces that are ancestors of this node
  167. my_interfaces = []
  168. for index in range(len(node.signature)-1):
  169. if index == 0: continue # root
  170. interface_signature = (*node.signature[:index+1], "InputInterface")
  171. my_interfaces.append( interface_nodes[interface_signature] )
  172. # the my_interfaces list is sorted in REVERSE order of importance
  173. # Next, get all the overlay providers.
  174. name_to_id_map = {}
  175. name_to_type_map = {} # Just for printing reasonable error messages
  176. overlay_keys = set()
  177. root_overlay_values = {}
  178. # First, we'll get the base tree's default inputs
  179. for interface_item in node.mContext.base_tree.interface.items_tree:
  180. if interface_item.item_type != "SOCKET": continue
  181. if interface_item.in_out != "INPUT": continue
  182. # NOTE this will need to change if overlays extend to other data types
  183. if hasattr(interface_item, "default_string"):
  184. # NOTE that there may be duplicate names. Too bad!
  185. root_overlay_values[interface_item.name] = interface_item.default_string
  186. elif hasattr(interface_item, "default_int"):
  187. root_overlay_values[interface_item.name] = str(interface_item.default_int).zfill(STRING_PADDING)
  188. elif hasattr(interface_item, "default_float"):
  189. root_overlay_values[interface_item.name] = str(interface_item.default_float).zfill(STRING_PADDING)
  190. overlay_keys.add(interface_item.name)
  191. name_to_id_map[interface_item.name] = None # don't worry about it
  192. name_to_type_map[interface_item.name] = interface_item.bl_socket_idname
  193. for interface_node in interface_nodes.values():
  194. # problem: the interface node stores socket identifiers as keys
  195. # so in reality we need to get the group UI node and ask for its input names
  196. # if there is a duplicate name, too bad!
  197. group_ui_node = get_ui_node(interface_node.ui_signature[:-1], node.base_tree)
  198. for interface_item in group_ui_node.node_tree.interface.items_tree:
  199. if interface_item.item_type != 'SOCKET': continue
  200. if interface_item.in_out != 'INPUT': continue
  201. if interface_item.name in forbidden_key_names: continue
  202. for substr in forbidden_in_key_name:
  203. if substr in interface_item.name:
  204. break
  205. else: # if we do not find a bad substr
  206. name_to_id_map[interface_item.name]=interface_item.identifier
  207. name_to_type_map[interface_item.name] = interface_item.bl_socket_idname
  208. overlay_keys.add(interface_item.name)
  209. # sort by reverse length so we find "CatsAndFrogs" before "Cats"
  210. overlay_keys = sorted(overlay_keys, key= lambda a :-1*len(a))
  211. # First I need to break it into substrings based on quotation marks
  212. from ..utilities.utilities import split_quoted_substrings_to_strings
  213. quoted_substrings = split_quoted_substrings_to_strings(value)
  214. overlay_tries = []
  215. for quoted_substring in quoted_substrings:
  216. overlay_tries.extend(quoted_substring.split("$"))
  217. result = overlay_tries[0] # the 0th element is always before the split character
  218. # the reason for the difference between overlay_try and key is because
  219. # we don't actually know if the $text part has a key in it
  220. for overlay_try in overlay_tries[1:]:
  221. if not overlay_try: continue # some of these are empty
  222. overlay_resolved_value = "$" + overlay_try
  223. for key in overlay_keys:
  224. if key in overlay_try:
  225. overlay_resolved_value = "$" + key
  226. for interface in reversed(my_interfaces): # since this is reversed when we build it
  227. if interface.inputs.get(actual_key := name_to_id_map.get(key)):
  228. overlay_value = None
  229. try:
  230. overlay_value = interface.evaluate_input(actual_key)
  231. except KeyError:
  232. if (socket_type := name_to_type_map.get(key) or 'NOT FOUND') in overlay_valid_socket_types:
  233. raise GraphError(f"Error: Variable {key} is not supported because it has "
  234. f"an invalid input in the node group: {interface.signature[:-1]}.")
  235. raise GraphError( f"Error: Variable {key} is not supported because it is "
  236. f"type {socket_type}" )
  237. continue
  238. # NOTE that the above can also be caused by any BUG occuring in node group update
  239. # because it causes the interface to be invalid for the UI node that spawns the interface node.
  240. if isinstance(overlay_value, (float, int)):
  241. overlay_value = str(overlay_value).zfill(STRING_PADDING)
  242. assert (isinstance(overlay_value, str)), f"Error: Variable {key} is not supported because it is type {type(overlay_value)}"
  243. overlay_resolved_value = overlay_try.replace(key, overlay_value)
  244. break
  245. else: # we'll try the base tree
  246. if base_tree_result := root_overlay_values.get(overlay_try):
  247. overlay_resolved_value = base_tree_result
  248. else:
  249. prOrange(f"WARN: no overlay value applied for {node.ui_signature} for key {key}")
  250. break # we found the key and are done here. One found Key per overlay-try
  251. result += overlay_resolved_value
  252. # Simple Input sockets with unnamed sockets assign this ID automatically
  253. # But Mantis uses the name instead. Usually the name and ID are the same.
  254. if socket_id == 'socket' and ui_node.outputs[0].name == "":
  255. socket_id = ''
  256. node.parameters[socket_id] = result
  257. return result # because sometimes I need to get the result, too
  258. from ..utilities.utilities import check_and_add_root, init_connections, init_dependencies, init_schema_dependencies
  259. def solve_schema_to_tree(mantis_node, all_mantis_nodes, roots=[], error_popups=False):
  260. from ..utilities.utilities import get_ui_node
  261. np = get_ui_node(mantis_node.signature, mantis_node.base_tree)
  262. from .schema_solve import SchemaSolver
  263. solver = SchemaSolver(mantis_node, all_mantis_nodes.copy(), np, error_popups=error_popups)
  264. try:
  265. solved_nodes = solver.solve()
  266. except Exception as e:
  267. # # the schema will run the error cleanup code, we just need to raise or not
  268. solved_nodes = {}
  269. mantis_node.base_tree.hash_recursive=''
  270. raise execution_error_cleanup(mantis_node, e, show_error=error_popups)
  271. for k,v in solved_nodes.items():
  272. all_mantis_nodes[k]=v
  273. init_connections(v)
  274. check_and_add_root(v, roots, include_non_hierarchy=True)
  275. return solved_nodes
  276. # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #
  277. # PARSE NODE TREE #
  278. # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** # *** #
  279. schema_bl_idnames = [ "SchemaIndex",
  280. "SchemaArrayInput",
  281. "SchemaArrayInputGet",
  282. "SchemaArrayInputAll",
  283. "SchemaArrayOutput",
  284. "SchemaConstInput",
  285. "SchemaConstOutput",
  286. "SchemaOutgoingConnection",
  287. "SchemaIncomingConnection",
  288. ]
  289. from ..utilities.utilities import get_all_dependencies
  290. def get_schema_length_dependencies(node, all_nodes={}):
  291. """ Get a list of all dependencies for the given node's length or array properties.
  292. This function will also recursively search for dependencies in its sub-trees.
  293. """
  294. deps = []
  295. prepare_links_to = ['Schema Length', 'Array', 'Index']
  296. def extend_dependencies_from_inputs(node):
  297. for inp in node.inputs.values():
  298. for l in inp.links:
  299. if not l.from_node in node.hierarchy_dependencies:
  300. continue
  301. if "MANTIS_AUTOGENERATED" in l.from_node.signature:
  302. deps.extend([l.from_node]) # why we need this lol
  303. if inp.name in prepare_links_to:
  304. deps.append(l.from_node)
  305. deps.extend(get_all_dependencies(l.from_node))
  306. def deps_filter(dep): # remove any nodes inside the schema
  307. if len(dep.signature) > len(node.signature):
  308. for i in range(len(node.signature)):
  309. dep_sig_elem, node_sig_elem = dep.signature[i], node.signature[i]
  310. if dep_sig_elem != node_sig_elem: break # they don't match, it isn't an inner-node
  311. else: # remove this, it didn't break, meaning it shares signature with outer node
  312. return False # this is an inner-node
  313. return True
  314. # this way we can handle Schema and Array Get nodes with one function
  315. extend_dependencies_from_inputs(node)
  316. if node.node_type == 'DUMMY_SCHEMA':
  317. trees = [(node.ui_node.node_tree, node.signature)] # this is UI data
  318. while trees:
  319. tree, tree_signature = trees.pop()
  320. for sub_ui_node in tree.nodes:
  321. if sub_ui_node.bl_idname in ['NodeReroute', 'NodeFrame']:
  322. continue
  323. if sub_ui_node.bl_idname in schema_bl_idnames:
  324. sub_node = all_nodes[(*tree_signature, sub_ui_node.bl_idname)]
  325. else:
  326. sub_node = all_nodes[(*tree_signature, sub_ui_node.name)]
  327. if sub_node.node_type == 'DUMMY_SCHEMA':
  328. extend_dependencies_from_inputs(sub_node)
  329. trees.append((sub_node.ui_node.node_tree, sub_node.signature))
  330. return list(filter(deps_filter, deps))
  331. def insert_default_values_base_tree(base_tree, all_mantis_nodes):
  332. # we can get this by name because group inputs are gathered to the bl_idname
  333. InputNode = all_mantis_nodes.get((None, 'NodeGroupInput'))
  334. if InputNode is None: return # nothing to do here.
  335. ui_node = InputNode.ui_node
  336. for i, output in enumerate(InputNode.outputs):
  337. ui_output = ui_node.outputs[i] # I need this for the error messages to make sense
  338. assert ui_output.identifier == output.name, "Cannot find UI Socket for Default Value"
  339. for interface_item in base_tree.interface.items_tree:
  340. if interface_item.item_type == 'PANEL': continue
  341. if interface_item.identifier == output.name: break
  342. else:
  343. raise RuntimeError(f"Default value {ui_output.name} does not exist in {base_tree.name} ")
  344. if interface_item.item_type == "PANEL":
  345. raise RuntimeError(f"Cannot get default value for {ui_output.name} in {base_tree.name} ")
  346. default_value = None
  347. from bpy.types import bpy_prop_array
  348. from mathutils import Vector
  349. val_type = None
  350. if hasattr(ui_output, 'default_value'):
  351. val_type = type(ui_output.default_value) # why tf can't I match/case here?
  352. if val_type is bool: default_value = interface_item.default_bool
  353. elif val_type is int: default_value = interface_item.default_int
  354. elif val_type is float: default_value = interface_item.default_float
  355. elif val_type is Vector: default_value = interface_item.default_vector
  356. elif val_type is str: default_value = interface_item.default_string
  357. elif val_type is bpy_prop_array: default_value = interface_item.default_bool_vector
  358. elif interface_item.bl_socket_idname == "xFormSocket":
  359. if interface_item.default_xForm == 'ARMATURE':
  360. default_value = 'MANTIS_DEFAULT_ARMATURE'
  361. else:
  362. raise RuntimeError(f"No xForm connected for {ui_output.name} in {base_tree.name}.")
  363. else:
  364. raise RuntimeError(f"Cannot get default value for {ui_output.name} in {base_tree.name} ")
  365. output_name = output.name
  366. if interface_item.bl_socket_idname not in ['xFormSocket']:
  367. signature = ("MANTIS_AUTOGENERATED", f"Default Value {output.name}",)
  368. autogen_mantis_node = all_mantis_nodes.get(signature)
  369. if autogen_mantis_node is None:
  370. autogen_mantis_node = autogen_node(base_tree, output, signature, InputNode.mContext)
  371. autogen_mantis_node.parameters[output_name]=default_value
  372. elif interface_item.bl_socket_idname == 'xFormSocket' \
  373. and default_value == 'MANTIS_DEFAULT_ARMATURE':
  374. signature = ("MANTIS_AUTOGENERATED", "MANTIS_DEFAULT_ARMATURE",)
  375. autogen_mantis_node = all_mantis_nodes.get(signature)
  376. if autogen_mantis_node is None:
  377. from ..xForm_nodes import xFormArmature
  378. autogen_mantis_node = xFormArmature(signature, base_tree)
  379. autogen_mantis_node.parameters['Name']=base_tree.name+'_MANTIS_AUTOGEN'
  380. autogen_mantis_node.mContext = InputNode.mContext
  381. from mathutils import Matrix
  382. autogen_mantis_node.parameters['Matrix'] = Matrix.Identity(4)
  383. output_name = 'xForm Out'
  384. while output.links:
  385. l = output.links.pop()
  386. to_node = l.to_node; to_socket = l.to_socket
  387. l.die()
  388. autogen_mantis_node.outputs[output_name].connect(to_node, to_socket)
  389. init_connections(l.from_node); init_dependencies(l.from_node)
  390. all_mantis_nodes[autogen_mantis_node.signature]=autogen_mantis_node
  391. def parse_tree(base_tree, error_popups=False):
  392. from uuid import uuid4
  393. base_tree.execution_id = uuid4().__str__() # set the unique id of this execution
  394. from ..base_definitions import MantisExecutionContext
  395. from ..utilities.node_common import GraphError
  396. mContext = MantisExecutionContext(base_tree=base_tree)
  397. import time
  398. data_start_time = time.time()
  399. # annoyingly I have to pass in values for all of the dicts because if I initialize them in the function call
  400. # then they stick around because the function definition inits them once and keeps a reference
  401. # so instead I have to supply them to avoid ugly code or bugs elsewhere
  402. # it's REALLY confusing when you run into this sort of problem. So it warrants four entire lines of comments!
  403. try:
  404. dummy_nodes, all_mantis_nodes, all_schema = data_from_tree(
  405. base_tree,
  406. tree_path = [None],
  407. mContext=mContext,
  408. dummy_nodes = {},
  409. all_mantis_nodes = {},
  410. all_schema={},
  411. in_schema=False
  412. )
  413. except GraphError as e:
  414. base_tree.tree_valid = False; base_tree.hash_recursive=""
  415. if error_popups:
  416. from bpy import context
  417. def error_popup_draw(self, context):
  418. error_popup_draw_inner(self.layout, e, ())
  419. context.window_manager.popup_menu(error_popup_draw, title="Error", icon='ERROR')
  420. else: raise e
  421. return # it is not possible to parse the tree until GraphErrors are resolved.
  422. for dummy in dummy_nodes.values(): # reroute the links in the group nodes
  423. dummy.reroute_links(all_mantis_nodes)
  424. prGreen(f"Pulling data from tree took {time.time() - data_start_time} seconds")
  425. start_time = time.time()
  426. solve_only_these = []; solve_only_these.extend(list(all_schema.values()))
  427. roots, array_nodes = [], []
  428. from collections import deque
  429. unsolved_schema = deque()
  430. from ..base_definitions import array_output_types, GraphError
  431. for mantis_node in all_mantis_nodes.values():
  432. # TODO I still need to assign mContext here because of autogen_node
  433. # so I have to do a deeper refactor to ensure autogen nodes get this at creation time.
  434. mantis_node.mContext = mContext
  435. if mantis_node.node_type in ["DUMMY"]: # clean up the groups
  436. if mantis_node.ui_node.bl_idname in ("MantisNodeGroup", "NodeGroupOutput"):
  437. continue
  438. # Initialize the dependencies and connections (from/to links) for each node.
  439. # we record & store it because using a getter is much slower (according to profiling)
  440. init_dependencies(mantis_node); init_connections(mantis_node)
  441. check_and_add_root(mantis_node, roots, include_non_hierarchy=True)
  442. # Array nodes need a little special treatment, they're quasi-schemas
  443. if mantis_node.__class__.__name__ in array_output_types:
  444. solve_only_these.append(mantis_node)
  445. array_nodes.append(mantis_node)
  446. if mantis_node.node_type == 'INTERFACE':
  447. mContext.interface_nodes[mantis_node.signature] = mantis_node
  448. from itertools import chain
  449. for schema in chain(all_schema.values(), array_nodes):
  450. # We must remove the schema/array nodes that are inside a schema tree.
  451. for i in range(len(schema.signature)-1): # -1, we don't want to check this node, obviously
  452. if parent := all_schema.get(schema.signature[:i+1]):
  453. # This will be solved along with its parent schema.
  454. solve_only_these.remove(schema)
  455. break
  456. for schema in all_schema.values():
  457. if schema not in solve_only_these: continue
  458. init_schema_dependencies(schema, all_mantis_nodes)
  459. solve_only_these.extend(get_schema_length_dependencies(schema, all_mantis_nodes))
  460. unsolved_schema.append(schema)
  461. for array in array_nodes:
  462. if array not in solve_only_these: continue
  463. solve_only_these.extend(get_schema_length_dependencies(array))
  464. solve_only_these.extend(array_nodes)
  465. schema_solve_done = set()
  466. solve_only_these = set(solve_only_these)
  467. solve_layer = unsolved_schema.copy(); solve_layer.extend(roots)
  468. while(solve_layer):
  469. n = solve_layer.pop()
  470. if n not in solve_only_these:
  471. continue
  472. if n.signature in all_schema.keys():
  473. for dep in n.hierarchy_dependencies:
  474. if dep not in schema_solve_done and (dep in solve_only_these):
  475. if dep.prepared:
  476. continue
  477. solve_layer.appendleft(n)
  478. break
  479. else:
  480. try:
  481. solved_nodes = solve_schema_to_tree(n, all_mantis_nodes, roots, error_popups=error_popups)
  482. except Exception as e:
  483. e = execution_error_cleanup(n, e, show_error=error_popups)
  484. solved_nodes = {}
  485. if error_popups == False:
  486. raise e
  487. return # it is not possible to parse the tree.
  488. unsolved_schema.remove(n)
  489. schema_solve_done.add(n)
  490. for node in solved_nodes.values():
  491. init_dependencies(node); init_connections(node)
  492. solve_layer.appendleft(node)
  493. schema_solve_done.add(node) # CRITICAL to prevent freezes.
  494. for conn in n.hierarchy_connections:
  495. if conn not in schema_solve_done and conn not in solve_layer:
  496. solve_layer.appendleft(conn)
  497. continue
  498. else:
  499. for dep in n.hierarchy_dependencies:
  500. if dep not in schema_solve_done:
  501. break
  502. else:
  503. try:
  504. n.bPrepare()
  505. except Exception as e:
  506. e = execution_error_cleanup(n, e, show_error=error_popups)
  507. if error_popups == False:
  508. raise e
  509. schema_solve_done.add(n)
  510. for conn in n.hierarchy_connections:
  511. if conn not in schema_solve_done and conn not in solve_layer:
  512. solve_layer.appendleft(conn)
  513. continue
  514. if unsolved_schema:
  515. raise RuntimeError("Failed to resolve all schema declarations")
  516. # I had a problem with this looping forever. I think it is resolved... but I don't know lol
  517. all_mantis_nodes = list(all_mantis_nodes.values())
  518. kept_mantis_node = {}
  519. while (all_mantis_nodes):
  520. mantis_node = all_mantis_nodes.pop()
  521. if mantis_node.node_type in ["DUMMY", 'SCHEMA', 'DUMMY_SCHEMA']:
  522. continue # screen out the ui_node schema nodes, group in/out, and group placeholders
  523. # cleanup autogen nodes
  524. if mantis_node.signature[0] == "MANTIS_AUTOGENERATED" and len(mantis_node.inputs) == 0 and len(mantis_node.outputs) == 1:
  525. from ..base_definitions import can_remove_socket_for_autogen
  526. output=list(mantis_node.outputs.values())[0]
  527. value=list(mantis_node.parameters.values())[0]
  528. # We can remove this node if it is safe to push it into the other node's socket.
  529. keep_me = False
  530. for l in output.links:
  531. to_node = l.to_node; to_socket = l.to_socket
  532. # do not remove the socket if it is a custom property.
  533. if not can_remove_socket_for_autogen(to_node, to_socket):
  534. keep_me = True; continue
  535. l.die()
  536. to_node.parameters[to_socket] = value
  537. del to_node.inputs[to_socket]
  538. init_dependencies(to_node) # to remove the autogen node we no longer need.
  539. if not keep_me:
  540. continue
  541. init_connections(mantis_node) # because we have removed many connections.
  542. if (mantis_node.node_type in ['XFORM']) and ("Relationship" in mantis_node.inputs.keys()):
  543. from ..utilities.node_common import GraphError
  544. try:
  545. if (new_mantis_node := insert_lazy_parents(mantis_node)):
  546. kept_mantis_node[new_mantis_node.signature]=new_mantis_node
  547. # be sure to add the Mantis context.
  548. new_mantis_node.mContext =mContext
  549. except GraphError as e:
  550. e = execution_error_cleanup(mantis_node, e, show_error=error_popups)
  551. if error_popups == False:
  552. raise e
  553. return # it is not possible to parse the tree.
  554. kept_mantis_node[mantis_node.signature]=mantis_node
  555. prWhite(f"Parsing tree took {time.time()-start_time} seconds.")
  556. prWhite("Number of Nodes: %s" % (len(kept_mantis_node)))
  557. return kept_mantis_node
  558. from ..utilities.utilities import switch_mode
  559. def error_popup_draw_inner(layout, exception, ui_sig = ()):
  560. node_string = f"See node: {ui_sig[1:]}." if ui_sig else ""
  561. message = f"Error: {exception}\n" + node_string
  562. lines = message.splitlines()
  563. for line in lines:
  564. layout.label(text=line)
  565. def execution_error_cleanup(node, exception, switch_objects = [], show_error=False ):
  566. from bpy import context
  567. ui_sig = None
  568. if show_error: # show a popup and select the relevant nodes
  569. if node:
  570. if node.mContext:
  571. if node.mContext.execution_failed==True:
  572. # already have an error, pass it to avoid printing
  573. return # a second error (it's confusing to users.)
  574. node.mContext.execution_failed=True
  575. ui_sig = node.ui_signature
  576. # TODO: see about zooming-to-node.
  577. base_tree = node.base_tree
  578. tree = base_tree
  579. try:
  580. for name in ui_sig[1:]:
  581. for n in tree.nodes: n.select = False
  582. n = tree.nodes[name]
  583. n.select = True
  584. tree.nodes.active = n
  585. if hasattr(n, "node_tree"):
  586. tree = n.node_tree
  587. except AttributeError: # not being run in node graph
  588. pass
  589. finally:
  590. def error_popup_draw(self, context):
  591. error_popup_draw_inner(self.layout, exception, ui_sig)
  592. context.window_manager.popup_menu(error_popup_draw, title="Error", icon='ERROR')
  593. switch_mode(mode='OBJECT', objects=switch_objects)
  594. for ob in switch_objects:
  595. ob.data.pose_position = 'POSE'
  596. prRed(f"Error: {exception} in node {ui_sig}")
  597. return exception
  598. def print_cycle(nodes):
  599. ret_str = ""
  600. for node in nodes:
  601. ret_str+= node.__repr__() + '\n'
  602. return ret_str
  603. def sort_execution(nodes, error_popups):
  604. from ..utilities.node_common import GraphError
  605. from collections import deque
  606. xForm_pass = deque()
  607. execution_failed = False
  608. sorted_nodes = []
  609. # initialize the hierarchy dependency count. We'll use this to ensure there
  610. # are no cycles (using Kahn's algorithm).
  611. expected_sort_quantity = len(nodes)
  612. for mantis_node in nodes.values():
  613. if mantis_node.node_type in ['DUMMY', 'DUMMY_SCHEMA', 'INTERFACE']:
  614. expected_sort_quantity -=1 ; continue
  615. if mantis_node.is_schema_prototype:
  616. expected_sort_quantity -= 1; continue
  617. mantis_node.unmet_hierarchy_dependency_count = len(mantis_node.hierarchy_dependencies)
  618. if mantis_node.unmet_hierarchy_dependency_count == 0 :
  619. xForm_pass.append(mantis_node)
  620. processed_count = 0
  621. while(xForm_pass):
  622. n = xForm_pass.pop()
  623. # if n.execution_prepared: continue
  624. n.execution_prepared = True
  625. sorted_nodes.append(n)
  626. processed_count+=1
  627. for child in n.hierarchy_connections:
  628. child.unmet_hierarchy_dependency_count-= 1
  629. if child.unmet_hierarchy_dependency_count == 0:
  630. xForm_pass.append(child)
  631. if processed_count < expected_sort_quantity:
  632. cycle = []
  633. for n in nodes.values():
  634. if n.execution_prepared == False:
  635. cycle.append(n)
  636. execution_failed = True
  637. e = GraphError("Detected a cycle in the tree, containing at "
  638. "least one of the following nodes: " + print_cycle(cycle))
  639. e = execution_error_cleanup(cycle[-1], e, show_error=error_popups)
  640. prRed(processed_count, expected_sort_quantity)
  641. raise e
  642. return sorted_nodes, execution_failed
  643. def execute_tree(nodes, base_tree, context, error_popups = False, profile=False):
  644. assert nodes is not None, "Failed to parse tree."
  645. assert len(nodes) > 0, "No parsed nodes for execution."\
  646. " Mantis probably failed to parse the tree."
  647. import bpy
  648. from time import time
  649. original_active = context.view_layer.objects.active
  650. start_execution_time = time()
  651. mContext = None
  652. for mantis_node in nodes.values():
  653. if not mContext: # just grab one of these. this is a silly way to do this.
  654. mContext = mantis_node.mContext
  655. mContext.b_objects = {} # clear the objects and recreate them
  656. mantis_node.reset_execution()
  657. mContext.execution_failed = False
  658. interface_nodes = {}
  659. from ..internal_nodes import GroupInterface
  660. for node in nodes.values():
  661. if isinstance(node, GroupInterface):
  662. interface_nodes[node.signature] = node
  663. overlay_tagged_nodes = {}
  664. for node_signature, socket_id in mContext.tagged_for_overlay:
  665. if overlay_tagged_nodes.get(node_signature):
  666. overlay_tagged_nodes[node_signature].append(socket_id)
  667. else:
  668. overlay_tagged_nodes[node_signature] = [socket_id]
  669. def check_and_apply_overlay(n):
  670. if overlays_for_this_node := overlay_tagged_nodes.get(n.signature):
  671. for socket_id in overlays_for_this_node:
  672. node_scan_overlays(n, socket_id,)
  673. select_me, switch_me = [], [] # switch the mode on these objects
  674. active = None # only need it for switching modes
  675. select_me = []
  676. profiler = None
  677. if profile:
  678. from ..dev_helpers.profile_nodes import NodeProfiler
  679. profiler = NodeProfiler()
  680. profiler.new_session(mContext.execution_id)
  681. sort_key = 'total'
  682. try:
  683. sorted_nodes, execution_failed = sort_execution(nodes, error_popups=error_popups)
  684. except Exception as e:
  685. # We'll fire the popup in sort_execution because it has the node in scope
  686. if error_popups == False:
  687. raise e
  688. execution_failed = True
  689. try:
  690. for n in sorted_nodes:
  691. if execution_failed: break
  692. try:
  693. check_and_apply_overlay(n)
  694. if not n.prepared:
  695. if profiler: profiler.record(n, "bPrepare", context)
  696. else: n.bPrepare(context)
  697. if not n.executed:
  698. if profiler: profiler.record(n, "bTransformPass", context)
  699. else: n.bTransformPass(context)
  700. if (n.__class__.__name__ == "xFormArmature" ):
  701. ob = n.bGetObject()
  702. switch_me.append(ob)
  703. active = ob
  704. if not (n.__class__.__name__ == "xFormBone" ) and hasattr(n, "bGetObject"):
  705. ob = n.bGetObject()
  706. if isinstance(ob, bpy.types.Object):
  707. select_me.append(ob)
  708. except Exception as e:
  709. e = execution_error_cleanup(n, e, show_error=error_popups)
  710. if error_popups == False:
  711. raise e
  712. execution_failed = True; break
  713. switch_mode(mode='POSE', objects=switch_me)
  714. for n in sorted_nodes:
  715. try:
  716. check_and_apply_overlay(n)
  717. if not n.prepared:
  718. if profiler: profiler.record(n, "bPrepare", context)
  719. else: n.bPrepare(context)
  720. if not n.executed:
  721. if profiler: profiler.record(n, "bRelationshipPass", context)
  722. else: n.bRelationshipPass(context)
  723. except Exception as e:
  724. e = execution_error_cleanup(n, e, show_error=error_popups)
  725. if error_popups == False:
  726. raise e
  727. execution_failed = True; break
  728. switch_mode(mode='OBJECT', objects=switch_me)
  729. # switch to pose mode here so that the nodes can use the final pose data
  730. # this will require them to update the depsgraph.
  731. for ob in switch_me:
  732. ob.data.pose_position = 'POSE'
  733. for n in sorted_nodes:
  734. try:
  735. if profiler: profiler.record(n, "bFinalize", context)
  736. else: n.bFinalize(context)
  737. except Exception as e:
  738. e = execution_error_cleanup(n, e, show_error=error_popups)
  739. if error_popups == False:
  740. raise e
  741. execution_failed = True; break
  742. # REST pose for deformer bind, so everything is in the rest position
  743. for ob in switch_me:
  744. ob.data.pose_position = 'REST'
  745. # finally, apply modifiers and bind stuff
  746. for n in sorted_nodes:
  747. try:
  748. if profiler: profiler.record(n, "bModifierApply", context)
  749. else: n.bModifierApply(context)
  750. except Exception as e:
  751. e = execution_error_cleanup(n, e, show_error=error_popups)
  752. if error_popups == False:
  753. raise e
  754. execution_failed = True; break
  755. for ob in switch_me:
  756. ob.data.pose_position = 'POSE'
  757. tot_time = (time() - start_execution_time)
  758. if not execution_failed:
  759. prGreen(f"Executed tree of {len(sorted_nodes)} nodes in {tot_time} seconds")
  760. if profiler:
  761. from ..dev_helpers.profile_nodes import summarize_profile
  762. summarize_profile(profiler._current, pass_name='bPrepare', sort_key = sort_key)
  763. summarize_profile(profiler._current, pass_name='bTransformPass', sort_key = sort_key)
  764. summarize_profile(profiler._current, pass_name='bRelationshipPass', sort_key = sort_key)
  765. summarize_profile(profiler._current, pass_name='bFinalize', sort_key = sort_key)
  766. summarize_profile(profiler._current, pass_name='bModifierApply', sort_key = sort_key)
  767. if (original_active):
  768. context.view_layer.objects.active = original_active
  769. original_active.select_set(True)
  770. except Exception as e:
  771. e = execution_error_cleanup(None, e, switch_me, show_error=error_popups)
  772. if error_popups == False:
  773. raise e
  774. prRed(f"Failed to execute tree.")
  775. finally:
  776. context.view_layer.objects.active = active
  777. # clear the selection first.
  778. from itertools import chain
  779. for ob in context.selected_objects:
  780. try:
  781. ob.select_set(False)
  782. except RuntimeError: # it isn't in the view layer
  783. pass
  784. for ob in chain(select_me, mContext.b_objects.values()):
  785. try:
  786. ob.select_set(True)
  787. except RuntimeError: # it isn't in the view layer
  788. pass