link_containers.py 52 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227
  1. from .node_container_common import *
  2. from bpy.types import Bone, NodeTree
  3. from .base_definitions import MantisNode, GraphError, FLOAT_EPSILON
  4. from .base_definitions import MantisSocketTemplate as SockTemplate
  5. def TellClasses():
  6. return [
  7. # special
  8. LinkInherit,
  9. # copy
  10. LinkCopyLocation,
  11. LinkCopyRotation,
  12. LinkCopyScale,
  13. LinkCopyTransforms,
  14. LinkTransformation,
  15. # limit
  16. LinkLimitLocation,
  17. LinkLimitRotation,
  18. LinkLimitScale,
  19. LinkLimitDistance,
  20. # tracking
  21. LinkStretchTo,
  22. LinkDampedTrack,
  23. LinkLockedTrack,
  24. LinkTrackTo,
  25. #misc
  26. LinkInheritConstraint,
  27. LinkArmature,
  28. # IK
  29. LinkInverseKinematics,
  30. LinkSplineIK,
  31. # Drivers
  32. LinkDrivenParameter,
  33. ]
  34. # Socket Templates we will reuse:
  35. # inputs:
  36. InputRelationshipTemplate : SockTemplate = SockTemplate(
  37. name="Input Relationship", is_input=True, bl_idname='RelationshipSocket', )
  38. TargetTemplate : SockTemplate = SockTemplate(
  39. name="Target", is_input=True, bl_idname='xFormSocket', )
  40. Head_Tail_Template : SockTemplate = SockTemplate(
  41. name="Head/Tail", is_input=True, bl_idname='FloatFactorSocket',
  42. default_value=1.0, blender_property='head_tail' )
  43. UseBBoneTemplate : SockTemplate = SockTemplate(
  44. name="UseBBone", is_input=True, bl_idname='BooleanSocket',
  45. default_value=False, blender_property='use_bbone_shape' )
  46. AxeSockTemplate : SockTemplate = SockTemplate(
  47. name="Axes", is_input=True, bl_idname='BooleanThreeTupleSocket',
  48. default_value=[True, True, True], blender_property=['use_x', 'use_y', 'use_z'])
  49. AxesInvertTemplate : SockTemplate = SockTemplate(
  50. name="Invert", is_input=True, bl_idname='BooleanThreeTupleSocket',
  51. default_value=[False, False, False], blender_property=['invert_x', 'invert_y', 'invert_z'])
  52. TargetSpaceTemplate : SockTemplate = SockTemplate(
  53. name="Target Space", is_input=True, bl_idname='TransformSpaceSocket',
  54. default_value="WORLD", blender_property='target_space' )
  55. OwnerSpaceTemplate : SockTemplate = SockTemplate(
  56. name="Owner Space", is_input=True, bl_idname='TransformSpaceSocket',
  57. default_value="WORLD", blender_property='owner_space' )
  58. InfluenceTemplate : SockTemplate = SockTemplate(
  59. name="Influence", is_input=True, bl_idname='FloatFactorSocket',
  60. default_value=1.0, blender_property='influence')
  61. EnableTemplate : SockTemplate = SockTemplate(
  62. name="Enable", is_input=True, bl_idname='EnableSocket',
  63. default_value=True, blender_property='mute')
  64. OffsetTemplate : SockTemplate = SockTemplate(
  65. name="Offset", bl_idname='BooleanSocket', is_input=True,
  66. default_value=False, blender_property='use_offset')
  67. # Limit Constraints follow a pattern and can use this generator
  68. LimitTemplateGenerator = lambda name_stub, axis : SockTemplate(
  69. name=name_stub+axis.upper(), is_input=True, bl_idname='BooleanSocket' if "Use" in name_stub else "FloatSocket",
  70. default_value=False, blender_property=name_stub.lower().replace(' ', '_')+axis.lower())
  71. LimitAxesSocketTemplates = [] # could generate these with loops, but this is easier to understand
  72. LimitAxesSocketTemplates.append(UseMaxXTemplate := LimitTemplateGenerator("Use Max ", "X"))
  73. LimitAxesSocketTemplates.append(MaxXTemplate := LimitTemplateGenerator("Max ", "X"))
  74. LimitAxesSocketTemplates.append(UseMaxYTemplate := LimitTemplateGenerator("Use Max ", "Y"))
  75. LimitAxesSocketTemplates.append(MaxYTemplate := LimitTemplateGenerator("Max ", "Y"))
  76. LimitAxesSocketTemplates.append(UseMaxZTemplate := LimitTemplateGenerator("Use Max ", "Z"))
  77. LimitAxesSocketTemplates.append(MaxZTemplate := LimitTemplateGenerator("Min ", "Z"))
  78. LimitAxesSocketTemplates.append(UseMinXTemplate := LimitTemplateGenerator("Use Min ", "X"))
  79. LimitAxesSocketTemplates.append(MinXTemplate := LimitTemplateGenerator("Min ", "X"))
  80. LimitAxesSocketTemplates.append(UseMinYTemplate := LimitTemplateGenerator("Use Min ", "Y"))
  81. LimitAxesSocketTemplates.append(MinYTemplate := LimitTemplateGenerator("Min ", "Y"))
  82. LimitAxesSocketTemplates.append(UseMinZTemplate := LimitTemplateGenerator("Use Min ", "Z"))
  83. LimitAxesSocketTemplates.append(MinZTemplate := LimitTemplateGenerator("Min ", "Z"))
  84. LimitRotationSocketTemplates = [
  85. UseXTemplate := LimitTemplateGenerator("Use ", "X"),
  86. MaxXTemplate,
  87. MinXTemplate,
  88. UseYTemplate := LimitTemplateGenerator("Use ", "Y"),
  89. MaxYTemplate,
  90. MinYTemplate,
  91. UseZTemplate := LimitTemplateGenerator("Use ", "Z"),
  92. MaxZTemplate,
  93. MinZTemplate,
  94. ]
  95. # annoyingly these are a little different than the pattern:
  96. UseXTemplate.blender_property='use_limit_x'
  97. UseYTemplate.blender_property='use_limit_y'
  98. UseZTemplate.blender_property='use_limit_z'
  99. AffectTransformTemplate : SockTemplate = SockTemplate(
  100. name="Affect Transform", bl_idname='BooleanSocket', is_input=True,
  101. default_value=False, blender_property='use_transform_limit')
  102. # Tracking
  103. TrackAxisTemplate= SockTemplate(name="Track Axis", bl_idname="EnumTrackAxis",
  104. is_input=True, default_value='TRACK_Y', blender_property='track_axis')
  105. # outputs:
  106. OutputRelationshipTemplate : SockTemplate = SockTemplate(
  107. name="Output Relationship", is_input=False, bl_idname='RelationshipSocket', )
  108. # set the name if it is available, otherwise just use the constraint's nice name
  109. set_constraint_name = lambda nc : nc.evaluate_input("Name") if nc.evaluate_input("Name") else nc.__class__.__name__
  110. class MantisLinkNode(MantisNode):
  111. def __init__(self, signature : tuple,
  112. base_tree : NodeTree,
  113. socket_templates : list[SockTemplate]=[]):
  114. super().__init__(signature, base_tree, socket_templates)
  115. self.node_type = 'LINK'
  116. self.prepared = True
  117. def evaluate_input(self, input_name, index=0):
  118. # should catch 'Target', 'Pole Target' and ArmatureConstraint targets, too
  119. if ('Target' in input_name) and input_name not in ["Target Space", "Use Target Z"]:
  120. socket = self.inputs.get(input_name)
  121. if socket.is_linked:
  122. return socket.links[0].from_node
  123. return None
  124. else:
  125. return super().evaluate_input(input_name)
  126. def gen_property_socket_map(self) -> dict:
  127. props_sockets = super().gen_property_socket_map()
  128. if (os := self.inputs.get("Owner Space")) and os.is_connected and os.links[0].from_node.node_type == 'XFORM':
  129. del props_sockets['owner_space']
  130. if ts := self.inputs.get("Target_Space") and ts.is_connected and ts.links[0].from_node.node_type == 'XFORM':
  131. del props_sockets['target_space']
  132. return props_sockets
  133. def set_custom_space(self):
  134. c = self.bObject
  135. if (os := self.inputs.get("Owner Space")) and os.is_connected and os.links[0].from_node.node_type == 'XFORM':
  136. c.owner_space='CUSTOM'
  137. xf = self.inputs["Owner Space"].links[0].from_node.bGetObject(mode="OBJECT")
  138. if isinstance(xf, Bone):
  139. c.space_object=self.inputs["Owner Space"].links[0].from_node.bGetParentArmature(); c.space_subtarget=xf.name
  140. else:
  141. c.space_object=xf
  142. if ts := self.inputs.get("Target_Space") and ts.is_connected and ts.links[0].from_node.node_type == 'XFORM':
  143. c.owner_space='CUSTOM'
  144. xf = self.inputs["Target_Space Space"].links[0].from_node.bGetObject(mode="OBJECT")
  145. if isinstance(xf, Bone):
  146. c.space_object=self.inputs["Target_Space Space"].links[0].from_node.bGetParentArmature(); c.space_subtarget=xf.name
  147. else:
  148. c.space_object=xf
  149. def bFinalize(self, bContext=None):
  150. finish_drivers(self)
  151. #*#-------------------------------#++#-------------------------------#*#
  152. # L I N K N O D E S
  153. #*#-------------------------------#++#-------------------------------#*#
  154. def GetxForm(nc):
  155. trace = trace_single_line_up(nc, "Output Relationship")
  156. for node in trace[0]:
  157. if (node.node_type == 'XFORM'):
  158. return node
  159. raise GraphError("%s is not connected to a downstream xForm" % nc)
  160. LinkInheritSockets = [
  161. SockTemplate(name="Inherit Rotation", is_input=True,
  162. bl_idname='BooleanSocket', default_value=True,),
  163. SockTemplate(name="Inherit Scale", is_input=True,
  164. bl_idname='EnumInheritScale', default_value="FULL",),
  165. SockTemplate(name="Connected", is_input=True,
  166. bl_idname='BooleanSocket', default_value=False,),
  167. SockTemplate(name="Parent", is_input=True, bl_idname='xFormSocket',),
  168. SockTemplate(name="Inheritance", is_input=False, bl_idname='RelationshipSocket',),
  169. ]
  170. class LinkInherit(MantisLinkNode):
  171. '''A node representing inheritance'''
  172. def __init__(self, signature, base_tree):
  173. super().__init__(signature, base_tree, LinkInheritSockets)
  174. self.init_parameters()
  175. self.set_traverse([('Parent', 'Inheritance')])
  176. self.executed = True
  177. def GetxForm(self): # DUPLICATED, TODO fix this
  178. # I think this is only run in display update.
  179. trace = trace_single_line_up(self, "Inheritance")
  180. for node in trace[0]:
  181. if (node.node_type == 'XFORM'):
  182. return node
  183. raise GraphError("%s is not connected to a downstream xForm" % self)
  184. LinkCopyLocationSockets = [
  185. InputRelationshipTemplate,
  186. Head_Tail_Template,
  187. UseBBoneTemplate,
  188. AxeSockTemplate,
  189. AxesInvertTemplate,
  190. TargetSpaceTemplate,
  191. OwnerSpaceTemplate,
  192. OffsetTemplate,
  193. InfluenceTemplate,
  194. TargetTemplate,
  195. EnableTemplate,
  196. OutputRelationshipTemplate,
  197. ]
  198. class LinkCopyLocation(MantisLinkNode):
  199. '''A node representing Copy Location'''
  200. def __init__(self, signature : tuple,
  201. base_tree : NodeTree,):
  202. super().__init__(signature, base_tree, LinkCopyLocationSockets)
  203. additional_parameters = { "Name":None }
  204. self.init_parameters(additional_parameters=additional_parameters)
  205. self.set_traverse([("Input Relationship", "Output Relationship")])
  206. def GetxForm(self):
  207. return GetxForm(self)
  208. def bExecute(self, context):
  209. prepare_parameters(self)
  210. c = self.GetxForm().bGetObject().constraints.new('COPY_LOCATION')
  211. self.get_target_and_subtarget(c)
  212. print(wrapGreen("Creating ")+wrapWhite("Copy Location")+
  213. wrapGreen(" Constraint for bone: ") +
  214. wrapOrange(self.GetxForm().bGetObject().name))
  215. if constraint_name := self.evaluate_input("Name"):
  216. c.name = constraint_name
  217. self.bObject = c
  218. self.set_custom_space()
  219. props_sockets = self.gen_property_socket_map()
  220. evaluate_sockets(self, c, props_sockets)
  221. self.executed = True
  222. LinkCopyRotationSockets = [
  223. InputRelationshipTemplate,
  224. SockTemplate(name='RotationOrder', bl_idname='RotationOrderSocket', is_input=True,
  225. default_value='AUTO', blender_property='euler_order'),
  226. SockTemplate(name='Rotation Mix', bl_idname='EnumRotationMix', is_input=True,
  227. default_value='REPLACE', blender_property='mix_mode'),
  228. AxeSockTemplate,
  229. AxesInvertTemplate,
  230. TargetSpaceTemplate,
  231. OwnerSpaceTemplate,
  232. InfluenceTemplate,
  233. TargetTemplate,
  234. EnableTemplate,
  235. OutputRelationshipTemplate,
  236. ]
  237. class LinkCopyRotation(MantisLinkNode):
  238. '''A node representing Copy Rotation'''
  239. def __init__(self, signature, base_tree):
  240. super().__init__(signature, base_tree, LinkCopyRotationSockets)
  241. additional_parameters = { "Name":None }
  242. self.init_parameters(additional_parameters=additional_parameters)
  243. self.set_traverse([("Input Relationship", "Output Relationship")])
  244. def GetxForm(self):
  245. return GetxForm(self)
  246. def bExecute(self, context):
  247. prepare_parameters(self)
  248. c = self.GetxForm().bGetObject().constraints.new('COPY_ROTATION')
  249. self.get_target_and_subtarget(c)
  250. print(wrapGreen("Creating ")+wrapWhite("Copy Rotation")+
  251. wrapGreen(" Constraint for bone: ") +
  252. wrapOrange(self.GetxForm().bGetObject().name))
  253. rotation_order = self.evaluate_input("RotationOrder")
  254. if ((rotation_order == 'QUATERNION') or (rotation_order == 'AXIS_ANGLE')):
  255. c.euler_order = 'AUTO'
  256. else:
  257. try:
  258. c.euler_order = rotation_order
  259. except TypeError: # it's a driver or incorrect
  260. c.euler_order = 'AUTO'
  261. if constraint_name := self.evaluate_input("Name"):
  262. c.name = constraint_name
  263. self.bObject = c
  264. self.set_custom_space()
  265. props_sockets = self.gen_property_socket_map()
  266. evaluate_sockets(self, c, props_sockets)
  267. self.executed = True
  268. LinkCopyScaleSockets = [
  269. InputRelationshipTemplate,
  270. OffsetTemplate,
  271. SockTemplate(name='Average', bl_idname = 'BooleanSocket', is_input=True,
  272. default_value=False, blender_property='use_make_uniform'),
  273. SockTemplate(name='Additive', bl_idname = 'BooleanSocket', is_input=True,
  274. default_value=False, blender_property='use_add'),
  275. AxeSockTemplate,
  276. TargetSpaceTemplate,
  277. OwnerSpaceTemplate,
  278. InfluenceTemplate,
  279. TargetTemplate,
  280. EnableTemplate,
  281. OutputRelationshipTemplate,
  282. ]
  283. class LinkCopyScale(MantisLinkNode):
  284. '''A node representing Copy Scale'''
  285. def __init__(self, signature, base_tree):
  286. super().__init__(signature, base_tree, LinkCopyScaleSockets)
  287. additional_parameters = { "Name":None }
  288. self.init_parameters(additional_parameters=additional_parameters)
  289. self.set_traverse([("Input Relationship", "Output Relationship")])
  290. def GetxForm(self):
  291. return GetxForm(self)
  292. def bExecute(self, context):
  293. prepare_parameters(self)
  294. c = self.GetxForm().bGetObject().constraints.new('COPY_SCALE')
  295. self.get_target_and_subtarget(c)
  296. print(wrapGreen("Creating ")+wrapWhite("Copy Scale")+
  297. wrapGreen(" Constraint for bone: ") +
  298. wrapOrange(self.GetxForm().bGetObject().name))
  299. if constraint_name := self.evaluate_input("Name"):
  300. c.name = constraint_name
  301. self.bObject = c
  302. if self.inputs["Owner Space"].is_connected and self.inputs["Owner Space"].links[0].from_node.node_type == 'XFORM':
  303. c.owner_space='CUSTOM'
  304. xf = self.inputs["Owner Space"].links[0].from_node.bGetObject(mode="OBJECT")
  305. if isinstance(xf, Bone):
  306. c.space_object=self.inputs["Owner Space"].links[0].from_node.bGetParentArmature(); c.space_subtarget=xf.name
  307. else:
  308. c.space_object=xf
  309. if self.inputs["Target Space"].is_connected and self.inputs["Target Space"].links[0].from_node.node_type == 'XFORM':
  310. c.target_space='CUSTOM'
  311. xf = self.inputs["Target Space"].links[0].from_node.bGetObject(mode="OBJECT")
  312. if isinstance(xf, Bone):
  313. c.space_object=self.inputs["Owner Space"].links[0].from_node.bGetParentArmature(); c.space_subtarget=xf.name
  314. else:
  315. c.space_object=xf
  316. props_sockets = self.gen_property_socket_map()
  317. evaluate_sockets(self, c, props_sockets)
  318. self.executed = True
  319. LinkCopyTransformsSockets = [
  320. InputRelationshipTemplate,
  321. Head_Tail_Template,
  322. UseBBoneTemplate,
  323. SockTemplate(name='Mix', bl_idname = 'EnumRotationMixCopyTransforms', is_input=True,
  324. default_value="REPLACE", blender_property='mix_mode'),
  325. TargetSpaceTemplate,
  326. OwnerSpaceTemplate,
  327. InfluenceTemplate,
  328. TargetTemplate,
  329. EnableTemplate,
  330. OutputRelationshipTemplate,
  331. ]
  332. class LinkCopyTransforms(MantisLinkNode):
  333. '''A node representing Copy Transfoms'''
  334. def __init__(self, signature, base_tree):
  335. super().__init__(signature, base_tree, LinkCopyTransformsSockets)
  336. additional_parameters = { "Name":None }
  337. self.init_parameters(additional_parameters=additional_parameters)
  338. self.set_traverse([("Input Relationship", "Output Relationship")])
  339. def GetxForm(self):
  340. return GetxForm(self)
  341. def bExecute(self, context):
  342. prepare_parameters(self)
  343. c = self.GetxForm().bGetObject().constraints.new('COPY_TRANSFORMS')
  344. self.get_target_and_subtarget(c)
  345. print(wrapGreen("Creating ")+wrapWhite("Copy Transforms")+
  346. wrapGreen(" Constraint for bone: ") +
  347. wrapOrange(self.GetxForm().bGetObject().name))
  348. if constraint_name := self.evaluate_input("Name"):
  349. c.name = constraint_name
  350. self.bObject = c
  351. self.set_custom_space()
  352. props_sockets = self.gen_property_socket_map()
  353. evaluate_sockets(self, c, props_sockets)
  354. self.executed = True
  355. TransformationMinMaxTemplateGenerator = lambda name, bprop : SockTemplate(
  356. name=name, is_input=True,
  357. bl_idname='EnumTransformationAxes' if "Source" in name else "FloatSocket",
  358. default_value=False, blender_property=bprop)
  359. LinkTransformationSockets = [
  360. InputRelationshipTemplate,
  361. TargetTemplate,
  362. OwnerSpaceTemplate,
  363. TargetSpaceTemplate,
  364. SockTemplate(name="Extrapolate", is_input=True, bl_idname='BooleanSocket',
  365. default_value=False, blender_property='use_motion_extrapolate'),
  366. SockTemplate(name="Map From", is_input=True, bl_idname='EnumTransformationMap',
  367. default_value="LOCATION", blender_property='map_from'),
  368. SockTemplate(name="Rotation Mode", is_input=True, bl_idname='EnumTransformationRotationMode',
  369. default_value="AUTO", blender_property='from_rotation_mode', hide=True),
  370. TransformationMinMaxTemplateGenerator("X Min From", "from_min_x"),
  371. TransformationMinMaxTemplateGenerator("X Max From", "from_max_x"),
  372. TransformationMinMaxTemplateGenerator("Y Min From", "from_min_y"),
  373. TransformationMinMaxTemplateGenerator("Y Max From", "from_max_y"),
  374. TransformationMinMaxTemplateGenerator("Z Min From", "from_min_z"),
  375. TransformationMinMaxTemplateGenerator("Z Max From", "from_max_z"),
  376. SockTemplate(name="Map To", is_input=True, bl_idname='EnumTransformationMap',
  377. default_value="LOCATION", blender_property='map_to'),
  378. SockTemplate(name="Rotation Order", is_input=True, bl_idname='EnumTransformationRotationOrder',
  379. default_value="AUTO", blender_property='to_euler_order', hide=True),
  380. TransformationMinMaxTemplateGenerator("X Source Axis", "map_to_x_from"),
  381. TransformationMinMaxTemplateGenerator("X Min To", "to_min_x"),
  382. TransformationMinMaxTemplateGenerator("X Max To", "to_max_x"),
  383. TransformationMinMaxTemplateGenerator("Y Source Axis", "map_to_y_from"),
  384. TransformationMinMaxTemplateGenerator("Y Min To", "to_min_y"),
  385. TransformationMinMaxTemplateGenerator("Y Max To", "to_max_y"),
  386. TransformationMinMaxTemplateGenerator("Z Source Axis", "map_to_z_from"),
  387. TransformationMinMaxTemplateGenerator("Z Min To", "to_min_z"),
  388. TransformationMinMaxTemplateGenerator("Z Max To", "to_max_z"),
  389. SockTemplate(name="Mix Mode (Translation)", is_input=True,
  390. bl_idname='EnumTransformationTranslationMixMode',
  391. default_value="ADD", blender_property='mix_mode',),
  392. SockTemplate(name="Mix Mode (Translation)", is_input=True,
  393. bl_idname='EnumTransformationRotationMixMode',
  394. default_value="ADD", blender_property='mix_mode_rot', hide=True),
  395. SockTemplate(name="Mix Mode (Translation)", is_input=True,
  396. bl_idname='EnumTransformationScaleMixMode',
  397. default_value="REPLACE", blender_property='mix_mode_scale', hide=True),
  398. InfluenceTemplate,
  399. EnableTemplate,
  400. OutputRelationshipTemplate,
  401. ]
  402. class LinkTransformation(MantisLinkNode):
  403. '''A node representing Copy Transfoms'''
  404. def __init__(self, signature, base_tree):
  405. super().__init__(signature, base_tree, LinkTransformationSockets)
  406. self.init_parameters(additional_parameters={"Name":None })
  407. self.set_traverse([("Input Relationship", "Output Relationship")])
  408. def GetxForm(self):
  409. return GetxForm(self)
  410. def bExecute(self, context):
  411. prepare_parameters(self)
  412. c = self.GetxForm().bGetObject().constraints.new('TRANSFORM')
  413. self.get_target_and_subtarget(c)
  414. print(wrapGreen("Creating ")+wrapWhite("Transformation")+
  415. wrapGreen(" Constraint for bone: ") +
  416. wrapOrange(self.GetxForm().bGetObject().name))
  417. if constraint_name := self.evaluate_input("Name"):
  418. c.name = constraint_name
  419. self.bObject = c
  420. self.set_custom_space()
  421. props_sockets = self.gen_property_socket_map()
  422. evaluate_sockets(self, c, props_sockets)
  423. self.executed = True
  424. LinkLimitLocationScaleSockets = [
  425. InputRelationshipTemplate,
  426. *LimitAxesSocketTemplates, # we generated these ahead of time in a list
  427. AffectTransformTemplate,
  428. OwnerSpaceTemplate,
  429. InfluenceTemplate,
  430. EnableTemplate,
  431. OutputRelationshipTemplate,
  432. ]
  433. class LinkLimitLocation(MantisLinkNode):
  434. def __init__(self, signature, base_tree):
  435. super().__init__(signature, base_tree, LinkLimitLocationScaleSockets)
  436. self.init_parameters(additional_parameters={ "Name":None })
  437. self.set_traverse([("Input Relationship", "Output Relationship")])
  438. def GetxForm(self):
  439. return GetxForm(self)
  440. def bExecute(self, context):
  441. prepare_parameters(self)
  442. c = self.GetxForm().bGetObject().constraints.new('LIMIT_LOCATION')
  443. #
  444. print(wrapGreen("Creating ")+wrapWhite("Limit Location")+
  445. wrapGreen(" Constraint for bone: ") +
  446. wrapOrange(self.GetxForm().bGetObject().name))
  447. if constraint_name := self.evaluate_input("Name"):
  448. c.name = constraint_name
  449. self.bObject = c
  450. self.set_custom_space()
  451. props_sockets = self.gen_property_socket_map()
  452. evaluate_sockets(self, c, props_sockets)
  453. self.executed = True
  454. LinkLimitRotationSockets = [
  455. InputRelationshipTemplate,
  456. *LimitRotationSocketTemplates, # we generated these ahead of time in a list
  457. AffectTransformTemplate,
  458. OwnerSpaceTemplate,
  459. InfluenceTemplate,
  460. EnableTemplate,
  461. OutputRelationshipTemplate,
  462. ]
  463. class LinkLimitRotation(MantisLinkNode):
  464. def __init__(self, signature, base_tree):
  465. super().__init__(signature, base_tree, LinkLimitRotationSockets)
  466. self.init_parameters(additional_parameters={ "Name":None })
  467. self.set_traverse([("Input Relationship", "Output Relationship")])
  468. def GetxForm(self):
  469. return GetxForm(self)
  470. def bExecute(self, context):
  471. prepare_parameters(self)
  472. c = self.GetxForm().bGetObject().constraints.new('LIMIT_ROTATION')
  473. print(wrapGreen("Creating ")+wrapWhite("Limit Rotation")+
  474. wrapGreen(" Constraint for bone: ") +
  475. wrapOrange(self.GetxForm().bGetObject().name))
  476. if constraint_name := self.evaluate_input("Name"):
  477. c.name = constraint_name
  478. self.bObject = c
  479. self.set_custom_space()
  480. props_sockets = self.gen_property_socket_map()
  481. evaluate_sockets(self, c, props_sockets)
  482. self.executed = True
  483. LinkLimitLocationScaleSockets = [
  484. InputRelationshipTemplate,
  485. *LimitAxesSocketTemplates, # we generated these ahead of time in a list
  486. AffectTransformTemplate,
  487. OwnerSpaceTemplate,
  488. InfluenceTemplate,
  489. EnableTemplate,
  490. OutputRelationshipTemplate,
  491. ]
  492. class LinkLimitScale(MantisLinkNode):
  493. def __init__(self, signature, base_tree):
  494. super().__init__(signature, base_tree, LinkLimitLocationScaleSockets)
  495. self.init_parameters(additional_parameters={ "Name":None })
  496. self.set_traverse([("Input Relationship", "Output Relationship")])
  497. def GetxForm(self):
  498. return GetxForm(self)
  499. def bExecute(self, context):
  500. prepare_parameters(self)
  501. c = self.GetxForm().bGetObject().constraints.new('LIMIT_SCALE')
  502. print(wrapGreen("Creating ")+wrapWhite("Limit Scale")+
  503. wrapGreen(" Constraint for bone: ") +
  504. wrapOrange(self.GetxForm().bGetObject().name))
  505. if constraint_name := self.evaluate_input("Name"):
  506. c.name = constraint_name
  507. self.bObject = c
  508. self.set_custom_space()
  509. props_sockets = self.gen_property_socket_map()
  510. evaluate_sockets(self, c, props_sockets)
  511. self.executed = True
  512. LinkLimitDistanceSockets = [
  513. InputRelationshipTemplate,
  514. Head_Tail_Template,
  515. UseBBoneTemplate,
  516. SockTemplate(name="Distance", bl_idname='FloatSocket', is_input=True,
  517. default_value=0.0, blender_property='distance'),
  518. SockTemplate(name="Clamp Region", bl_idname="EnumLimitMode", is_input=True,
  519. default_value='LIMITDIST_INSIDE', blender_property='limit_mode'),
  520. AffectTransformTemplate,
  521. InfluenceTemplate,
  522. TargetTemplate,
  523. EnableTemplate,
  524. OutputRelationshipTemplate,
  525. ]
  526. class LinkLimitDistance(MantisLinkNode):
  527. def __init__(self, signature, base_tree):
  528. super().__init__(signature, base_tree, LinkLimitDistanceSockets)
  529. self.init_parameters(additional_parameters={ "Name":None })
  530. self.set_traverse([("Input Relationship", "Output Relationship")])
  531. def GetxForm(self):
  532. return GetxForm(self)
  533. def bExecute(self, context):
  534. prepare_parameters(self)
  535. print(wrapGreen("Creating ")+wrapWhite("Limit Distance")+
  536. wrapGreen(" Constraint for bone: ") +
  537. wrapOrange(self.GetxForm().bGetObject().name))
  538. c = self.GetxForm().bGetObject().constraints.new('LIMIT_DISTANCE')
  539. self.get_target_and_subtarget(c)
  540. if constraint_name := self.evaluate_input("Name"):
  541. c.name = constraint_name
  542. self.bObject = c
  543. self.set_custom_space()
  544. props_sockets = self.gen_property_socket_map()
  545. evaluate_sockets(self, c, props_sockets)
  546. self.executed = True
  547. # Tracking
  548. LinkStretchToSockets = [
  549. InputRelationshipTemplate,
  550. Head_Tail_Template,
  551. UseBBoneTemplate,
  552. SockTemplate(name="Original Length", bl_idname='FloatSocket', is_input=True,
  553. default_value=0.0, blender_property='rest_length'),
  554. SockTemplate(name="Volume Variation", bl_idname='FloatSocket', is_input=True,
  555. default_value=1.0, blender_property='bulge'),
  556. SockTemplate(name="Use Volume Min", bl_idname='BoolUpdateParentNode', is_input=True,
  557. default_value=False, blender_property='use_bulge_min'),
  558. SockTemplate(name="Volume Min", bl_idname='FloatSocket', is_input=True,
  559. default_value=1.0, blender_property='bulge_min'),
  560. SockTemplate(name="Use Volume Max", bl_idname='BoolUpdateParentNode', is_input=True,
  561. default_value=False, blender_property='use_bulge_max'),
  562. SockTemplate(name="Volume Max", bl_idname='FloatSocket', is_input=True,
  563. default_value=1.0, blender_property='bulge_max'),
  564. SockTemplate(name="Smooth", bl_idname='FloatFactorSocket', is_input=True,
  565. default_value=0.0, blender_property='bulge_smooth'),
  566. SockTemplate(name="Maintain Volume", bl_idname='EnumMaintainVolumeStretchToSocket', is_input=True,
  567. default_value="VOLUME_XZX", blender_property='volume'),
  568. SockTemplate(name="Rotation", bl_idname='EnumRotationStretchTo', is_input=True,
  569. default_value="SWING_Y", blender_property='keep_axis'),
  570. InfluenceTemplate,
  571. TargetTemplate,
  572. EnableTemplate,
  573. OutputRelationshipTemplate,
  574. ]
  575. class LinkStretchTo(MantisLinkNode):
  576. def __init__(self, signature, base_tree):
  577. super().__init__(signature, base_tree, LinkStretchToSockets)
  578. self.init_parameters(additional_parameters={ "Name":None })
  579. self.set_traverse([("Input Relationship", "Output Relationship")])
  580. def GetxForm(self):
  581. return GetxForm(self)
  582. def bExecute(self, context):
  583. prepare_parameters(self)
  584. print(wrapGreen("Creating ")+wrapWhite("Stretch-To")+
  585. wrapGreen(" Constraint for bone: ") +
  586. wrapOrange(self.GetxForm().bGetObject().name))
  587. c = self.GetxForm().bGetObject().constraints.new('STRETCH_TO')
  588. self.get_target_and_subtarget(c)
  589. if constraint_name := self.evaluate_input("Name"):
  590. c.name = constraint_name
  591. self.bObject = c
  592. props_sockets = self.gen_property_socket_map()
  593. evaluate_sockets(self, c, props_sockets)
  594. if (self.evaluate_input("Original Length") == 0):
  595. # this is meant to be set automatically.
  596. c.rest_length = self.GetxForm().bGetObject().bone.length
  597. self.executed = True
  598. LinkDampedTrackSockets =[
  599. InputRelationshipTemplate,
  600. Head_Tail_Template,
  601. UseBBoneTemplate,
  602. TrackAxisTemplate,
  603. InfluenceTemplate,
  604. TargetTemplate,
  605. EnableTemplate,
  606. OutputRelationshipTemplate,
  607. ]
  608. class LinkDampedTrack(MantisLinkNode):
  609. def __init__(self, signature, base_tree):
  610. super().__init__(signature, base_tree, LinkDampedTrackSockets)
  611. self.init_parameters(additional_parameters={ "Name":None })
  612. self.set_traverse([("Input Relationship", "Output Relationship")])
  613. def GetxForm(self):
  614. return GetxForm(self)
  615. def bExecute(self, context):
  616. prepare_parameters(self)
  617. print(wrapGreen("Creating ")+wrapWhite("Damped Track")+
  618. wrapGreen(" Constraint for bone: ") +
  619. wrapOrange(self.GetxForm().bGetObject().name))
  620. c = self.GetxForm().bGetObject().constraints.new('DAMPED_TRACK')
  621. self.get_target_and_subtarget(c)
  622. if constraint_name := self.evaluate_input("Name"):
  623. c.name = constraint_name
  624. self.bObject = c
  625. props_sockets = self.gen_property_socket_map()
  626. evaluate_sockets(self, c, props_sockets)
  627. self.executed = True
  628. LinkLockedTrackSockets =[
  629. InputRelationshipTemplate,
  630. Head_Tail_Template,
  631. UseBBoneTemplate,
  632. TrackAxisTemplate,
  633. SockTemplate(name="Lock Axis", bl_idname="EnumLockAxis", is_input=True,
  634. default_value="LOCK_Z", blender_property='lock_axis'),
  635. InfluenceTemplate,
  636. TargetTemplate,
  637. EnableTemplate,
  638. OutputRelationshipTemplate,
  639. ]
  640. class LinkLockedTrack(MantisLinkNode):
  641. def __init__(self, signature, base_tree):
  642. super().__init__(signature, base_tree,LinkLockedTrackSockets)
  643. self.init_parameters(additional_parameters={"Name":None })
  644. self.set_traverse([("Input Relationship", "Output Relationship")])
  645. def GetxForm(self):
  646. return GetxForm(self)
  647. def bExecute(self, context):
  648. prepare_parameters(self)
  649. print(wrapGreen("Creating ")+wrapWhite("Locked Track")+
  650. wrapGreen(" Constraint for bone: ") +
  651. wrapOrange(self.GetxForm().bGetObject().name))
  652. c = self.GetxForm().bGetObject().constraints.new('LOCKED_TRACK')
  653. self.get_target_and_subtarget(c)
  654. if constraint_name := self.evaluate_input("Name"):
  655. c.name = constraint_name
  656. self.bObject = c
  657. props_sockets = self.gen_property_socket_map()
  658. evaluate_sockets(self, c, props_sockets)
  659. self.executed = True
  660. # NOTE: I am setting different default values here than Blender in order to remain
  661. # consistent with the track constraints tracking the bone to the target.
  662. LinkTrackToSockets = [
  663. InputRelationshipTemplate,
  664. Head_Tail_Template,
  665. UseBBoneTemplate,
  666. TrackAxisTemplate,
  667. SockTemplate(name="Up Axis", bl_idname="EnumUpAxis", is_input=True,
  668. default_value="UP_Z", blender_property='up_axis'),
  669. SockTemplate(name="Use Target Z", bl_idname="BooleanSocket", is_input=True,
  670. default_value=False, blender_property='use_target_z'),
  671. InfluenceTemplate,
  672. TargetTemplate,
  673. EnableTemplate,
  674. OutputRelationshipTemplate,
  675. ]
  676. class LinkTrackTo(MantisLinkNode):
  677. def __init__(self, signature, base_tree):
  678. super().__init__(signature, base_tree, LinkTrackToSockets)
  679. self.init_parameters(additional_parameters={"Name":None })
  680. self.set_traverse([("Input Relationship", "Output Relationship")])
  681. def GetxForm(self):
  682. return GetxForm(self)
  683. def bExecute(self, context):
  684. prepare_parameters(self)
  685. print(wrapGreen("Creating ")+wrapWhite("Track-To")+
  686. wrapGreen(" Constraint for bone: ") +
  687. wrapOrange(self.GetxForm().bGetObject().name))
  688. c = self.GetxForm().bGetObject().constraints.new('TRACK_TO')
  689. self.get_target_and_subtarget(c)
  690. if constraint_name := self.evaluate_input("Name"):
  691. c.name = constraint_name
  692. self.bObject = c
  693. props_sockets = self.gen_property_socket_map()
  694. evaluate_sockets(self, c, props_sockets)
  695. self.executed = True
  696. # relationships & misc.
  697. LinkInheritConstraintSockets = [
  698. InputRelationshipTemplate,
  699. SockTemplate(name="Location", bl_idname='BooleanThreeTupleSocket',
  700. is_input=True, default_value=[True, True, True],
  701. blender_property=['use_location_x', 'use_location_y', 'use_location_z']),
  702. SockTemplate(name="Rotation", bl_idname='BooleanThreeTupleSocket',
  703. is_input=True, default_value=[True, True, True],
  704. blender_property=['use_rotation_x', 'use_rotation_y', 'use_rotation_z']),
  705. SockTemplate(name="Scale", bl_idname='BooleanThreeTupleSocket',
  706. is_input=True, default_value=[True, True, True],
  707. blender_property=['use_scale_x', 'use_scale_y', 'use_scale_z']),
  708. InfluenceTemplate,
  709. TargetTemplate,
  710. EnableTemplate,
  711. OutputRelationshipTemplate,
  712. ]
  713. class LinkInheritConstraint(MantisLinkNode):
  714. def __init__(self, signature, base_tree):
  715. super().__init__(signature, base_tree, LinkInheritConstraintSockets)
  716. self.init_parameters(additional_parameters={"Name":None })
  717. self.set_traverse([("Input Relationship", "Output Relationship")])
  718. def GetxForm(self):
  719. return GetxForm(self)
  720. def bExecute(self, context):
  721. prepare_parameters(self)
  722. print(wrapGreen("Creating ")+wrapWhite("Child-Of")+
  723. wrapGreen(" Constraint for bone: ") +
  724. wrapOrange(self.GetxForm().bGetObject().name))
  725. c = self.GetxForm().bGetObject().constraints.new('CHILD_OF')
  726. self.get_target_and_subtarget(c)
  727. if constraint_name := self.evaluate_input("Name"):
  728. c.name = constraint_name
  729. self.bObject = c
  730. props_sockets = self.gen_property_socket_map()
  731. evaluate_sockets(self, c, props_sockets)
  732. c.set_inverse_pending
  733. self.executed = True
  734. LinkInverseKinematicsSockets = [
  735. InputRelationshipTemplate,
  736. ChainLengthTemplate := SockTemplate(name="Chain Length",
  737. bl_idname="IntSocket", is_input=True,
  738. default_value=0, blender_property='chain_count'),
  739. SockTemplate(name="Use Tail", bl_idname="BooleanSocket", is_input=True,
  740. default_value=True, blender_property='use_tail'),
  741. SockTemplate(name="Stretch", bl_idname="BooleanSocket", is_input=True,
  742. default_value=True, blender_property='use_stretch'),
  743. SockTemplate(name="Position", bl_idname="FloatFactorSocket", is_input=True,
  744. default_value=1.0, blender_property='weight'),
  745. SockTemplate(name="Rotation", bl_idname="FloatFactorSocket", is_input=True,
  746. default_value=0.0, blender_property='orient_weight'),
  747. InfluenceTemplate,
  748. TargetTemplate,
  749. SockTemplate(name="Pole Target", is_input=True, bl_idname='xFormSocket', ),
  750. EnableTemplate,
  751. OutputRelationshipTemplate,
  752. ]
  753. class LinkInverseKinematics(MantisLinkNode):
  754. def __init__(self, signature, base_tree):
  755. super().__init__(signature, base_tree, LinkInverseKinematicsSockets)
  756. self.init_parameters(additional_parameters={"Name":None })
  757. self.set_traverse([("Input Relationship", "Output Relationship")])
  758. def GetxForm(self):
  759. return GetxForm(self)
  760. def get_base_ik_bone(self, ik_bone):
  761. chain_length : int = (self.evaluate_input("Chain Length"))
  762. if not isinstance(chain_length, (int, float)):
  763. raise GraphError(f"Chain Length must be an integer number in {self}::Chain Length")
  764. if chain_length == 0:
  765. chain_length = int("inf")
  766. base_ik_bone = ik_bone; i=1
  767. while (i<chain_length) and (base_ik_bone.parent):
  768. base_ik_bone=base_ik_bone.parent; i+=1
  769. return base_ik_bone
  770. # We need to do the calculation in a "full circle", meaning the pole_angle
  771. # can go over pi or less than -pi - but the actuall constraint value must
  772. # be clamped in that range.
  773. # so we simply wrap the value.
  774. # not very efficient but it's OK
  775. def set_pole_angle(self, angle: float) -> None:
  776. from math import pi
  777. def wrap(min : float, max : float, value: float) -> float:
  778. range = max-min; remainder = value % range
  779. if remainder > max: return min + remainder-max
  780. else: return remainder
  781. self.bObject.pole_angle = wrap(-pi, pi, angle)
  782. def calc_pole_angle_pre(self, c, ik_bone):
  783. """
  784. This function gets us most of the way to a correct IK pole angle. Unfortunately,
  785. due to the unpredictable nature of the iterative IK calculation, I can't figure
  786. out an exact solution. So we do a bisect search in calc_pole_angle_post().
  787. """
  788. # TODO: instead of these checks, convert all to armature local space. But this is tedious.
  789. if not c.target:
  790. raise GraphError(f"IK Constraint {self} must have target.")
  791. elif c.target.type != "ARMATURE":
  792. raise NotImplementedError(f"Currently, IK Constraint Target for {self} must be a bone within the same armature.")
  793. if c.pole_target.type != "ARMATURE":
  794. raise NotImplementedError(f"Currently, IK Constraint Pole Target for {self} must be a bone within the same armature.")
  795. ik_handle = c.target.pose.bones[c.subtarget]
  796. if ik_handle.id_data != ik_bone.id_data:
  797. raise NotImplementedError(f"Currently, IK Constraint Target for {self} must be a bone within the same armature.")
  798. ik_pole = c.pole_target.pose.bones[c.pole_subtarget]
  799. if ik_pole.id_data != ik_bone.id_data:
  800. raise NotImplementedError(f"Currently,IK Constraint Pole Target for {self} must be a bone within the same armature.")
  801. base_ik_bone = self.get_base_ik_bone(ik_bone)
  802. start_effector = base_ik_bone.bone.head_local
  803. end_effector = ik_handle.bone.head_local
  804. pole_location = ik_pole.bone.head_local
  805. # this is the X-Axis of the bone's rest-pose, added to its bone
  806. knee_location = base_ik_bone.bone.matrix_local.col[0].xyz+start_effector
  807. ik_axis = (end_effector-start_effector).normalized()
  808. from .utilities import project_point_to_plane
  809. pole_planar_projection = project_point_to_plane(pole_location, start_effector, ik_axis)
  810. # this planar projection is necessary because the IK axis is different than the base_bone's y axis
  811. planar_projection = project_point_to_plane(knee_location, start_effector, ik_axis)
  812. knee_direction =(planar_projection - start_effector).normalized()
  813. pole_direction =(pole_planar_projection - start_effector).normalized()
  814. return knee_direction.angle(pole_direction)
  815. def calc_pole_angle_post(self, c, ik_bone, context):
  816. """
  817. This function should give us a completely accurate result for IK.
  818. """
  819. from time import time
  820. start_time=time()
  821. def signed_angle(vector_u, vector_v, normal):
  822. # it seems that this fails if the vectors are exactly aligned under certain circumstances.
  823. angle = vector_u.angle(vector_v, 0.0) # So we use a fallback of 0
  824. # Normal specifies orientation
  825. if angle != 0 and vector_u.cross(vector_v).angle(normal) < 1:
  826. angle = -angle
  827. return angle
  828. # we have already checked for valid data.
  829. ik_handle = c.target.pose.bones[c.subtarget]
  830. base_ik_bone = self.get_base_ik_bone(ik_bone)
  831. start_effector = base_ik_bone.bone.head_local
  832. angle = c.pole_angle
  833. dg = context.view_layer.depsgraph
  834. dg.update()
  835. ik_axis = (ik_handle.bone.head_local-start_effector).normalized()
  836. center_point = start_effector +(ik_axis*base_ik_bone.bone.length)
  837. knee_direction = base_ik_bone.bone.tail_local - center_point
  838. current_knee_direction = base_ik_bone.tail-center_point
  839. error=signed_angle(current_knee_direction, knee_direction, ik_axis)
  840. if error == 0:
  841. prGreen("No Fine-tuning needed."); return
  842. # Flip it if needed
  843. dot_before=current_knee_direction.dot(knee_direction)
  844. if dot_before < 0 and angle!=0: # then it is not aligned and we should check the inverse
  845. angle = -angle; c.pole_angle=angle
  846. dg.update()
  847. current_knee_direction = base_ik_bone.tail-center_point
  848. dot_after=current_knee_direction.dot(knee_direction)
  849. if dot_after < dot_before: # they are somehow less aligned
  850. prPurple("Mantis has gone down an unexpected code path. Please report this as a bug.")
  851. angle = -angle; self.set_pole_angle(angle)
  852. dg.update()
  853. # now we can do a bisect search to find the best value.
  854. error_threshhold = FLOAT_EPSILON
  855. max_iterations=600
  856. error=signed_angle(current_knee_direction, knee_direction, ik_axis)
  857. if error == 0:
  858. prGreen("No Fine-tuning needed."); return
  859. angle+=error
  860. alt_angle = angle+(error*-2) # should be very near the center when flipped here
  861. # we still need to bisect search because the relationship of pole_angle <==> error is somewhat unpredictable
  862. upper_bounds = alt_angle if alt_angle > angle else angle
  863. lower_bounds = alt_angle if alt_angle < angle else angle
  864. i=0
  865. while ( True ):
  866. if (i>=max_iterations):
  867. prOrange(f"IK Pole Angle Set reached max iterations of {i} in {time()-start_time} seconds")
  868. break
  869. if (abs(error)<error_threshhold) or (upper_bounds<=lower_bounds):
  870. prPurple(f"IK Pole Angle Set converged after {i} iterations with error={error} in {time()-start_time} seconds")
  871. break
  872. # get the center-point betweeen the bounds
  873. try_angle = lower_bounds + (upper_bounds-lower_bounds)/2
  874. self.set_pole_angle(try_angle); dg.update()
  875. error=signed_angle((base_ik_bone.tail-center_point), knee_direction, ik_axis)
  876. if error>0: upper_bounds=try_angle
  877. if error<0: lower_bounds=try_angle
  878. i+=1
  879. def bExecute(self, context):
  880. prepare_parameters(self)
  881. print(wrapGreen("Creating ")+wrapOrange("Inverse Kinematics")+
  882. wrapGreen(" Constraint for bone: ") +
  883. wrapOrange(self.GetxForm().bGetObject().name))
  884. ik_bone = self.GetxForm().bGetObject()
  885. c = self.GetxForm().bGetObject().constraints.new('IK')
  886. self.get_target_and_subtarget(c)
  887. self.get_target_and_subtarget(c, input_name = 'Pole Target')
  888. if constraint_name := self.evaluate_input("Name"):
  889. c.name = constraint_name
  890. self.bObject = c
  891. c.chain_count = 1 # so that, if there are errors, this doesn't print
  892. # a whole bunch of circular dependency crap from having infinite chain length
  893. if (c.pole_target):
  894. self.set_pole_angle(self.calc_pole_angle_pre(c, ik_bone))
  895. props_sockets = self.gen_property_socket_map()
  896. evaluate_sockets(self, c, props_sockets)
  897. print (props_sockets)
  898. c.use_location = self.evaluate_input("Position") > 0
  899. c.use_rotation = self.evaluate_input("Rotation") > 0
  900. self.executed = True
  901. def bFinalize(self, bContext = None):
  902. # adding a test here
  903. if bContext:
  904. ik_bone = self.GetxForm().bGetObject(mode='POSE')
  905. if self.bObject.pole_target:
  906. prWhite(f"Fine-tuning IK Pole Angle for {self}")
  907. # make sure to enable it first
  908. enabled_before = self.bObject.mute
  909. self.bObject.mute = False
  910. self.calc_pole_angle_post(self.bObject, ik_bone, bContext)
  911. self.bObject.mute = enabled_before
  912. super().bFinalize(bContext)
  913. def ik_report_error(pb, context, do_print=False):
  914. dg = context.view_layer.depsgraph
  915. dg.update()
  916. loc1, rot_quaternion1, scl1 = pb.matrix.decompose()
  917. loc2, rot_quaternion2, scl2 = pb.bone.matrix_local.decompose()
  918. location_error=(loc1-loc2).length
  919. rotation_error = rot_quaternion1.rotation_difference(rot_quaternion2).angle
  920. scale_error = (scl1-scl2).length
  921. if location_error < FLOAT_EPSILON: location_error = 0
  922. if abs(rotation_error) < FLOAT_EPSILON: rotation_error = 0
  923. if scale_error < FLOAT_EPSILON: scale_error = 0
  924. if do_print:
  925. print (f"IK Location Error: {location_error}")
  926. print (f"IK Rotation Error: {rotation_error}")
  927. print (f"IK Scale Error : {scale_error}")
  928. return (location_error, rotation_error, scale_error)
  929. LinkDrivenParameterSockets = [
  930. InputRelationshipTemplate,
  931. SockTemplate(name="Value", bl_idname="FloatSocket", is_input=True,
  932. default_value=-0.0,),
  933. SockTemplate(name="Parameter", bl_idname="ParameterStringSocket", is_input=True,
  934. default_value="",),
  935. SockTemplate(name="Index", bl_idname="IntSocket", is_input=True,
  936. default_value=0,),
  937. OutputRelationshipTemplate,
  938. ]
  939. # This is kinda a weird design decision?
  940. class LinkDrivenParameter(MantisLinkNode):
  941. '''A node representing an armature object'''
  942. def __init__(self, signature, base_tree):
  943. super().__init__(signature, base_tree, LinkDrivenParameterSockets)
  944. self.init_parameters(additional_parameters={ "Name":None })
  945. self.set_traverse([("Input Relationship", "Output Relationship")])
  946. def GetxForm(self):
  947. return GetxForm(self)
  948. def bExecute(self, bContext = None,):
  949. prepare_parameters(self)
  950. prGreen("Executing Driven Parameter node")
  951. prop = self.evaluate_input("Parameter")
  952. index = self.evaluate_input("Index")
  953. value = self.evaluate_input("Value")
  954. xf = self.GetxForm()
  955. ob = xf.bGetObject(mode="POSE")
  956. # IMPORTANT: this node only works on pose bone attributes.
  957. self.bObject = ob
  958. length=1
  959. if hasattr(ob, prop):
  960. try:
  961. length = len(getattr(ob, prop))
  962. except TypeError:
  963. pass
  964. except AttributeError:
  965. pass
  966. else:
  967. raise AttributeError(f"Cannot Set value {prop} on object because it does not exist.")
  968. def_value = 0.0
  969. if length>1:
  970. def_value=[0.0]*length
  971. self.parameters["Value"] = tuple( 0.0 if i != index else value for i in range(length))
  972. props_sockets = {
  973. prop: ("Value", def_value)
  974. }
  975. evaluate_sockets(self, ob, props_sockets)
  976. self.executed = True
  977. def bFinalize(self, bContext = None):
  978. driver = self.evaluate_input("Value")
  979. try:
  980. for i, val in enumerate(self.parameters["Value"]):
  981. from .drivers import MantisDriver
  982. if isinstance(val, MantisDriver):
  983. driver["ind"] = i
  984. val = driver
  985. except AttributeError:
  986. self.parameters["Value"] = driver
  987. except TypeError:
  988. self.parameters["Value"] = driver
  989. super().bFinalize(bContext)
  990. LinkArmatureSockets=[
  991. InputRelationshipTemplate,
  992. SockTemplate(name="Preserve Volume", bl_idname='BooleanSocket', is_input=True,
  993. default_value=False, blender_property='use_deform_preserve_volume'),
  994. SockTemplate(name="Use Envelopes", bl_idname='BooleanSocket', is_input=True,
  995. default_value=False, blender_property='use_bone_envelopes'),
  996. SockTemplate(name="Use Current Location", bl_idname='BooleanSocket', is_input=True,
  997. default_value=False, blender_property='use_current_location'),
  998. InfluenceTemplate,
  999. EnableTemplate,
  1000. OutputRelationshipTemplate,
  1001. ]
  1002. class LinkArmature(MantisLinkNode):
  1003. '''A node representing an armature object'''
  1004. def __init__(self, signature, base_tree,):
  1005. super().__init__(signature, base_tree, LinkArmatureSockets)
  1006. self.init_parameters(additional_parameters={"Name":None })
  1007. self.set_traverse([("Input Relationship", "Output Relationship")])
  1008. setup_custom_props(self) # <-- this takes care of the runtime-added sockets
  1009. def GetxForm(self):
  1010. return GetxForm(self)
  1011. def bExecute(self, bContext = None,):
  1012. prGreen("Creating Armature Constraint for bone: \""+ self.GetxForm().bGetObject().name + "\"")
  1013. prepare_parameters(self)
  1014. c = self.GetxForm().bGetObject().constraints.new('ARMATURE')
  1015. if constraint_name := self.evaluate_input("Name"):
  1016. c.name = constraint_name
  1017. self.bObject = c
  1018. # get number of targets
  1019. num_targets = len( list(self.inputs.values())[6:] )//2
  1020. props_sockets = self.gen_property_socket_map()
  1021. targets_weights = {}
  1022. for i in range(num_targets):
  1023. target = c.targets.new()
  1024. target_input_name = list(self.inputs.keys())[i*2+6 ]
  1025. weight_input_name = list(self.inputs.keys())[i*2+6+1]
  1026. self.get_target_and_subtarget(target, target_input_name)
  1027. weight_value=self.evaluate_input(weight_input_name)
  1028. if not isinstance(weight_value, float):
  1029. weight_value=0
  1030. targets_weights[i]=weight_value
  1031. props_sockets["targets[%d].weight" % i] = (weight_input_name, 0)
  1032. # targets_weights.append({"weight":(weight_input_name, 0)})
  1033. evaluate_sockets(self, c, props_sockets)
  1034. for target, value in targets_weights.items():
  1035. c.targets[target].weight=value
  1036. self.executed = True
  1037. LinkSplineIKSockets = [
  1038. InputRelationshipTemplate,
  1039. TargetTemplate,
  1040. ChainLengthTemplate,
  1041. SockTemplate(name="Even Divisions", bl_idname="BooleanSocket", is_input=True,
  1042. default_value=False, blender_property='use_even_divisions'),
  1043. SockTemplate(name="Chain Offset", bl_idname="BooleanSocket", is_input=True,
  1044. default_value=False, blender_property='use_chain_offset'),
  1045. SockTemplate(name="Use Curve Radius", bl_idname="BooleanSocket", is_input=True,
  1046. default_value=True, blender_property='use_curve_radius'),
  1047. SockTemplate(name="Y Scale Mode", bl_idname="EnumYScaleMode", is_input=True,
  1048. default_value="FIT_CURVE", blender_property='y_scale_mode'),
  1049. SockTemplate(name="XZ Scale Mode", bl_idname="EnumXZScaleMode", is_input=True,
  1050. default_value="NONE", blender_property='xz_scale_mode'),
  1051. #IMPORTANT TODO: This socket is removed in 4.5
  1052. SockTemplate(name="Use Original Scale", bl_idname="BooleanSocket", is_input=True,
  1053. default_value=False, blender_property='use_original_scale'),
  1054. InfluenceTemplate,
  1055. EnableTemplate,
  1056. OutputRelationshipTemplate,
  1057. ]
  1058. class LinkSplineIK(MantisLinkNode):
  1059. '''A node representing an armature object'''
  1060. def __init__(self, signature, base_tree):
  1061. super().__init__(signature, base_tree, LinkSplineIKSockets)
  1062. self.init_parameters(additional_parameters={"Name":None })
  1063. self.set_traverse([("Input Relationship", "Output Relationship")])
  1064. def GetxForm(self):
  1065. return GetxForm(self)
  1066. def bExecute(self, bContext = None,):
  1067. prepare_parameters(self)
  1068. prGreen("Creating Spline-IK Constraint for bone: \""+ self.GetxForm().bGetObject().name + "\"")
  1069. c = self.GetxForm().bGetObject().constraints.new('SPLINE_IK')
  1070. self.get_target_and_subtarget(c)
  1071. if constraint_name := self.evaluate_input("Name"):
  1072. c.name = constraint_name
  1073. self.bObject = c
  1074. props_sockets = self.gen_property_socket_map()
  1075. evaluate_sockets(self, c, props_sockets)
  1076. self.executed = True