├── .gitignore
├── LICENSE
├── README.md
├── media
└── cover.png
└── stopmagic
├── __init__.py
├── functions
├── __init__.py
├── addon_version.py
├── frame_handler.py
├── future_object.py
├── get_object_key_values.py
├── get_object_keyframes.py
├── get_preferences.py
├── handle_onion_constraints.py
├── handle_onion_skin.py
├── insert_mesh_keyframe.py
├── is_candidate_object.py
├── key_config.py
├── new_object_id.py
├── past_object.py
└── update_stopmagic.py
├── icons.py
├── icons
├── github.png
├── kofi.png
└── paypal.png
├── operators
├── __init__.py
├── add_mesh_keyframe.py
├── contributions.py
├── initialize_handler.py
├── keyed_frame_next.py
├── keyed_frame_previous.py
├── purge_unused_data.py
├── skip_frame_backward.py
├── skip_frame_forward.py
└── upgrade_addon.py
├── panel.py
└── preferences.py
/.gitignore:
--------------------------------------------------------------------------------
1 | **/__pycache__
2 | tests/
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | 
4 |
5 | [](https://blendermarket.com/products/stopmagic)
6 | [](https://github.com/aldrinsartfactory/stopmagic/wiki)
7 | [](https://github.com/aldrinsartfactory/stopmagic/wiki/Installing-the-Addon)
8 |
9 | Stopmagic gives you the power of creating amazing Stop Motion animations faster and easier than ever before. This project is maintained by Aldrin Mathew.
10 |
11 | This is a revival of the Keymesh addon developed by Pablo Dobarro, and the Animation Testing for Keymesh was done by Daniel Martinez Lara.
12 |
13 | ## Features
14 |
15 | ### Shortcuts for faster workflows
16 |
17 | - `Ctrl Shift A` adds a Keyframe to the current active mesh and frame.
18 | - `Ctrl Shift Z` skips frames backward, and adds keyframe if chosen
19 | - `Ctrl Shift X` skips frames forward, and adds keyframe if chosen
20 | - `Ctrl Shift C` finds the previous frame with a keyed mesh, if any
21 | - `Ctrl Shift V` finds the next frame with a keyed mesh, if any
22 |
23 | All of these shortcuts can be customized if required.
24 |
25 | ### Frame Skipping
26 |
27 | Artists can now seamlessly skip frames forwards or backwards and add a keyframe to do stop motion poses easily. You can change the number of frames to be skipped and also disable adding keyframe automatically, if required.
28 |
29 | ### Onion Skins (Experimental)
30 |
31 | You can now provide a frame range and see the past and future onion skins of the active object. Keep in mind that this feature is experimental and also creates new objects and meshes in your scene. This could also be buggy. You can also change the color of the past and future objects of the onion skin
32 |
33 | ### Finding Keyed Frame
34 |
35 | This feature allows you to jump to the next or previous frame that has a keyed mesh in it. This is very useful when you want to work faster and doesn't want to navigate through the timeline a lot
36 |
37 | ### Upgrade Addon
38 |
39 | If network is available, this checks whether a new version of the addon is available. If so, it will show a button that directly navigates the user to the download link for the latest version. If there is no network, this button will navigate the user to the releases page of the addon
40 |
41 | ### Initializing Frame Handler
42 |
43 | Whenever the addon stops working, use this button to initialize the frame handler.
44 |
45 | ### Purge Unused Data
46 |
47 | Unused mesh data can be purged to save space and remove clutter
48 |
49 | ## Documentation
50 |
51 | The documentation of the addon is available [here](https://github.com/aldrinsartfactory/stopmagic/wiki)
52 |
--------------------------------------------------------------------------------
/media/cover.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aldrinmathew/stopmagic/e3e1a6c7f9943ef5e2a70cdc5cfecff5ac4f118e/media/cover.png
--------------------------------------------------------------------------------
/stopmagic/__init__.py:
--------------------------------------------------------------------------------
1 | import sys
2 |
3 | sys.path.append("./")
4 | if "bpy" in locals():
5 | import importlib
6 |
7 | importlib.reload(preferences)
8 | importlib.reload(operators)
9 | importlib.reload(functions)
10 | importlib.reload(panel)
11 | importlib.reload(icons)
12 | else:
13 | from stopmagic import preferences
14 | from stopmagic import operators
15 | from stopmagic import functions
16 | from stopmagic import panel
17 | from stopmagic import icons
18 |
19 | from typing import List, Tuple
20 | import bpy
21 | import threading
22 | import re
23 | import os.path
24 |
25 |
26 | __package__ = "stopmagic"
27 |
28 |
29 | bl_info = {
30 | "name": "Stopmagic",
31 | "author": "Aldrin Mathew",
32 | "version": (0, 3, 3),
33 | "blender": (2, 91, 0),
34 | "location": "Sidebar > Stopmagic",
35 | "warning": "beta",
36 | "category": "Animation",
37 | "description": "Improve your Stop motion workflow. Use shortcuts 'Ctrl Shift X' & 'Ctrl Shift Z' for faster workflows.",
38 | "doc_url": "https://github.com/aldrinsartfactory/stopmagic/wiki",
39 | }
40 |
41 |
42 | addon_keymaps: List[Tuple[bpy.types.KeyMap, bpy.types.KeyMapItem]] = []
43 |
44 |
45 | @bpy.app.handlers.persistent
46 | def periodic_handler(_):
47 | functions.frame_handler(None)
48 | threading.Timer(
49 | interval=180,
50 | function=functions.frame_handler,
51 | args=[None],
52 | kwargs=None,
53 | )
54 |
55 |
56 | def register() -> None:
57 | global addon_keymaps
58 | icons.register()
59 | preferences.register()
60 | panel.StopmagicPanel.bl_info = bl_info
61 | panel.register()
62 | operators.add_mesh_keyframe.register()
63 | operators.skip_frame_forward.register()
64 | operators.skip_frame_backward.register()
65 | operators.purge_unused_data.register()
66 | operators.initialize_handler.register()
67 | operators.keyed_frame_next.register()
68 | operators.keyed_frame_previous.register()
69 | operators.upgrade_addon.register()
70 | operators.contributions.register()
71 | bpy.app.handlers.load_post.append(periodic_handler)
72 | bpy.app.handlers.frame_change_post.clear()
73 | bpy.app.handlers.frame_change_post.append(functions.update_stopmagic)
74 | bpy.app.handlers.frame_change_pre.clear()
75 | bpy.app.handlers.frame_change_pre.append(functions.handle_onion_skin)
76 | addon_keymaps = functions.key_config()
77 |
78 |
79 | def unregister() -> None:
80 | preferences.unregister()
81 | operators.add_mesh_keyframe.unregister()
82 | operators.skip_frame_backward.unregister()
83 | operators.skip_frame_forward.unregister()
84 | operators.purge_unused_data.unregister()
85 | operators.initialize_handler.unregister()
86 | operators.keyed_frame_next.unregister()
87 | operators.keyed_frame_previous.unregister()
88 | operators.upgrade_addon.unregister()
89 | operators.contributions.unregister()
90 | panel.unregister()
91 | bpy.app.handlers.load_post.clear()
92 | bpy.app.handlers.load_post.clear()
93 | bpy.app.handlers.frame_change_post.clear()
94 | bpy.app.handlers.frame_change_pre.clear()
95 | icons.unregister()
96 | addon_keymaps.clear()
97 |
98 |
99 | if __name__ == "__main__":
100 | register()
101 |
--------------------------------------------------------------------------------
/stopmagic/functions/__init__.py:
--------------------------------------------------------------------------------
1 | from .addon_version import *
2 | from .frame_handler import *
3 | from .insert_mesh_keyframe import *
4 | from .new_object_id import *
5 | from .update_stopmagic import *
6 | from .key_config import *
7 | from .get_preferences import *
8 | from .past_object import *
9 | from .future_object import *
10 | from .get_object_keyframes import *
11 | from .get_object_key_values import *
12 | from .handle_onion_constraints import *
13 | from .is_candidate_object import *
14 |
--------------------------------------------------------------------------------
/stopmagic/functions/addon_version.py:
--------------------------------------------------------------------------------
1 | from typing import Any
2 |
3 |
4 | def addon_version(info: "dict[str, Any]") -> str:
5 | """Gets the string form of the addon version"""
6 |
7 | result = ""
8 | i = 0
9 | length = len(info["version"])
10 | while i < length:
11 | result += str(info["version"][i])
12 | if i + 1 != length:
13 | result += "."
14 | i += 1
15 | if "warning" in info:
16 | result += "-" + info["warning"]
17 | return result
18 |
--------------------------------------------------------------------------------
/stopmagic/functions/frame_handler.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 | from stopmagic.functions import handle_onion_skin, update_stopmagic
4 |
5 |
6 | @bpy.app.handlers.persistent
7 | def frame_handler(dummy) -> None:
8 | obs = bpy.context.scene.objects
9 | for o in obs:
10 | if "sm_datablock" and "sm_id" in o: # It's a Stopmagic scene
11 | bpy.app.handlers.frame_change_post.clear()
12 | bpy.app.handlers.frame_change_post.append(update_stopmagic)
13 | bpy.app.handlers.frame_change_pre.clear()
14 | bpy.app.handlers.frame_change_pre.append(handle_onion_skin)
15 | break
16 |
--------------------------------------------------------------------------------
/stopmagic/functions/future_object.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 |
4 | def future_object_exists() -> bool:
5 | for item in bpy.context.view_layer.objects:
6 | if item.name == "sm_onion_future":
7 | return True
8 | return False
9 |
10 |
11 | def get_future_object(exists: bool) -> bpy.types.Object:
12 | """Get the future Onion Skin object depending on the provided value. Creates one if it doesn't exists already"""
13 | if not exists:
14 | fcache = bpy.data.meshes.new("sm_onion_future")
15 | fobject = bpy.data.objects.new(name="sm_onion_future", object_data=fcache)
16 | fobject.hide_select = True
17 | fobject.display.show_shadows = True
18 | fobject.hide_render = True
19 | return fobject
20 | else:
21 | return bpy.context.view_layer.objects.get("sm_onion_future")
--------------------------------------------------------------------------------
/stopmagic/functions/get_object_key_values.py:
--------------------------------------------------------------------------------
1 | import bpy
2 | from typing import List
3 |
4 |
5 | def get_object_key_values(obj: bpy.types.Object) -> List[int]:
6 | values: List[int] = []
7 | if obj.get("sm_id") is not None:
8 | for action in bpy.data.actions:
9 | if obj.user_of_id(action.id_data):
10 | fcurves = action.fcurves
11 | if fcurves is not None:
12 | for item in fcurves:
13 | fcurve: bpy.types.FCurve = item
14 | if fcurve.data_path != '["sm_datablock"]':
15 | continue
16 | #
17 | keyframe_points = fcurve.keyframe_points
18 | for item in keyframe_points:
19 | i = 1
20 | while i < len(item.co):
21 | values.append(int(item.co[i]))
22 | i += 2
23 | return values
24 | return values
25 |
--------------------------------------------------------------------------------
/stopmagic/functions/get_object_keyframes.py:
--------------------------------------------------------------------------------
1 | from typing import List
2 | import bpy
3 |
4 |
5 | def get_object_keyframes(obj: bpy.types.Object) -> List[int]:
6 | """Get all keyframes that has mesh keyframes, associated with the active object"""
7 | keyframes: List[int] = []
8 | if obj is None:
9 | obj = bpy.context.view_layer.objects.active
10 | if obj.get("sm_id") is not None:
11 | for action in bpy.data.actions:
12 | if obj.user_of_id(action.id_data):
13 | fcurves = action.fcurves
14 | if fcurves is not None:
15 | for item in fcurves:
16 | fcurve: bpy.types.FCurve = item
17 | if fcurve.data_path != '["sm_datablock"]':
18 | continue
19 | #
20 | keyframe_points = fcurve.keyframe_points
21 | for item in keyframe_points:
22 | i = 0
23 | while i < len(item.co):
24 | keyframes.append(int(item.co[i]))
25 | i += 2
26 | return keyframes
27 | return keyframes
28 |
--------------------------------------------------------------------------------
/stopmagic/functions/get_preferences.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 | def get_preferences(package: str) -> bpy.types.AddonPreferences:
4 | return bpy.context.preferences.addons[package].preferences
--------------------------------------------------------------------------------
/stopmagic/functions/handle_onion_constraints.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | import bpy
3 | from typing import Tuple
4 |
5 |
6 | def handle_onion_constraints(
7 | obj: bpy.types.Object, active: bpy.types.Object
8 | ) -> Tuple[
9 | bpy.types.CopyLocationConstraint,
10 | bpy.types.CopyRotationConstraint,
11 | bpy.types.CopyScaleConstraint,
12 | bpy.types.CopyTransformsConstraint,
13 | ]:
14 | """Handle finding constraints for the object. This function expects the object to have four constraints attached to it. If not those will be created. For the addon, this function is only called for the Past and Future variants of the Onion Skin"""
15 | loc: bpy.types.CopyLocationConstraint | None = None
16 | rot: bpy.types.CopyRotationConstraint | None = None
17 | scl: bpy.types.CopyScaleConstraint | None = None
18 | tra: bpy.types.CopyTransformsConstraint | None = None
19 |
20 | def check_constraints():
21 | nonlocal loc
22 | nonlocal rot
23 | nonlocal scl
24 | nonlocal tra
25 | for item in obj.constraints:
26 | if item.type == "COPY_LOCATION":
27 | loc = item
28 | elif item.type == "COPY_ROTATION":
29 | rot = item
30 | elif item.type == "COPY_SCALE":
31 | scl = item
32 | elif item.type == "COPY_TRANSFORMS":
33 | tra = item
34 |
35 | check_constraints()
36 | bpy.context.view_layer.objects.active = obj
37 | if loc is None or rot is None or scl is None or tra is None:
38 | if loc is None:
39 | bpy.ops.object.constraint_add(type="COPY_LOCATION")
40 | if rot is None:
41 | bpy.ops.object.constraint_add(type="COPY_ROTATION")
42 | if scl is None:
43 | bpy.ops.object.constraint_add(type="COPY_SCALE")
44 | if tra is None:
45 | bpy.ops.object.constraint_add(type="COPY_TRANSFORMS")
46 | loc, rot, scl, tra = handle_onion_constraints(obj, active)
47 | loc.target = active
48 | rot.target = active
49 | scl.target = active
50 | tra.target = active
51 | bpy.context.view_layer.objects.active = active
52 | else:
53 | return loc, rot, scl, tra
54 |
--------------------------------------------------------------------------------
/stopmagic/functions/handle_onion_skin.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import Any
3 | import bpy
4 | import bmesh
5 | from stopmagic.functions.get_object_key_values import get_object_key_values
6 | from stopmagic.functions.past_object import *
7 | from stopmagic.functions.future_object import *
8 | from stopmagic.functions.handle_onion_constraints import *
9 | from stopmagic.functions.get_object_keyframes import *
10 |
11 |
12 | def handle_collections(past: bpy.types.Object, future: bpy.types.Object) -> None:
13 | if bpy.data.collections.get("Stopmagic"):
14 | sm_collection = bpy.data.collections["Stopmagic"]
15 | else:
16 | sm_collection = bpy.data.collections.new("Stopmagic")
17 | bpy.context.scene.collection.children.link(sm_collection)
18 | sm_collection.objects.link(past)
19 | sm_collection.objects.link(future)
20 | sm_collection.hide_render = True
21 | sm_collection.hide_select = True
22 |
23 |
24 | @bpy.app.handlers.persistent
25 | def handle_onion_skin(dummy):
26 | """Automatically handles Onion Skin objects and populates them with mesh data"""
27 | if bpy.context.view_layer.objects.active is not None:
28 | mode_value: str | int | Any = bpy.context.view_layer.objects.active.mode
29 | mode: str = ""
30 | if type(mode_value) == str:
31 | mode = mode_value
32 | elif type(mode_value) == int:
33 | modes = [
34 | "OBJECT",
35 | "EDIT",
36 | "POSE",
37 | "SCULPT",
38 | "VERTEX_PAINT",
39 | "WEIGHT_PAINT",
40 | "TEXTURE_PAINT",
41 | "PARTICLE_EDIT",
42 | "EDIT_GPENCIL",
43 | "SCULPT_GPENCIL",
44 | "PAINT_GPENCIL",
45 | "WEIGHT_GPENCIL",
46 | "VERTEX_GPENCIL",
47 | ]
48 | mode: str = modes[mode_value]
49 | else:
50 | mode: str = "OBJECT"
51 |
52 | obj = bpy.context.view_layer.objects.active
53 | if obj.use_dynamic_topology_sculpting is None:
54 | dyntopo = False
55 | else:
56 | dyntopo = obj.use_dynamic_topology_sculpting
57 | if obj.type == "MESH" and bpy.context.scene.stopmagic_onion_skin_enabled:
58 | #
59 | # Creating or retrieving stopmagic onion skin object data
60 | #
61 | past_exists: bool = past_object_exists()
62 | future_exists: bool = future_object_exists()
63 | pobject = get_past_object(past_exists)
64 | fobject = get_future_object(future_exists)
65 | # Past and Future Offset values from the scene
66 | poffset = bpy.context.scene.stopmagic_past_offset
67 | foffset = bpy.context.scene.stopmagic_future_offset
68 |
69 | handle_collections(pobject, fobject)
70 |
71 | # Handle constraints
72 | handle_onion_constraints(pobject, obj)
73 | handle_onion_constraints(fobject, obj)
74 |
75 | #
76 | # Onion Skin objects visibility
77 | #
78 | pobject.color = bpy.context.scene.stopmagic_past_color
79 | fobject.color = bpy.context.scene.stopmagic_future_color
80 | pmaterial = bpy.data.materials.get("stopmagic_material_past")
81 | fmaterial = bpy.data.materials.get("stopmagic_material_future")
82 | if pmaterial is None:
83 | pmaterial = bpy.data.materials.new(name="stopmagic_material_past")
84 | pobject.active_material = pmaterial
85 | pmaterial.use_nodes = True
86 | pmat_output = pmaterial.node_tree.nodes.get("Material Output")
87 | p_principled = pmaterial.node_tree.nodes.get("Principled BSDF")
88 | pmaterial.node_tree.links.new(
89 | pmat_output.inputs[0], p_principled.outputs[0]
90 | )
91 | p_principled.inputs[
92 | 0
93 | ].default_value = bpy.context.scene.stopmagic_past_color
94 | opacity = bpy.context.scene.stopmagic_past_color[3]
95 | if opacity > 0 and opacity < 1:
96 | p_principled.inputs[
97 | 21
98 | ].default_value = bpy.context.scene.stopmagic_past_color[3]
99 | else:
100 | p_principled.inputs[21].default_value = 0.3
101 | pmaterial.diffuse_color = bpy.context.scene.stopmagic_past_color
102 | pmaterial.blend_method = "HASHED"
103 | if fmaterial is None:
104 | fmaterial = bpy.data.materials.new(name="stopmagic_material_future")
105 | fobject.active_material = fmaterial
106 | fmaterial.use_nodes = True
107 | fmat_output = fmaterial.node_tree.nodes.get("Material Output")
108 | f_principled = fmaterial.node_tree.nodes.get("Principled BSDF")
109 | fmaterial.node_tree.links.new(
110 | fmat_output.inputs[0], f_principled.outputs[0]
111 | )
112 | f_principled.inputs[
113 | 0
114 | ].default_value = bpy.context.scene.stopmagic_future_color
115 | opacity = bpy.context.scene.stopmagic_future_color[3]
116 | if opacity > 0 and opacity < 1:
117 | f_principled.inputs[
118 | 21
119 | ].default_value = bpy.context.scene.stopmagic_future_color[3]
120 | else:
121 | f_principled.inputs[21].default_value = 0.3
122 | fmaterial.diffuse_color = bpy.context.scene.stopmagic_future_color
123 | fmaterial.blend_method = "HASHED"
124 | #
125 | # Check and collect meshes within the range specified by the user
126 | #
127 | pmeshes = []
128 | fmeshes = []
129 | if obj is not None:
130 | if obj.get("sm_datablock") is not None:
131 | name = obj.name
132 | frame = bpy.context.scene.frame_current
133 | keyframes = get_object_keyframes(obj)
134 | key_values = get_object_key_values(obj)
135 | if len(key_values) > 0:
136 | p_frames = []
137 | p_key_values = []
138 | f_frames = []
139 | f_key_values = []
140 | index = 0
141 | while index < len(keyframes):
142 | if keyframes[index] < frame:
143 | p_key_values.append(key_values[index])
144 | p_frames.append(keyframes[index])
145 | elif keyframes[index] > frame:
146 | f_key_values.append(key_values[index])
147 | f_frames.append(keyframes[index])
148 | index += 1
149 | # To make sure that the onion for the previous keyframe doesn't
150 | # overlay the current mesh
151 | if len(p_key_values) > 0 and frame not in keyframes:
152 | p_frames.pop(len(p_key_values) - 1)
153 | p_key_values.pop(len(p_key_values) - 1)
154 | # To make sure that, if there are no previous keyframes then the
155 | # onion for the next keyframe doesn't overlay the current mesh
156 | elif (
157 | len(p_key_values) == 0
158 | and len(f_key_values) > 0
159 | and frame not in keyframes
160 | ):
161 | f_frames.pop(0)
162 | f_key_values.pop(0)
163 | #
164 | if bpy.context.scene.stopmagic_onion_display_type == "POSE":
165 | p_count = bpy.context.scene.stopmagic_past_count
166 | f_count = bpy.context.scene.stopmagic_future_count
167 | if len(p_key_values) > p_count:
168 | index = 0
169 | bound = len(p_key_values) - p_count
170 | while index < bound:
171 | p_frames.pop(0)
172 | p_key_values.pop(0)
173 | index += 1
174 | if len(f_key_values) > f_count:
175 | index = len(f_key_values) - 1
176 | while index >= f_count:
177 | f_frames.pop(index)
178 | f_key_values.pop(index)
179 | index -= 1
180 | elif bpy.context.scene.stopmagic_onion_display_type == "RANGE":
181 | p_result = []
182 | f_result = []
183 | i = 0
184 | while i < len(p_frames):
185 | if p_frames[i] > (
186 | frame - bpy.context.scene.stopmagic_past_offset
187 | ):
188 | p_result.append(p_key_values[i])
189 | i += 1
190 | i = 0
191 | while i < len(f_frames):
192 | if f_frames[i] < (
193 | frame + bpy.context.scene.stopmagic_future_offset
194 | ):
195 | f_result.append(f_key_values[i])
196 | i += 1
197 | p_key_values = p_result
198 | f_key_values = f_result
199 | #
200 | if len(p_key_values) > 0:
201 | for pkey in p_key_values:
202 | pmeshes.append(
203 | bpy.data.meshes.get(name + "_sm_" + str(pkey))
204 | )
205 | if len(f_key_values) > 0:
206 | for fkey in f_key_values:
207 | fmeshes.append(
208 | bpy.data.meshes.get(name + "_sm_" + str(fkey))
209 | )
210 | #
211 | #
212 | # Past
213 | bpy.context.view_layer.objects.active = pobject
214 | bpy.ops.object.mode_set(mode="EDIT")
215 | pbmesh: bmesh.types.BMesh = bmesh.from_edit_mesh(pobject.data)
216 | bmesh.ops.delete(pbmesh, geom=pbmesh.verts, context="VERTS")
217 | for mesh in pmeshes:
218 | pbmesh.from_mesh(mesh)
219 | bmesh.update_edit_mesh(pobject.data)
220 | bpy.ops.object.mode_set(mode="OBJECT")
221 | # Future
222 | bpy.context.view_layer.objects.active = fobject
223 | bpy.ops.object.mode_set(mode="EDIT")
224 | fbmesh: bmesh.types.BMesh = bmesh.from_edit_mesh(fobject.data)
225 | bmesh.ops.delete(fbmesh, geom=fbmesh.verts, context="VERTS")
226 | for mesh in fmeshes:
227 | fbmesh.from_mesh(mesh)
228 | bmesh.update_edit_mesh(fobject.data)
229 | bpy.ops.object.mode_set(mode="OBJECT")
230 | # Back to the main control flow
231 | bpy.context.view_layer.objects.active = obj
232 | bpy.ops.object.mode_set(mode=mode, toggle=False)
233 | if mode == "SCULPT":
234 | if (
235 | bpy.context.view_layer.objects.active.get(
236 | "use_dynamic_topology_sculpting"
237 | )
238 | != dyntopo
239 | ):
240 | bpy.ops.sculpt.dynamic_topology_toggle()
241 |
242 |
243 | def change_onion_color(past: bool, color: bpy.props.FloatVectorProperty):
244 | past_exists: bool = past_object_exists()
245 | future_exists: bool = future_object_exists()
246 | if past:
247 | pobject = get_past_object(past_exists)
248 | pobject.color = list(color)
249 | pmaterial = bpy.data.materials.get("stopmagic_material_past")
250 | if pmaterial is not None:
251 | pmaterial.diffuse_color = color
252 | if not pmaterial.use_nodes:
253 | pmaterial.use_nodes = True
254 | if pmaterial.node_tree.get("Principled BSDF") is not None:
255 | p_principled = pmaterial.node_tree.get("Principled BSDF")
256 | p_principled.inputs[0] = list(color)
257 | opacity = color[3]
258 | if opacity > 0 and opacity < 1:
259 | p_principled.inputs[21].default_value = color[3]
260 | else:
261 | p_principled.inputs[21].default_value = 0.3
262 | else:
263 | fobject = get_future_object(future_exists)
264 | fobject.color = list(color)
265 | fmaterial = bpy.data.materials.get("stopmagic_material_future")
266 | if fmaterial is not None:
267 | fmaterial.diffuse_color = color
268 | if not fmaterial.use_nodes:
269 | fmaterial.use_nodes = True
270 | if fmaterial.node_tree.get("Principled BSDF") is not None:
271 | f_principled = fmaterial.node_tree.get("Principled BSDF")
272 | f_principled.inputs[0] = list(color)
273 | opacity = color[3]
274 | if opacity > 0 and opacity < 1:
275 | f_principled.inputs[21].default_value = color[3]
276 | else:
277 | f_principled.inputs[21].default_value = 0.3
278 |
279 |
280 | def clear_onion_data():
281 | collection = bpy.data.collections.get("Stopmagic")
282 | pmaterial = bpy.data.materials.get("stopmagic_material_past")
283 | fmaterial = bpy.data.materials.get("stopmagic_material_future")
284 | if pmaterial is not None:
285 | bpy.data.materials.remove(pmaterial, do_unlink=True)
286 | if fmaterial is not None:
287 | bpy.data.materials.remove(fmaterial, do_unlink=True)
288 | if collection is not None:
289 | if collection.get("objects") is not None:
290 | for obj in collection.objects:
291 | mesh = obj.data
292 | obj.name = "removed"
293 | bpy.context.scene.objects.unlink(obj)
294 | bpy.data.meshes.remove(mesh, do_unlink=True)
295 | bpy.data.objects.remove(obj, do_unlink=True)
296 | bpy.data.collections.remove(collection)
297 | bpy.ops.outliner.orphans_purge(
298 | do_local_ids=True, do_linked_ids=False, do_recursive=False
299 | )
300 |
--------------------------------------------------------------------------------
/stopmagic/functions/insert_mesh_keyframe.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import Any, List
3 | import bpy
4 |
5 | from .handle_onion_skin import *
6 | from .new_object_id import *
7 | from .update_stopmagic import *
8 |
9 |
10 | def insert_mesh_keyframe(obj: bpy.types.Object | Any) -> None:
11 | if obj is not None:
12 | if obj.type == "MESH":
13 | # Gets the data that's not persistent when the Keyframe is added to the mesh
14 | remesh_voxel_size = obj.data.remesh_voxel_size
15 | remesh_voxel_adaptivity = obj.data.remesh_voxel_adaptivity
16 | symmetry_x = obj.data.use_mirror_x
17 | symmetry_y = obj.data.use_mirror_y
18 | symmetry_z = obj.data.use_mirror_z
19 |
20 | is_done = insert_mesh_keyframe_ex(obj)
21 | if is_done:
22 | fcurves = obj.animation_data.action.fcurves
23 | for fcurve in fcurves:
24 | if fcurve.data_path != '["sm_datablock"]':
25 | continue
26 | for kf in fcurve.keyframe_points:
27 | kf.interpolation = "CONSTANT"
28 | #
29 | if obj.type == "MESH":
30 | # Restores the values of the variables that are not persistent, from before the keyframe was added.
31 | obj.data.remesh_voxel_size = remesh_voxel_size
32 | obj.data.remesh_voxel_adaptivity = remesh_voxel_adaptivity
33 | bpy.context.object.data.use_mirror_x = symmetry_x
34 | bpy.context.object.data.use_mirror_y = symmetry_y
35 | bpy.context.object.data.use_mirror_z = symmetry_z
36 | #
37 | bpy.app.handlers.frame_change_post.clear()
38 | bpy.app.handlers.frame_change_post.append(update_stopmagic)
39 | handle_onion_skin(obj)
40 |
41 |
42 | def insert_mesh_keyframe_ex(obj: bpy.types.Object) -> bool:
43 | try:
44 | if obj.get("sm_id") is None:
45 | obj["sm_id"] = new_object_id()
46 | #
47 | object_sm_id = obj["sm_id"]
48 | ob_name_full = obj.name_full
49 | mesh_index = get_next_mesh_index(obj)
50 | mesh_name = ob_name_full + "_sm_" + str(mesh_index)
51 | del_mesh = []
52 | new_mesh = bpy.data.meshes.new_from_object(obj)
53 | new_mesh.name = mesh_name
54 | new_mesh["sm_id"] = object_sm_id
55 | new_mesh["sm_datablock"] = mesh_index
56 | obj.data = new_mesh
57 | obj.data.use_fake_user = True
58 | obj["sm_datablock"] = mesh_index
59 | obj.keyframe_insert(
60 | data_path='["sm_datablock"]', frame=bpy.context.scene.frame_current
61 | )
62 | for mesh in del_mesh:
63 | mesh.use_fake_user = False
64 | update_stopmagic(bpy.context.scene)
65 | for mesh in del_mesh:
66 | if mesh.users == 0:
67 | bpy.data.meshes.remove(mesh)
68 | #
69 | return True
70 | except:
71 | return False
72 |
73 |
74 | # Get the appropriate index for the mesh about to be created
75 | def get_next_mesh_index(obj: bpy.types.Object) -> int:
76 | if obj.get("sm_datablock") is not None:
77 | values = get_object_key_values(obj)
78 | if len(values) > 0:
79 | largest = values[0]
80 | for val in values:
81 | largest = val if val > largest else largest
82 | return largest + 1
83 | else:
84 | return 0
85 | else:
86 | return 0
87 |
--------------------------------------------------------------------------------
/stopmagic/functions/is_candidate_object.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | import bpy
3 |
4 |
5 | def is_candidate_object(context: bpy.types.Context | None) -> bool:
6 | if context is None:
7 | context = bpy.context
8 | if context.view_layer.objects.active is None:
9 | return False
10 | else:
11 | return context.view_layer.objects.active.type == "MESH"
12 |
--------------------------------------------------------------------------------
/stopmagic/functions/key_config.py:
--------------------------------------------------------------------------------
1 | from typing import List, Tuple
2 | import bpy
3 |
4 |
5 | def key_config() -> List[Tuple[bpy.types.KeyMap, bpy.types.KeyMapItem]]:
6 | result: List[Tuple[bpy.types.KeyMap, bpy.types.KeyMapItem]] = []
7 | kc = bpy.context.window_manager.keyconfigs.addon
8 | if kc:
9 | keyMapView = kc.keymaps.new(name="3D View", space_type="VIEW_3D")
10 | keyMapItem = keyMapView.keymap_items.new(
11 | "object.keyframe_mesh", type="A", value="PRESS", shift=True, ctrl=True
12 | )
13 | result.append((keyMapView, keyMapItem))
14 | keyMapItem = keyMapView.keymap_items.new(
15 | "object.frame_backward_keyframe_mesh",
16 | type="Z",
17 | value="PRESS",
18 | shift=True,
19 | ctrl=True,
20 | )
21 | result.append((keyMapView, keyMapItem))
22 | keyMapItem = keyMapView.keymap_items.new(
23 | "object.frame_forward_keyframe_mesh",
24 | type="X",
25 | value="PRESS",
26 | shift=True,
27 | ctrl=True,
28 | )
29 | result.append((keyMapView, keyMapItem))
30 | keyMapItem = keyMapView.keymap_items.new(
31 | "object.keyed_frame_previous",
32 | type="C",
33 | value="PRESS",
34 | shift=True,
35 | ctrl=True,
36 | )
37 | result.append((keyMapView, keyMapItem))
38 | keyMapItem = keyMapView.keymap_items.new(
39 | "object.keyed_frame_next",
40 | type="V",
41 | value="PRESS",
42 | shift=True,
43 | ctrl=True,
44 | )
45 | result.append((keyMapView, keyMapItem))
46 | return result
47 |
--------------------------------------------------------------------------------
/stopmagic/functions/new_object_id.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 |
4 | def new_object_id() -> int:
5 | max_id = 0
6 | for item in bpy.data.objects:
7 | if item.get("sm_id") is None:
8 | continue
9 | object_sm_id = item["sm_id"]
10 | if object_sm_id > max_id:
11 | max_id = object_sm_id
12 | return max_id + 1
--------------------------------------------------------------------------------
/stopmagic/functions/past_object.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 |
4 | def past_object_exists() -> bool:
5 | for item in bpy.context.view_layer.objects:
6 | if item.name == "sm_onion_past":
7 | return True
8 | return False
9 |
10 |
11 | def get_past_object(exists: bool) -> bpy.types.Object:
12 | """Get the past Onion Skin object depending on the provided value. Creates one if it doesn't exists already"""
13 | if not exists:
14 | pcache = bpy.data.meshes.new("sm_onion_past")
15 | pobject = bpy.data.objects.new(name="sm_onion_past", object_data=pcache)
16 | pobject.hide_select = True
17 | pobject.display.show_shadows = False
18 | pobject.hide_render = True
19 | return pobject
20 | else:
21 | return bpy.context.view_layer.objects.get("sm_onion_past")
--------------------------------------------------------------------------------
/stopmagic/functions/update_stopmagic.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 |
4 | @bpy.app.handlers.persistent
5 | def update_stopmagic(scene: bpy.types.Scene) -> None:
6 | for object in scene.objects:
7 | if object.get("sm_datablock") is None:
8 | continue
9 |
10 | object_sm_id = object["sm_id"]
11 | object_sm_datablock = object["sm_datablock"]
12 |
13 | final_mesh = None
14 | for mesh in bpy.data.meshes:
15 |
16 | # No stopmagic Datablock
17 | if mesh.get("sm_id") is None:
18 | continue
19 | mesh_sm_id = mesh["sm_id"]
20 | mesh_sm_datablock = mesh["sm_datablock"]
21 |
22 | # No stopmagic data for this object
23 | if mesh_sm_id != object_sm_id:
24 | continue
25 |
26 | # No stopmagic data for this frame
27 | if mesh_sm_datablock != object_sm_datablock:
28 | continue
29 |
30 | final_mesh = mesh
31 |
32 | if not final_mesh:
33 | continue
34 |
35 | object.data = final_mesh
--------------------------------------------------------------------------------
/stopmagic/icons.py:
--------------------------------------------------------------------------------
1 | import bpy
2 | import os.path
3 | import bpy.utils.previews
4 |
5 |
6 | addon_icons: bpy.utils.previews.ImagePreviewCollection = None
7 |
8 |
9 | class AddonIcons:
10 | @classmethod
11 | def paypal_color(cls):
12 | global addon_icons
13 | return addon_icons["PAYPAL_COLOR"]
14 |
15 | @classmethod
16 | def kofi_color(cls):
17 | global addon_icons
18 | return addon_icons["KOFI_COLOR"]
19 |
20 | @classmethod
21 | def github_color(cls):
22 | global addon_icons
23 | return addon_icons["GITHUB_COLOR"]
24 |
25 |
26 | def register():
27 | global addon_icons
28 | addon_icons = bpy.utils.previews.new()
29 | icons_dir = os.path.join(os.path.dirname(__file__), "icons")
30 | addon_icons.load("PAYPAL_COLOR", os.path.join(icons_dir, "paypal.png"), "IMAGE")
31 | addon_icons.load("KOFI_COLOR", os.path.join(icons_dir, "kofi.png"), "IMAGE")
32 | addon_icons.load("GITHUB_COLOR", os.path.join(icons_dir, "github.png"), "IMAGE")
33 |
34 |
35 | def unregister():
36 | global addon_icons
37 | bpy.utils.previews.remove(addon_icons)
38 |
--------------------------------------------------------------------------------
/stopmagic/icons/github.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aldrinmathew/stopmagic/e3e1a6c7f9943ef5e2a70cdc5cfecff5ac4f118e/stopmagic/icons/github.png
--------------------------------------------------------------------------------
/stopmagic/icons/kofi.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aldrinmathew/stopmagic/e3e1a6c7f9943ef5e2a70cdc5cfecff5ac4f118e/stopmagic/icons/kofi.png
--------------------------------------------------------------------------------
/stopmagic/icons/paypal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aldrinmathew/stopmagic/e3e1a6c7f9943ef5e2a70cdc5cfecff5ac4f118e/stopmagic/icons/paypal.png
--------------------------------------------------------------------------------
/stopmagic/operators/__init__.py:
--------------------------------------------------------------------------------
1 | from . import add_mesh_keyframe
2 | from . import initialize_handler
3 | from . import purge_unused_data
4 | from . import skip_frame_backward
5 | from . import skip_frame_forward
6 | from . import keyed_frame_next
7 | from . import keyed_frame_previous
8 | from . import upgrade_addon
9 | from . import contributions
10 |
11 | from .add_mesh_keyframe import AddMeshKeyframe
12 | from .initialize_handler import InitializeHandler
13 | from .purge_unused_data import PurgeUnusedData
14 | from .skip_frame_backward import SkipFrameBackward
15 | from .skip_frame_forward import SkipFrameForward
16 | from .keyed_frame_next import KeyedFrameNext
17 | from .keyed_frame_previous import KeyedFramePrevious
18 | from .upgrade_addon import UpgradeAddon
--------------------------------------------------------------------------------
/stopmagic/operators/add_mesh_keyframe.py:
--------------------------------------------------------------------------------
1 | import bpy
2 | from stopmagic.functions import insert_mesh_keyframe, is_candidate_object
3 |
4 |
5 | class AddMeshKeyframe(bpy.types.Operator):
6 | """Adds a Keyframe to the currently selected Mesh, after which you can edit the mesh to keep the changes"""
7 |
8 | bl_idname = "object.keyframe_mesh"
9 | bl_label = "Keyframe Mesh"
10 | bl_options = {"REGISTER", "UNDO"}
11 |
12 | @classmethod
13 | def poll(cls, context):
14 | return is_candidate_object(context)
15 |
16 | def execute(self, context: bpy.types.Context):
17 | if bpy.context.view_layer.objects.active is not None:
18 | ob = context.view_layer.objects.active
19 | insert_mesh_keyframe(ob)
20 | return {"FINISHED"}
21 |
22 |
23 | def register():
24 | bpy.utils.register_class(AddMeshKeyframe)
25 |
26 |
27 | def unregister():
28 | bpy.utils.unregister_class(AddMeshKeyframe)
29 |
--------------------------------------------------------------------------------
/stopmagic/operators/contributions.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import Set
3 | import webbrowser
4 | import bpy
5 |
6 |
7 | class AddonContributionPayPal(bpy.types.Operator):
8 | bl_idname = "stopmagic.contribution_paypal"
9 | bl_label = "Donate via Paypal"
10 | bl_description = "Support the addon by donating via PayPal"
11 |
12 | @classmethod
13 | def poll(cls, context: bpy.types.Context) -> bool:
14 | return True
15 |
16 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
17 | webbrowser.open_new_tab("https://paypal.me/aldrinsartfactory")
18 | return {"FINISHED"}
19 |
20 |
21 | class AddonContributionKofi(bpy.types.Operator):
22 | bl_idname = "stopmagic.contribution_kofi"
23 | bl_label = "Donate via Kofi"
24 | bl_description = "Support the addon by donating via ko-fi"
25 |
26 | @classmethod
27 | def poll(cls, context: bpy.types.Context) -> bool:
28 | return True
29 |
30 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
31 | webbrowser.open_new_tab("https://ko-fi.com/aldrinmathew")
32 | return {"FINISHED"}
33 |
34 |
35 | class AddonContributionGithub(bpy.types.Operator):
36 | bl_idname = "stopmagic.contribution_github"
37 | bl_label = "Contribute via Github"
38 | bl_description = "Support the addon by making contributions to Github"
39 |
40 | @classmethod
41 | def poll(cls, context: bpy.types.Context) -> bool:
42 | return True
43 |
44 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
45 | webbrowser.open_new_tab("https://github.com/aldrinsartfactory/stopmagic")
46 | return {"FINISHED"}
47 |
48 |
49 | def register() -> None:
50 | bpy.utils.register_class(AddonContributionPayPal)
51 | bpy.utils.register_class(AddonContributionKofi)
52 | bpy.utils.register_class(AddonContributionGithub)
53 |
54 |
55 | def unregister() -> None:
56 | bpy.utils.unregister_class(AddonContributionPayPal)
57 | bpy.utils.unregister_class(AddonContributionKofi)
58 | bpy.utils.unregister_class(AddonContributionGithub)
59 |
--------------------------------------------------------------------------------
/stopmagic/operators/initialize_handler.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 | from ..functions.handle_onion_skin import handle_onion_skin
4 | from ..functions.update_stopmagic import update_stopmagic
5 |
6 |
7 | class InitializeHandler(bpy.types.Operator):
8 | """If Stopmagic stops working try using this function to re-initialize it's frame handler"""
9 |
10 | bl_idname = "object.initialize_handler"
11 | bl_label = "Initialize Handler"
12 | bl_options = {"REGISTER"}
13 |
14 | @classmethod
15 | def poll(cls, context):
16 | return True
17 |
18 | def execute(self, context):
19 | bpy.app.handlers.frame_change_post.clear()
20 | bpy.app.handlers.frame_change_post.append(update_stopmagic)
21 | bpy.app.handlers.frame_change_pre.clear()
22 | bpy.app.handlers.frame_change_pre.append(handle_onion_skin)
23 | return {"FINISHED"}
24 |
25 |
26 | def register():
27 | bpy.utils.register_class(InitializeHandler)
28 |
29 |
30 | def unregister():
31 | bpy.utils.unregister_class(InitializeHandler)
32 |
--------------------------------------------------------------------------------
/stopmagic/operators/keyed_frame_next.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import List, Set
3 | import bpy
4 |
5 | from stopmagic.functions import get_object_keyframes, is_candidate_object
6 |
7 |
8 | class KeyedFrameNext(bpy.types.Operator):
9 | """Find and jump to the next frame that has a mesh keyframe for the current object"""
10 |
11 | bl_idname = "object.keyed_frame_next"
12 | bl_label = "Jump Next"
13 | bl_options = {"REGISTER", "UNDO"}
14 |
15 | @classmethod
16 | def poll(cls, context: bpy.types.Context) -> bool:
17 | return is_candidate_object(context)
18 |
19 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
20 | if context.view_layer.objects.active is not None:
21 | keyframes = get_object_keyframes(context.view_layer.objects.active)
22 | if len(keyframes) > 0:
23 | keyframes = [
24 | k for k in keyframes if k > bpy.context.scene.frame_current
25 | ]
26 | if len(keyframes) > 0:
27 | lowest = keyframes[0]
28 | for num in keyframes:
29 | if num < lowest:
30 | lowest = num
31 | context.scene.frame_current = lowest
32 | return {"FINISHED"}
33 |
34 |
35 | def register() -> None:
36 | bpy.utils.register_class(KeyedFrameNext)
37 |
38 |
39 | def unregister() -> None:
40 | bpy.utils.unregister_class(KeyedFrameNext)
41 |
--------------------------------------------------------------------------------
/stopmagic/operators/keyed_frame_previous.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import List, Set
3 | import bpy
4 |
5 | from stopmagic.functions import get_object_keyframes, is_candidate_object
6 |
7 |
8 | class KeyedFramePrevious(bpy.types.Operator):
9 | """Find and jump to the previous frame that has a mesh keyframe for the current object"""
10 |
11 | bl_idname = "object.keyed_frame_previous"
12 | bl_label = "Jump Previous"
13 | bl_options = {"REGISTER", "UNDO"}
14 |
15 | @classmethod
16 | def poll(cls, context: bpy.types.Context) -> bool:
17 | return is_candidate_object(context)
18 |
19 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
20 | if context.view_layer.objects.active is not None:
21 | keyframes = get_object_keyframes(context.view_layer.objects.active)
22 | if len(keyframes) > 0:
23 | keyframes = [
24 | k for k in keyframes if k < bpy.context.scene.frame_current
25 | ]
26 | if len(keyframes) > 0:
27 | highest = keyframes[0]
28 | for num in keyframes:
29 | if num > highest:
30 | highest = num
31 | context.scene.frame_current = highest
32 | return {"FINISHED"}
33 |
34 |
35 | def register() -> None:
36 | bpy.utils.register_class(KeyedFramePrevious)
37 |
38 |
39 | def unregister() -> None:
40 | bpy.utils.unregister_class(KeyedFramePrevious)
41 |
--------------------------------------------------------------------------------
/stopmagic/operators/purge_unused_data.py:
--------------------------------------------------------------------------------
1 | import bpy
2 | from ..functions.update_stopmagic import *
3 |
4 |
5 | class PurgeUnusedData(bpy.types.Operator):
6 | """Deletes all unushed Mesh data created by the addon"""
7 |
8 | bl_idname = "object.purge_unused_data"
9 | bl_label = "Purge Unused Data"
10 |
11 | @classmethod
12 | def poll(cls, context):
13 | return True
14 |
15 | def execute(self, context):
16 | used_sm_mesh = {}
17 |
18 | for item in bpy.data.objects:
19 | ob: bpy.types.Object = item
20 | if ob.get("sm_id") is None:
21 | continue
22 |
23 | sm_id = ob.get("sm_id")
24 | used_sm_mesh[sm_id] = []
25 |
26 | fcurves = ob.animation_data.action.fcurves
27 | for item in fcurves:
28 | fcurve: bpy.types.FCurve = item
29 | if fcurve.data_path != '["sm_datablock"]':
30 | continue
31 | #
32 | keyframe_points = fcurve.keyframe_points
33 | for item in keyframe_points:
34 | keyframe: bpy.types.Keyframe = item
35 | used_sm_mesh[sm_id].append(keyframe.co.y)
36 |
37 | delete_mesh = []
38 |
39 | for mesh in bpy.data.meshes:
40 | if mesh.get("sm_id") is None:
41 | continue
42 |
43 | mesh_sm_id = mesh.get("sm_id")
44 |
45 | if mesh_sm_id not in used_sm_mesh:
46 | delete_mesh.append(mesh)
47 | continue
48 |
49 | mesh_sm_datablock = mesh.get("sm_datablock")
50 |
51 | if mesh_sm_datablock not in used_sm_mesh[mesh_sm_id]:
52 | delete_mesh.append(mesh)
53 | continue
54 |
55 | if len(delete_mesh) == 0:
56 | self.report({'INFO'}, 'No meshes were removed by Stopmagic')
57 | else:
58 | self.report({'INFO'}, str(len(delete_mesh)) + ' meshes were removed by Stopmagic')
59 | for mesh in delete_mesh:
60 | mesh.use_fake_user = False
61 |
62 | update_stopmagic(bpy.context.scene)
63 |
64 | for mesh in delete_mesh:
65 | if mesh.users == 0:
66 | bpy.data.meshes.remove(mesh)
67 |
68 | return {"FINISHED"}
69 |
70 |
71 | def register():
72 | bpy.utils.register_class(PurgeUnusedData)
73 |
74 |
75 | def unregister():
76 | bpy.utils.unregister_class(PurgeUnusedData)
77 |
--------------------------------------------------------------------------------
/stopmagic/operators/skip_frame_backward.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import Set
3 | import bpy
4 | from stopmagic.functions import insert_mesh_keyframe, is_candidate_object
5 |
6 |
7 | class SkipFrameBackward(bpy.types.Operator):
8 | """Skips frames backward based on the number of frames entered by the user."""
9 |
10 | bl_idname = "object.frame_backward_keyframe_mesh"
11 | bl_label = "Skip Frame"
12 | bl_options = {"REGISTER", "UNDO"}
13 |
14 | @classmethod
15 | def poll(cls, context: bpy.types.Context) -> bool:
16 | return is_candidate_object(context)
17 |
18 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
19 | count = 3
20 | try:
21 | count = context.scene.stopmagic_frame_skip_count
22 | except Exception as _:
23 | count = 3
24 | if bpy.context.view_layer.objects.active is not None:
25 | active = context.view_layer.objects.active
26 | if active is not None:
27 | bpy.context.scene.frame_current -= count
28 | if context.scene.stopmagic_insert_frame_after_skip:
29 | insert_mesh_keyframe(active)
30 | return {"FINISHED"}
31 |
32 |
33 | def register():
34 | bpy.utils.register_class(SkipFrameBackward)
35 |
36 |
37 | def unregister():
38 | bpy.utils.unregister_class(SkipFrameBackward)
39 |
--------------------------------------------------------------------------------
/stopmagic/operators/skip_frame_forward.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | import bpy
3 | from stopmagic.functions import insert_mesh_keyframe, is_candidate_object
4 | from typing import Set
5 |
6 |
7 | class SkipFrameForward(bpy.types.Operator):
8 | """Skips frames forward based on the number of frames entered by the user."""
9 |
10 | bl_idname = "object.frame_forward_keyframe_mesh"
11 | bl_label = "Skip Frame"
12 | bl_options = {"REGISTER", "UNDO"}
13 |
14 | @classmethod
15 | def poll(cls, context: bpy.types.Context) -> bool:
16 | return is_candidate_object(context)
17 |
18 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
19 | count = 3
20 | try:
21 | count = context.scene.stopmagic_frame_skip_count
22 | except Exception as _:
23 | count = 3
24 | if bpy.context.view_layer.objects.active is not None:
25 | active = context.view_layer.objects.active
26 | if active is not None:
27 | bpy.context.scene.frame_current += count
28 | if context.scene.stopmagic_insert_frame_after_skip:
29 | insert_mesh_keyframe(active)
30 | return {"FINISHED"}
31 |
32 |
33 | def register():
34 | bpy.utils.register_class(SkipFrameForward)
35 |
36 |
37 | def unregister():
38 | bpy.utils.unregister_class(SkipFrameForward)
39 |
--------------------------------------------------------------------------------
/stopmagic/operators/upgrade_addon.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import Set
3 | import webbrowser
4 | import bpy
5 |
6 |
7 | class UpgradeAddon(bpy.types.Operator):
8 | """Gets you to the page with the latest version of the addon"""
9 |
10 | bl_idname = "stopmagic.upgrade_addon"
11 | bl_label = "Check Updates"
12 | bl_description = "Tries to download the latest version of the addon via the browser. If that's not available, this will open the Releases page of the addon"
13 |
14 | tag_name = None
15 |
16 | @staticmethod
17 | def set_tag_name(value: str) -> None:
18 | UpgradeAddon.tag_name = value
19 |
20 | @classmethod
21 | def poll(cls, context: bpy.types.context) -> bool:
22 | return True
23 |
24 | def execute(self, context: bpy.types.Context) -> Set[int] | Set[str]:
25 | if self.tag_name is None:
26 | webbrowser.open_new_tab(
27 | "https://github.com/aldrinsartfactory/stopmagic/releases"
28 | )
29 | else:
30 | webbrowser.open_new_tab(
31 | "https://github.com/aldrinsartfactory/stopmagic/releases/download/"
32 | + self.tag_name
33 | + "/stopmagic.zip"
34 | )
35 | return {"FINISHED"}
36 |
37 |
38 | def register():
39 | bpy.utils.register_class(UpgradeAddon)
40 |
41 |
42 | def unregister():
43 | bpy.utils.unregister_class(UpgradeAddon)
44 |
--------------------------------------------------------------------------------
/stopmagic/panel.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 | from typing import Any
3 | import bpy
4 | from stopmagic import functions
5 | import requests
6 | from stopmagic.operators import UpgradeAddon
7 | from stopmagic.icons import AddonIcons
8 |
9 |
10 | addon_info = {}
11 |
12 |
13 | def addon_remote_version() -> str | None:
14 | global addon_info
15 | if addon_info is not None:
16 | if addon_info.get("tag_name") is not None:
17 | return addon_info.get("tag_name")
18 | return None
19 |
20 |
21 | class StopmagicPanel(bpy.types.Panel):
22 | bl_idname = "VIEW3D_PT_stopmagic_panel"
23 | bl_label = "Stopmagic"
24 | bl_category = "Stopmagic"
25 | bl_space_type = "VIEW_3D"
26 | bl_region_type = "UI"
27 |
28 | # For showing version to the user
29 | bl_info: "dict[str, Any]" = {}
30 | expand_find_frame = True
31 | expand_frame_skip = True
32 | expand_onion_skin = True
33 | expand_status_options = False
34 |
35 | @staticmethod
36 | def set_info(info: "dict[str, Any]"):
37 | StopmagicPanel.bl_info = info
38 |
39 | def draw(self, context: bpy.context):
40 | if addon_remote_version() is not None:
41 | if "v" + functions.addon_version(self.bl_info) != addon_remote_version():
42 | column = self.layout.column()
43 | box = column.box()
44 | box.label(
45 | text="v"
46 | + functions.addon_version(StopmagicPanel.bl_info)
47 | + " to "
48 | + addon_remote_version()
49 | )
50 | box.operator(
51 | "stopmagic.upgrade_addon", text="Upgrade Addon", icon="URL"
52 | )
53 | self.layout.separator()
54 | # SECTION :: Keyframe Mesh
55 | if not functions.is_candidate_object(context):
56 | if context.view_layer.objects.active is not None:
57 | self.layout.column().label(text="NO ACTIVE MESH OBJECT!!", icon="ERROR")
58 | else:
59 | self.layout.column().label(text="NO ACTIVE OBJECT!!", icon="ERROR")
60 | column = self.layout.column()
61 | column.scale_y = 1.5
62 | column.operator("object.keyframe_mesh", text="Keyframe Mesh")
63 | self.layout.separator()
64 | # SECTION :: Find Keyed Frame
65 | column = self.layout.column()
66 | box = column.box()
67 | row = box.row()
68 | row.label(text="Find Keyed Frame", icon="ZOOM_PREVIOUS")
69 | row.prop(
70 | context.scene,
71 | "stopmagic_expand_find_frame",
72 | icon="TRIA_UP"
73 | if context.scene.stopmagic_expand_find_frame
74 | else "TRIA_DOWN",
75 | emboss=False,
76 | )
77 | if context.scene.stopmagic_expand_find_frame:
78 | row = box.row()
79 | row.operator("object.keyed_frame_previous", text="Previous", icon_value=499)
80 | row.operator("object.keyed_frame_next", text="Next", icon_value=500)
81 | self.layout.separator()
82 | # SECTION :: Frame Skip
83 | column = self.layout.column()
84 | box = column.box()
85 | row = box.row()
86 | row.label(text="Frame Skip", icon="TRACKING_FORWARDS")
87 | row.prop(
88 | context.scene,
89 | "stopmagic_expand_frame_skip",
90 | icon="TRIA_UP"
91 | if context.scene.stopmagic_expand_frame_skip
92 | else "TRIA_DOWN",
93 | emboss=False,
94 | )
95 | if context.scene.stopmagic_expand_frame_skip:
96 | box.prop(context.scene, "stopmagic_insert_frame_after_skip")
97 | box.prop(context.scene, "stopmagic_frame_skip_count")
98 | column = box.column()
99 | column.scale_y = 1.5
100 | row = column.row(align=False)
101 | row.alignment = "EXPAND"
102 | row.operator(
103 | "object.frame_backward_keyframe_mesh",
104 | text=r"Backward",
105 | emboss=True,
106 | depress=False,
107 | icon_value=6,
108 | )
109 | row.operator(
110 | "object.frame_forward_keyframe_mesh",
111 | text=r"Forward",
112 | emboss=True,
113 | depress=False,
114 | icon_value=4,
115 | )
116 | self.layout.separator()
117 | # SECTION :: Onion Skin
118 | column = self.layout.column()
119 | box = column.box()
120 | row = box.row()
121 | row.label(text="Onion Skin", icon="GHOST_ENABLED")
122 | row.prop(
123 | context.scene,
124 | "stopmagic_expand_onion_skin",
125 | icon="TRIA_UP"
126 | if context.scene.stopmagic_expand_onion_skin
127 | else "TRIA_DOWN",
128 | emboss=False,
129 | )
130 | if context.scene.stopmagic_expand_onion_skin:
131 | box.prop(context.scene, "stopmagic_onion_skin_enabled")
132 | if context.scene.stopmagic_onion_skin_enabled:
133 | box.prop(context.scene, "stopmagic_onion_display_type")
134 | row = box.row()
135 | lcolumn = row.column()
136 | lcolumn.label(text="Past")
137 | if context.scene.stopmagic_onion_display_type == "POSE":
138 | lcolumn.prop(context.scene, "stopmagic_past_count")
139 | else:
140 | lcolumn.prop(context.scene, "stopmagic_past_offset")
141 | lcolumn.prop(context.scene, "stopmagic_past_color")
142 | rcolumn = row.column()
143 | rcolumn.label(text="Future")
144 | if context.scene.stopmagic_onion_display_type == "POSE":
145 | rcolumn.prop(context.scene, "stopmagic_future_count")
146 | else:
147 | rcolumn.prop(context.scene, "stopmagic_future_offset")
148 | rcolumn.prop(context.scene, "stopmagic_future_color")
149 | self.layout.separator()
150 | # SECTION :: Contribution
151 | column = self.layout.column()
152 | box = column.box()
153 | row = box.row()
154 | row.label(text="Make a contribution", icon="FUND")
155 | row.prop(
156 | context.scene,
157 | "stopmagic_expand_contributions",
158 | icon="TRIA_UP"
159 | if context.scene.stopmagic_expand_contributions
160 | else "TRIA_DOWN",
161 | emboss=False,
162 | )
163 | if context.scene.stopmagic_expand_contributions:
164 | row = box.row()
165 | row.operator(
166 | "stopmagic.contribution_paypal",
167 | text="PayPal",
168 | icon_value=AddonIcons.paypal_color().icon_id,
169 | )
170 | row.operator(
171 | "stopmagic.contribution_kofi",
172 | text="Ko-Fi",
173 | icon_value=AddonIcons.kofi_color().icon_id,
174 | )
175 | box.operator(
176 | "stopmagic.contribution_github",
177 | text="Github",
178 | icon_value=AddonIcons.github_color().icon_id,
179 | )
180 | self.layout.separator()
181 | # SECTION :: Status Options
182 | column = self.layout.column()
183 | box = column.box()
184 | row = box.row()
185 | row.label(text="Status Options", icon="TOOL_SETTINGS")
186 | row.prop(
187 | context.scene,
188 | "stopmagic_expand_status_options",
189 | icon="TRIA_UP"
190 | if context.scene.stopmagic_expand_status_options
191 | else "TRIA_DOWN",
192 | emboss=False,
193 | )
194 | if context.scene.stopmagic_expand_status_options:
195 | box.operator(
196 | "object.purge_unused_data", text="Purge Unused Data", icon="TRASH"
197 | )
198 | box.operator(
199 | "object.initialize_handler",
200 | text="Initialize Frame Handler",
201 | icon="FILE_REFRESH",
202 | )
203 | # Fallback upgrade button in case of connectivity issues or invalid responses
204 | if addon_remote_version() is None:
205 | self.layout.separator()
206 | column = self.layout.column()
207 | box = column.box()
208 | box.label(text="v" + functions.addon_version(StopmagicPanel.bl_info))
209 | box.operator("stopmagic.upgrade_addon", text="Upgrade Addon", icon="URL")
210 |
211 |
212 | def register() -> None:
213 | global addon_info
214 | bpy.utils.register_class(StopmagicPanel)
215 | try:
216 | resp = requests.get(
217 | url="https://api.github.com/repos/aldrinsartfactory/stopmagic/releases/latest",
218 | timeout=5,
219 | )
220 | if resp.status_code == 200:
221 | addon_info = resp.json()
222 | if addon_remote_version() is not None:
223 | UpgradeAddon.set_tag_name(addon_remote_version())
224 | except:
225 | print("Exception while fetching addon data")
226 |
227 |
228 | def unregister() -> None:
229 | bpy.utils.unregister_class(StopmagicPanel)
230 |
--------------------------------------------------------------------------------
/stopmagic/preferences.py:
--------------------------------------------------------------------------------
1 | import bpy
2 |
3 | from stopmagic.functions import (
4 | get_preferences,
5 | change_onion_color,
6 | clear_onion_data,
7 | handle_onion_skin,
8 | )
9 |
10 |
11 | def handle_onion_enable(self, value) -> None:
12 | if bpy.context.scene.stopmagic_onion_skin_enabled:
13 | handle_onion_skin(bpy.context.scene)
14 | else:
15 | clear_onion_data()
16 |
17 |
18 | def handle_past_color(self, value) -> None:
19 | change_onion_color(True, bpy.context.scene.stopmagic_past_color)
20 |
21 |
22 | def handle_future_color(self, value) -> None:
23 | change_onion_color(False, bpy.context.scene.stopmagic_future_color)
24 |
25 |
26 | def handle_display(self, value) -> None:
27 | handle_onion_skin(bpy.context.scene)
28 |
29 |
30 | class StopmagicPreferences(bpy.types.AddonPreferences):
31 | """Preferences for the Stopmagic addon"""
32 |
33 | bl_idname = __package__
34 |
35 | frame_skip_count: bpy.props.IntProperty(
36 | name="Frame Skip Count",
37 | description="Skip this many frames forwards or backwards",
38 | subtype="NONE",
39 | options=set(),
40 | default=3,
41 | min=1,
42 | max=2**31 - 1,
43 | soft_min=1,
44 | soft_max=100,
45 | step=1,
46 | )
47 | insert_keyframe_after_skip: bpy.props.BoolProperty(
48 | name="Insert Keyframe after Skip",
49 | description="Whether to insert keyframe after skipping frames",
50 | options=set(),
51 | default=True,
52 | )
53 | onion_skin_enabled: bpy.props.BoolProperty(
54 | name="Enable Onion Skin",
55 | description="Whether onion skins should be displayed",
56 | options=set(),
57 | default=False,
58 | )
59 | past_color: bpy.props.FloatVectorProperty(
60 | name="Color",
61 | description="Color to be used for past frames of the Onion Skin",
62 | subtype="COLOR_GAMMA",
63 | size=4,
64 | default=(1.0, 0.0, 0.0, 0.3),
65 | )
66 | future_color: bpy.props.FloatVectorProperty(
67 | name="Color",
68 | description="Color to be used for future frames of the Onion Skin",
69 | subtype="COLOR_GAMMA",
70 | size=4,
71 | default=(0.0, 0.0, 1.0, 0.3),
72 | )
73 | onion_display_type: bpy.props.EnumProperty(
74 | items=[
75 | (
76 | "POSE",
77 | "Pose",
78 | "Display a specific number of poses before or after the current frame",
79 | "CON_ACTION",
80 | 0,
81 | ),
82 | (
83 | "RANGE",
84 | "Range",
85 | "Display all poses within a range before or after the current frame",
86 | "ARROW_LEFTRIGHT",
87 | 1,
88 | ),
89 | ],
90 | name="Display Type",
91 | description="Change the type of display for the onion skin",
92 | options=set(),
93 | default="POSE",
94 | )
95 | past_offset: bpy.props.IntProperty(
96 | name="Offset",
97 | description="Show onion skins for these many frames before the current frame",
98 | subtype="NONE",
99 | options=set(),
100 | default=10,
101 | min=0,
102 | max=200,
103 | soft_min=0,
104 | soft_max=100,
105 | step=1,
106 | )
107 | past_count: bpy.props.IntProperty(
108 | name="Past Count",
109 | description="Show onion skins for this many mesh poses, before the current frame",
110 | subtype="NONE",
111 | options=set(),
112 | default=1,
113 | min=1,
114 | max=100,
115 | soft_min=1,
116 | soft_max=10,
117 | step=1,
118 | )
119 | future_offset: bpy.props.IntProperty(
120 | name="Offset",
121 | description="Show onion skins for these many frames after the current frame",
122 | subtype="NONE",
123 | options=set(),
124 | default=10,
125 | min=0,
126 | max=200,
127 | soft_min=0,
128 | soft_max=100,
129 | step=1,
130 | )
131 | future_count: bpy.props.IntProperty(
132 | name="Future Count",
133 | description="Show onion skins for this many mesh poses, after the current frame",
134 | subtype="NONE",
135 | options=set(),
136 | default=1,
137 | min=1,
138 | max=100,
139 | soft_min=1,
140 | soft_max=10,
141 | step=1,
142 | )
143 |
144 | def draw(self, context: bpy.types.Context):
145 | self.layout.label(text="These settings will be used when you create a new file")
146 | self.layout.prop(self, "insert_keyframe_after_skip")
147 | row = self.layout.row()
148 | column = row.column()
149 | column.prop(self, "frame_skip_count")
150 | column.separator()
151 | column = self.layout.column()
152 | column.label(text="Onion Skin Options")
153 | column.prop(self, "onion_skin_enabled")
154 | column.prop(self, "onion_display_type")
155 | row = column.row()
156 | lcolumn = row.column()
157 | lcolumn.label(text="Past")
158 | lcolumn.prop(self, "past_count")
159 | lcolumn.prop(self, "past_offset")
160 | lcolumn.prop(self, "past_color")
161 | rcolumn = row.column()
162 | rcolumn.label(text="Future")
163 | rcolumn.prop(self, "future_count")
164 | rcolumn.prop(self, "future_offset")
165 | rcolumn.prop(self, "future_color")
166 |
167 |
168 | def register_properties() -> None:
169 | bpy.types.Scene.stopmagic_frame_skip_count = bpy.props.IntProperty(
170 | name="Frame Count",
171 | description="Skip this many frames forwards or backwards",
172 | subtype="NONE",
173 | options=set(),
174 | default=get_preferences(__package__).frame_skip_count,
175 | min=1,
176 | max=2**31 - 1,
177 | soft_min=1,
178 | soft_max=100,
179 | step=1,
180 | )
181 | bpy.types.Scene.stopmagic_onion_display_type = bpy.props.EnumProperty(
182 | items=[
183 | (
184 | "POSE",
185 | "Pose",
186 | "Display a specific number of poses before or after the current frame",
187 | "CON_ACTION",
188 | 0,
189 | ),
190 | (
191 | "RANGE",
192 | "Range",
193 | "Display all poses within a range before or after the current frame",
194 | "ARROW_LEFTRIGHT",
195 | 1,
196 | ),
197 | ],
198 | name="Display",
199 | description="Change the type of display for the onion skin",
200 | options=set(),
201 | default=get_preferences(__package__).onion_display_type,
202 | update=handle_display,
203 | )
204 | bpy.types.Scene.stopmagic_past_count = bpy.props.IntProperty(
205 | name="Poses",
206 | description="Show onion skins for this many mesh poses, before the current frame",
207 | subtype="NONE",
208 | options=set(),
209 | default=get_preferences(__package__).past_count,
210 | min=1,
211 | max=100,
212 | soft_min=1,
213 | soft_max=10,
214 | step=1,
215 | update=handle_display,
216 | )
217 | bpy.types.Scene.stopmagic_past_offset = bpy.props.IntProperty(
218 | name="Offset",
219 | description="Show keyed meshes in these many frames before the current frame",
220 | subtype="NONE",
221 | options=set(),
222 | default=get_preferences(__package__).past_offset,
223 | min=0,
224 | max=200,
225 | soft_min=0,
226 | soft_max=100,
227 | step=1,
228 | update=handle_display,
229 | )
230 | bpy.types.Scene.stopmagic_future_count = bpy.props.IntProperty(
231 | name="Poses",
232 | description="Show onion skins for this many mesh poses, after the current frame",
233 | subtype="NONE",
234 | options=set(),
235 | default=get_preferences(__package__).future_count,
236 | min=1,
237 | max=100,
238 | soft_min=1,
239 | soft_max=10,
240 | step=1,
241 | update=handle_display,
242 | )
243 | bpy.types.Scene.stopmagic_future_offset = bpy.props.IntProperty(
244 | name="Offset",
245 | description="Show keyed meshes in these many frames after the current frame",
246 | subtype="NONE",
247 | options=set(),
248 | default=get_preferences(__package__).future_offset,
249 | min=0,
250 | max=200,
251 | soft_min=0,
252 | soft_max=100,
253 | step=1,
254 | update=handle_display,
255 | )
256 | bpy.types.Scene.stopmagic_past_color = bpy.props.FloatVectorProperty(
257 | name="",
258 | description="Color for past frames of the Onion Skin",
259 | subtype="COLOR_GAMMA",
260 | size=4,
261 | default=get_preferences(__package__).past_color,
262 | update=handle_past_color,
263 | )
264 | bpy.types.Scene.stopmagic_future_color = bpy.props.FloatVectorProperty(
265 | name="",
266 | description="Color for future frames of the Onion State",
267 | subtype="COLOR_GAMMA",
268 | size=4,
269 | default=get_preferences(__package__).future_color,
270 | update=handle_future_color,
271 | )
272 | bpy.types.Scene.stopmagic_onion_skin_enabled = bpy.props.BoolProperty(
273 | name="Enable (Experimental)",
274 | description="Whether Onion Skins should be displayed",
275 | options=set(),
276 | default=get_preferences(__package__).onion_skin_enabled,
277 | update=handle_onion_enable,
278 | )
279 | bpy.types.Scene.stopmagic_insert_frame_after_skip = bpy.props.BoolProperty(
280 | name="Insert Keyframe",
281 | description="Whether to insert keyframe after skipping frames",
282 | options=set(),
283 | default=get_preferences(__package__).insert_keyframe_after_skip,
284 | )
285 | bpy.types.Scene.stopmagic_expand_find_frame = bpy.props.BoolProperty(
286 | name="",
287 | description="",
288 | options=set(),
289 | default=True,
290 | )
291 | bpy.types.Scene.stopmagic_expand_frame_skip = bpy.props.BoolProperty(
292 | name="",
293 | description="",
294 | options=set(),
295 | default=True,
296 | )
297 | bpy.types.Scene.stopmagic_expand_onion_skin = bpy.props.BoolProperty(
298 | name="",
299 | description="",
300 | options=set(),
301 | default=False,
302 | )
303 | bpy.types.Scene.stopmagic_expand_contributions = bpy.props.BoolProperty(
304 | name="",
305 | description="",
306 | options=set(),
307 | default=True,
308 | )
309 | bpy.types.Scene.stopmagic_expand_status_options = bpy.props.BoolProperty(
310 | name="",
311 | description="",
312 | options=set(),
313 | default=False,
314 | )
315 |
316 |
317 | def unregister_properties() -> None:
318 | del bpy.types.Scene.stopmagic_frame_skip_count
319 | del bpy.types.Scene.stopmagic_insert_frame_after_skip
320 | del bpy.types.Scene.stopmagic_past_offset
321 | del bpy.types.Scene.stopmagic_past_count
322 | del bpy.types.Scene.stopmagic_future_offset
323 | del bpy.types.Scene.stopmagic_future_count
324 | del bpy.types.Scene.stopmagic_past_color
325 | del bpy.types.Scene.stopmagic_future_color
326 | del bpy.types.Scene.stopmagic_onion_skin_enabled
327 | del bpy.types.Scene.stopmagic_expand_find_frame
328 | del bpy.types.Scene.stopmagic_expand_frame_skip
329 | del bpy.types.Scene.stopmagic_expand_onion_skin
330 | del bpy.types.Scene.stopmagic_expand_contributions
331 | del bpy.types.Scene.stopmagic_expand_status_options
332 |
333 |
334 | def register() -> None:
335 | bpy.utils.register_class(StopmagicPreferences)
336 | register_properties()
337 |
338 |
339 | def unregister() -> None:
340 | bpy.utils.unregister_class(StopmagicPreferences)
341 | unregister_properties()
342 |
343 |
344 | if __name__ == "__main__":
345 | register()
346 |
--------------------------------------------------------------------------------