forked from NatronGitHub/Natron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathKnob.cpp
6514 lines (5606 loc) · 191 KB
/
Knob.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* ***** BEGIN LICENSE BLOCK *****
* This file is part of Natron <https://natrongithub.github.io/>,
* (C) 2018-2021 The Natron developers
* (C) 2013-2018 INRIA and Alexandre Gauthier-Foichat
*
* Natron is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Natron is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Natron. If not, see <http://www.gnu.org/licenses/gpl-2.0.html>
* ***** END LICENSE BLOCK ***** */
// ***** BEGIN PYTHON BLOCK *****
// from <https://docs.python.org/3/c-api/intro.html#include-files>:
// "Since Python may define some pre-processor definitions which affect the standard headers on some systems, you must include Python.h before any standard headers are included."
#include <Python.h>
// ***** END PYTHON BLOCK *****
#include "Knob.h"
#include "KnobImpl.h"
#include <algorithm> // min, max
#include <cassert>
#include <stdexcept>
#include <sstream> // stringstream
#include <cctype> // isspace
#include <QtCore/QDataStream>
#include <QtCore/QDateTime>
#include <QtCore/QByteArray>
#include <QtCore/QCoreApplication>
#include <QtCore/QThread>
#include <QtCore/QDebug>
#include "Global/GlobalDefines.h"
#include "Engine/AppInstance.h"
#include "Engine/AppManager.h"
#include "Engine/Curve.h"
#include "Engine/DockablePanelI.h"
#include "Engine/Hash64.h"
#include "Engine/KnobFile.h"
#include "Engine/KnobGuiI.h"
#include "Engine/KnobSerialization.h"
#include "Engine/KnobTypes.h"
#include "Engine/LibraryBinary.h"
#include "Engine/Node.h"
#include "Engine/Project.h"
#include "Engine/StringAnimationManager.h"
#include "Engine/TLSHolder.h"
#include "Engine/TimeLine.h"
#include "Engine/TrackMarker.h"
#include "Engine/TrackerContext.h"
#include "Engine/Transform.h"
#include "Engine/ViewIdx.h"
#include "Engine/ViewerInstance.h"
#include "Engine/EngineFwd.h"
NATRON_NAMESPACE_ENTER
using std::make_pair; using std::pair;
KnobSignalSlotHandler::KnobSignalSlotHandler(const KnobIPtr& knob)
: QObject()
, k(knob)
{
}
void
KnobSignalSlotHandler::onAnimationRemoved(ViewSpec view,
int dimension)
{
getKnob()->onAnimationRemoved(view, dimension);
}
void
KnobSignalSlotHandler::onMasterKeyFrameSet(double time,
ViewSpec view,
int dimension,
int reason,
bool added)
{
KnobSignalSlotHandler* handler = qobject_cast<KnobSignalSlotHandler*>( sender() );
assert(handler);
KnobIPtr master = handler->getKnob();
getKnob()->clone(master.get(), dimension);
Q_EMIT keyFrameSet(time, view, dimension, reason, added);
}
void
KnobSignalSlotHandler::onMasterKeyFrameRemoved(double time,
ViewSpec view,
int dimension,
int reason)
{
KnobSignalSlotHandler* handler = qobject_cast<KnobSignalSlotHandler*>( sender() );
assert(handler);
KnobIPtr master = handler->getKnob();
getKnob()->clone(master.get(), dimension);
Q_EMIT keyFrameRemoved(time, view, dimension, reason);
}
void
KnobSignalSlotHandler::onMasterKeyFrameMoved(ViewSpec view,
int dimension,
double oldTime,
double newTime)
{
KnobSignalSlotHandler* handler = qobject_cast<KnobSignalSlotHandler*>( sender() );
assert(handler);
KnobIPtr master = handler->getKnob();
getKnob()->clone(master.get(), dimension);
Q_EMIT keyFrameMoved(view, dimension, oldTime, newTime);
}
void
KnobSignalSlotHandler::onMasterAnimationRemoved(ViewSpec view,
int dimension)
{
KnobSignalSlotHandler* handler = qobject_cast<KnobSignalSlotHandler*>( sender() );
assert(handler);
KnobIPtr master = handler->getKnob();
getKnob()->clone(master.get(), dimension);
Q_EMIT animationRemoved(view, dimension);
}
/***************** KNOBI**********************/
bool
KnobI::slaveTo(int dimension,
const KnobIPtr & other,
int otherDimension,
bool ignoreMasterPersistence)
{
return slaveToInternal(dimension, other, otherDimension, eValueChangedReasonNatronInternalEdited, ignoreMasterPersistence);
}
static KnobIPtr
findMaster(const KnobIPtr & knob,
const NodesList & allNodes,
const std::string& masterNodeNameFull,
const std::string& masterNodeName,
const std::string& masterTrackName,
const std::string& masterKnobName,
const std::map<std::string, std::string>& oldNewScriptNamesMapping)
{
///we need to cycle through all the nodes of the project to find the real master
NodePtr masterNode;
qDebug() << "Link slave/master for" << knob->getName().c_str() << "restoring linkage" << masterNodeNameFull.c_str() << '|' << masterNodeName.c_str() << '/' << masterTrackName.c_str() << '/' << masterKnobName.c_str();
/*
When copy pasting, the new node copied has a script-name different from what is inside the serialization because 2
nodes cannot co-exist with the same script-name. We keep in the map the script-names mapping.
oldNewScriptNamesMapping is set in NodeGraphPrivate::pasteNode()
*/
std::string masterNodeNameToFind = masterNodeName;
std::string masterNodeNameFullToFind = masterNodeNameFull;
{
std::map<std::string, std::string>::const_iterator foundMapping = oldNewScriptNamesMapping.find(masterNodeName);
if ( foundMapping != oldNewScriptNamesMapping.end() ) {
// found it!
// first, replace the last past of the full name
if (!masterNodeNameFull.empty()) {
std::size_t found = masterNodeNameFullToFind.find_last_of('.');
if (found != std::string::npos && masterNodeNameFullToFind.substr(found+1) == masterNodeName) {
masterNodeNameFullToFind = masterNodeNameFullToFind.substr(0, found+1) + foundMapping->second;
}
}
// then update masterNodeNameToFind
masterNodeNameToFind = foundMapping->second;
}
}
// The following is probably useless: NodeGraphPrivate::pasteNode() only uses the node name, not the fully qualified name.
// Let us still do that check.
{
std::map<std::string, std::string>::const_iterator foundMapping = oldNewScriptNamesMapping.find(masterNodeNameFull.empty() ? masterNodeName : masterNodeNameFull);
if ( foundMapping != oldNewScriptNamesMapping.end() ) {
masterNodeNameFullToFind = foundMapping->second;
}
}
if (masterNodeNameFullToFind.empty()) {
masterNodeNameFullToFind = masterNodeNameToFind;
}
for (NodesList::const_iterator it2 = allNodes.begin(); it2 != allNodes.end(); ++it2) {
qDebug() << "Trying node" << (*it2)->getScriptName().c_str() << '/' << (*it2)->getFullyQualifiedName().c_str();
if ( (*it2)->getFullyQualifiedName() == masterNodeNameFullToFind ) {
masterNode = *it2;
break;
}
}
if (!masterNode) {
qDebug() << "Link slave/master for" << knob->getName().c_str() << "could not find master node" << masterNodeNameFullToFind.c_str() << "trying without the group name (Natron project files before 2.3.16)...";
for (NodesList::const_iterator it2 = allNodes.begin(); it2 != allNodes.end(); ++it2) {
qDebug() << "Trying node" << (*it2)->getScriptName().c_str() << '/' << (*it2)->getFullyQualifiedName().c_str();
if ( (*it2)->getScriptName() == masterNodeNameToFind ) {
masterNode = *it2;
qDebug() << "Got node" << (*it2)->getFullyQualifiedName().c_str();
break;
}
}
}
if (!masterNode) {
qDebug() << "Link slave/master for" << knob->getName().c_str() << "could not find master node" << masterNodeNameFullToFind.c_str() << '|' << masterNodeNameToFind.c_str();
return KnobIPtr();
}
if ( !masterTrackName.empty() ) {
TrackerContextPtr context = masterNode->getTrackerContext();
if (context) {
TrackMarkerPtr masterTrack = context->getMarkerByName(masterTrackName);
if (!masterTrack) {
qDebug() << "Link slave/master for" << knob->getName().c_str() << "could not find track" << masterNodeNameToFind.c_str() << '/' << masterTrackName.c_str();
} else {
KnobIPtr masterKnob = masterTrack->getKnobByName(masterKnobName);
if (!masterKnob) {
qDebug() << "Link slave/master for" << knob->getName().c_str() << "cound not find knob in track" << masterNodeNameToFind.c_str() << '/' << masterTrackName.c_str() << '/' << masterKnobName.c_str();
}
return masterKnob;
}
}
} else {
///now that we have the master node, find the corresponding knob
const std::vector<KnobIPtr> & otherKnobs = masterNode->getKnobs();
for (std::size_t j = 0; j < otherKnobs.size(); ++j) {
qDebug() << "Trying knob" << otherKnobs[j]->getName().c_str();
// The other knob doesn't need to be persistent (it may be a pushbutton)
if (otherKnobs[j]->getName() == masterKnobName) {
return otherKnobs[j];
}
}
qDebug() << "Link slave/master for" << knob->getName().c_str() << "cound not find knob" << masterNodeNameToFind.c_str() << '/' << masterTrackName.c_str() << '/' << masterKnobName.c_str();
}
qDebug() << "Link slave/master for" << knob->getName().c_str() << "failed to restore linkage" << masterNodeNameFullToFind.c_str() << '|' << masterNodeNameToFind.c_str() << '/' << masterTrackName.c_str() << '/' << masterKnobName.c_str();
return KnobIPtr();
}
void
KnobI::restoreLinks(const NodesList & allNodes,
const std::map<std::string, std::string>& oldNewScriptNamesMapping,
bool throwOnFailure)
{
KnobIPtr thisKnob = shared_from_this();
for (std::vector<Link>::const_iterator l = _links.begin(); l != _links.end(); ++l) {
KnobIPtr linkedKnob = findMaster(thisKnob, allNodes, l->nodeNameFull, l->nodeName, l->trackName, l->knobName, oldNewScriptNamesMapping);
if (!linkedKnob) {
if (throwOnFailure) {
throw std::runtime_error(std::string("KnobI::restoreLinks(): Could not restore link to node/knob/track ") + l->nodeName + '/' + l->knobName + '/' + l->trackName);
} else {
continue;
}
}
if (linkedKnob == thisKnob) {
qDebug() << "Link for" << getName().c_str()
<< "failed to restore the following linkage:"
<< "node=" << l->nodeName.c_str()
<< "knob=" << l->knobName.c_str()
<< "track=" << l->trackName.c_str()
<< "because it returned the same Knob. Probably a pre-2.3.16 project with Group clones";
if (throwOnFailure) {
throw std::runtime_error(std::string("KnobI::restoreLinks(): Could not restore link to node/knob/track ") + l->nodeName + '/' + l->knobName + '/' + l->trackName + " because it returned the same Knob. Probably a pre-2.3.16 project with Group clones.");
} else {
continue;
}
} else if (l->dimension == -1) {
setKnobAsAliasOfThis(linkedKnob, true);
} else {
assert(l->slaveDimension >= 0);
slaveTo(l->slaveDimension, linkedKnob, l->dimension);
}
}
_links.clear();
}
void
KnobI::onKnobSlavedTo(int dimension,
const KnobIPtr & other,
int otherDimension)
{
slaveToInternal(dimension, other, otherDimension, eValueChangedReasonUserEdited, false);
}
void
KnobI::unSlave(int dimension,
bool copyState)
{
unSlaveInternal(dimension, eValueChangedReasonNatronInternalEdited, copyState);
}
void
KnobI::onKnobUnSlaved(int dimension)
{
unSlaveInternal(dimension, eValueChangedReasonUserEdited, true);
}
void
KnobI::removeAnimation(ViewSpec view,
int dimension)
{
if ( canAnimate() ) {
removeAnimationWithReason(view, dimension, eValueChangedReasonNatronInternalEdited);
}
}
void
KnobI::onAnimationRemoved(ViewSpec view,
int dimension)
{
if ( canAnimate() ) {
removeAnimationWithReason(view, dimension, eValueChangedReasonUserEdited);
}
}
KnobPagePtr
KnobI::getTopLevelPage() const
{
KnobIPtr parentKnob = getParentKnob();
KnobIPtr parentKnobTmp = parentKnob;
while (parentKnobTmp) {
KnobIPtr parent = parentKnobTmp->getParentKnob();
if (!parent) {
break;
} else {
parentKnobTmp = parent;
}
}
////find in which page the knob should be
KnobPagePtr isTopLevelParentAPage = boost::dynamic_pointer_cast<KnobPage>(parentKnobTmp);
return isTopLevelParentAPage;
}
/***********************************KNOB HELPER******************************************/
///for each dimension, the dimension of the master this dimension is linked to, and a pointer to the master
typedef std::vector<std::pair<int, KnobIWPtr> > MastersMap;
///a curve for each dimension
typedef std::vector<CurvePtr> CurvesMap;
struct Expr
{
std::string expression; //< the one modified by Natron
std::string originalExpression; //< the one input by the user
std::string exprInvalid;
bool hasRet;
///The list of pair<knob, dimension> dpendencies for an expression
std::list<std::pair<KnobIWPtr, int> > dependencies;
//PyObject* code;
Expr()
: expression(), originalExpression(), exprInvalid(), hasRet(false) /*, code(0)*/ {}
};
struct KnobHelperPrivate
{
KnobHelper* publicInterface;
#ifdef DEBUG
#pragma message WARN("This should be a weak_ptr")
#endif
KnobHolder* holder;
mutable QMutex labelMutex;
std::string label; //< the text label that will be displayed on the GUI
std::string iconFilePath[2]; //< an icon to replace the label (one when checked, one when unchecked, for toggable buttons)
std::string name; //< the knob can have a name different than the label displayed on GUI.
//By default this is the same as label but can be set by calling setName().
std::string originalName; //< the original name passed to setName() by the user
// Gui related stuff
bool newLine;
bool addSeparator;
int itemSpacing;
// If this knob is supposed to be visible in the Viewer UI, this is the index at which it should be positioned
int inViewerContextAddSeparator;
int inViewerContextItemSpacing;
int inViewerContextAddNewLine;
std::string inViewerContextLabel;
bool inViewerContextHasShortcut;
KnobIWPtr parentKnob;
mutable QMutex stateMutex; // protects IsSecret defaultIsSecret enabled
bool IsSecret, defaultIsSecret, inViewerContextSecret;
std::vector<bool> enabled, defaultEnabled;
bool CanUndo;
QMutex evaluateOnChangeMutex;
bool evaluateOnChange; //< if true, a value change will never trigger an evaluation
bool IsPersistent; //will it be serialized?
std::string tooltipHint;
bool hintIsMarkdown;
bool isAnimationEnabled;
int dimension;
/* the keys for a specific dimension*/
CurvesMap curves;
////curve links
///A slave link CANNOT be master at the same time (i.e: if _slaveLinks[i] != NULL then _masterLinks[i] == NULL )
mutable QReadWriteLock mastersMutex; //< protects _masters & ignoreMasterPersistence & listeners
MastersMap masters; //from what knob is slaved each curve if any
bool ignoreMasterPersistence; //< when true masters will not be serialized
//Used when this knob is an alias of another knob. The other knob is set in "slaveForAlias"
KnobIPtr slaveForAlias;
///This is a list of all the knobs that have expressions/links to this knob.
KnobI::ListenerDimsMap listeners;
mutable QMutex animationLevelMutex;
std::vector<AnimationLevelEnum> animationLevel; //< indicates for each dimension whether it is static/interpolated/onkeyframe
bool declaredByPlugin; //< was the knob declared by a plug-in or added by Natron
bool dynamicallyCreated; //< true if the knob was dynamically created by the user (either via python or via the gui)
bool userKnob; //< true if it was created by the user and should be put into the "User" page
///Pointer to the ofx param overlay interact
OfxParamOverlayInteractPtr customInteract;
///Pointer to the knobGui interface if it has any
KnobGuiIWPtr gui;
mutable QMutex mustCloneGuiCurvesMutex;
/// Set to true if gui curves were modified by the user instead of the real internal curves.
/// If true then when finished rendering, the knob should clone the guiCurves into the internal curves.
std::vector<bool> mustCloneGuiCurves;
std::vector<bool> mustCloneInternalCurves;
///Used by deQueueValuesSet to know whether we should clear expressions results or not
std::vector<bool> mustClearExprResults;
///A blind handle to the ofx param, needed for custom overlay interacts
void* ofxParamHandle;
///This is to deal with multi-instance effects such as the Tracker: instance specifics knobs are
///not shared between instances whereas non instance specifics are shared.
bool isInstanceSpecific;
std::vector<std::string> dimensionNames;
mutable QMutex expressionMutex;
std::vector<Expr> expressions;
mutable QMutex lastRandomHashMutex;
mutable U32 lastRandomHash;
///Used to prevent recursive calls for expressions
boost::shared_ptr<TLSHolder<KnobHelper::KnobTLSData> > tlsData;
mutable QMutex hasModificationsMutex;
std::vector<bool> hasModifications;
mutable QMutex valueChangedBlockedMutex;
int valueChangedBlocked; // protected by valueChangedBlockedMutex
int listenersNotificationBlocked; // protected by valueChangedBlockedMutex
bool isClipPreferenceSlave;
KnobHelperPrivate(KnobHelper* publicInterface_,
KnobHolder* holder_,
int dimension_,
const std::string & label_,
bool declaredByPlugin_)
: publicInterface(publicInterface_)
, holder(holder_)
, labelMutex()
, label(label_)
, iconFilePath()
, name( label_.c_str() )
, originalName( label_.c_str() )
, newLine(true)
, addSeparator(false)
, itemSpacing(0)
, inViewerContextAddSeparator(false)
, inViewerContextItemSpacing(5)
, inViewerContextAddNewLine(false)
, inViewerContextLabel()
, inViewerContextHasShortcut(false)
, parentKnob()
, stateMutex()
, IsSecret(false)
, defaultIsSecret(false)
, inViewerContextSecret(false)
, enabled(dimension_)
, defaultEnabled(dimension_)
, CanUndo(true)
, evaluateOnChangeMutex()
, evaluateOnChange(true)
, IsPersistent(true)
, tooltipHint()
, hintIsMarkdown(false)
, isAnimationEnabled(true)
, dimension(dimension_)
, curves(dimension_)
, mastersMutex()
, masters(dimension_)
, ignoreMasterPersistence(false)
, slaveForAlias()
, listeners()
, animationLevelMutex()
, animationLevel(dimension_)
, declaredByPlugin(declaredByPlugin_)
, dynamicallyCreated(false)
, userKnob(false)
, customInteract()
, gui()
, mustCloneGuiCurvesMutex()
, mustCloneGuiCurves()
, mustCloneInternalCurves()
, mustClearExprResults()
, ofxParamHandle(0)
, isInstanceSpecific(false)
, dimensionNames(dimension_)
, expressionMutex()
, expressions()
, lastRandomHash(0)
, tlsData()
, hasModificationsMutex()
, hasModifications()
, valueChangedBlockedMutex()
, valueChangedBlocked(0)
, listenersNotificationBlocked(0)
, isClipPreferenceSlave(false)
{
tlsData = boost::make_shared<TLSHolder<KnobHelper::KnobTLSData> >();
if ( holder && !holder->canKnobsAnimate() ) {
isAnimationEnabled = false;
}
mustCloneGuiCurves.resize(dimension);
mustCloneInternalCurves.resize(dimension);
mustClearExprResults.resize(dimension);
expressions.resize(dimension);
hasModifications.resize(dimension);
for (int i = 0; i < dimension_; ++i) {
defaultEnabled[i] = enabled[i] = true;
mustCloneGuiCurves[i] = false;
mustCloneInternalCurves[i] = false;
mustClearExprResults[i] = false;
hasModifications[i] = false;
}
}
void parseListenersFromExpression(int dimension);
std::string declarePythonVariables(bool addTab, int dimension);
bool shouldUseGuiCurve() const
{
if (!holder) {
return false;
}
return !holder->isSetValueCurrentlyPossible() && gui.lock();
}
};
KnobHelper::KnobHelper(KnobHolder* holder,
const std::string &label,
int dimension,
bool declaredByPlugin)
: _signalSlotHandler()
, _imp( new KnobHelperPrivate(this, holder, dimension, label, declaredByPlugin) )
{
}
KnobHelper::~KnobHelper()
{
}
void
KnobHelper::setHolder(KnobHolder* holder)
{
_imp->holder = holder;
}
void
KnobHelper::incrementExpressionRecursionLevel() const
{
KnobDataTLSPtr tls = _imp->tlsData->getOrCreateTLSData();
assert(tls);
++tls->expressionRecursionLevel;
}
void
KnobHelper::decrementExpressionRecursionLevel() const
{
KnobDataTLSPtr tls = _imp->tlsData->getTLSData();
assert(tls);
assert(tls->expressionRecursionLevel > 0);
--tls->expressionRecursionLevel;
}
int
KnobHelper::getExpressionRecursionLevel() const
{
KnobDataTLSPtr tls = _imp->tlsData->getTLSData();
if (!tls) {
return 0;
}
return tls->expressionRecursionLevel;
}
void
KnobHelper::deleteKnob()
{
KnobI::ListenerDimsMap listenersCpy = _imp->listeners;
for (ListenerDimsMap::iterator it = listenersCpy.begin(); it != listenersCpy.end(); ++it) {
KnobIPtr knob = it->first.lock();
if (!knob) {
continue;
}
KnobIPtr aliasKnob = knob->getAliasMaster();
if (aliasKnob.get() == this) {
knob->setKnobAsAliasOfThis(aliasKnob, false);
}
for (int i = 0; i < knob->getDimension(); ++i) {
knob->setExpressionInvalid( i, false, tr("%1: parameter does not exist").arg( QString::fromUtf8( getName().c_str() ) ).toStdString() );
knob->unSlave(i, false);
}
}
KnobHolder* holder = getHolder();
if ( holder && holder->getApp() ) {
holder->getApp()->recheckInvalidExpressions();
}
for (int i = 0; i < getDimension(); ++i) {
clearExpression(i, true);
}
resetParent();
if (holder) {
KnobGroup* isGrp = dynamic_cast<KnobGroup*>(this);
KnobPage* isPage = dynamic_cast<KnobPage*>(this);
if (isGrp) {
KnobsVec children = isGrp->getChildren();
for (KnobsVec::iterator it = children.begin(); it != children.end(); ++it) {
_imp->holder->deleteKnob(it->get(), true);
}
} else if (isPage) {
KnobsVec children = isPage->getChildren();
for (KnobsVec::iterator it = children.begin(); it != children.end(); ++it) {
_imp->holder->deleteKnob(it->get(), true);
}
}
EffectInstance* effect = dynamic_cast<EffectInstance*>(holder);
if (effect) {
if ( useHostOverlayHandle() ) {
effect->getNode()->removePositionHostOverlay(this);
}
effect->getNode()->removeParameterFromPython( getName() );
}
}
_signalSlotHandler.reset();
} // KnobHelper::deleteKnob
void
KnobHelper::setKnobGuiPointer(const KnobGuiIPtr& ptr)
{
assert( QThread::currentThread() == qApp->thread() );
_imp->gui = ptr;
}
KnobGuiIPtr
KnobHelper::getKnobGuiPointer() const
{
return _imp->gui.lock();
}
bool
KnobHelper::getAllDimensionVisible() const
{
if ( getKnobGuiPointer() ) {
return getKnobGuiPointer()->getAllDimensionsVisible();
}
return true;
}
#ifdef DEBUG
void
KnobHelper::debugHook()
{
assert(true);
}
#endif
bool
KnobHelper::isDeclaredByPlugin() const
{
return _imp->declaredByPlugin;
}
void
KnobHelper::setAsInstanceSpecific()
{
_imp->isInstanceSpecific = true;
}
bool
KnobHelper::isInstanceSpecific() const
{
return _imp->isInstanceSpecific;
}
void
KnobHelper::setDynamicallyCreated()
{
_imp->dynamicallyCreated = true;
}
bool
KnobHelper::isDynamicallyCreated() const
{
return _imp->dynamicallyCreated;
}
void
KnobHelper::setAsUserKnob(bool b)
{
_imp->userKnob = b;
_imp->dynamicallyCreated = b;
}
bool
KnobHelper::isUserKnob() const
{
return _imp->userKnob;
}
void
KnobHelper::populate()
{
KnobIPtr thisKnob = shared_from_this();
KnobSignalSlotHandlerPtr handler = boost::make_shared<KnobSignalSlotHandler>(thisKnob);
setSignalSlotHandler(handler);
KnobColor* isColor = dynamic_cast<KnobColor*>(this);
KnobSeparator* isSep = dynamic_cast<KnobSeparator*>(this);
KnobPage* isPage = dynamic_cast<KnobPage*>(this);
KnobGroup* isGrp = dynamic_cast<KnobGroup*>(this);
if (isPage || isGrp) {
_imp->evaluateOnChange = false;
}
if (isSep) {
_imp->IsPersistent = false;
}
for (int i = 0; i < _imp->dimension; ++i) {
_imp->enabled[i] = true;
if ( canAnimate() ) {
_imp->curves[i] = boost::make_shared<Curve>(this, i);
}
_imp->animationLevel[i] = eAnimationLevelNone;
if (!isColor) {
switch (i) {
case 0:
_imp->dimensionNames[i] = "x";
break;
case 1:
_imp->dimensionNames[i] = "y";
break;
case 2:
_imp->dimensionNames[i] = "z";
break;
case 3:
_imp->dimensionNames[i] = "w";
break;
default:
break;
}
} else {
switch (i) {
case 0:
_imp->dimensionNames[i] = "r";
break;
case 1:
_imp->dimensionNames[i] = "g";
break;
case 2:
_imp->dimensionNames[i] = "b";
break;
case 3:
_imp->dimensionNames[i] = "a";
break;
default:
break;
}
}
}
} // KnobHelper::populate
std::string
KnobHelper::getDimensionName(int dimension) const
{
assert( dimension < (int)_imp->dimensionNames.size() && dimension >= 0);
return _imp->dimensionNames[dimension];
}
void
KnobHelper::setDimensionName(int dim,
const std::string & name)
{
assert( QThread::currentThread() == qApp->thread() );
_imp->dimensionNames[dim] = name;
if (_signalSlotHandler) {
_signalSlotHandler->s_dimensionNameChanged(dim);
}
}
template <typename T>
const std::string &
Knob<T>::typeName() const
{
static std::string knobNoTypeName("NoType");
return knobNoTypeName;
}
template <typename T>
bool
Knob<T>::canAnimate() const
{
return false;
}
void
KnobHelper::setSignalSlotHandler(const KnobSignalSlotHandlerPtr & handler)
{
_signalSlotHandler = handler;
}
void
KnobHelper::deleteValuesAtTime(CurveChangeReason curveChangeReason,
const std::list<double>& times,
ViewSpec view,
int dimension, bool copyCurveValueAtTimeToInternalValue)
{
if ( ( dimension > (int)_imp->curves.size() ) || (dimension < 0) ) {
throw std::invalid_argument("KnobHelper::deleteValueAtTime(): Dimension out of range");
}
if ( times.empty() ) {
return;
}
if ( !canAnimate() || !isAnimated(dimension, view) ) {
return;
}
CurvePtr curve;
bool useGuiCurve = _imp->shouldUseGuiCurve();
KnobGuiIPtr hasGui = getKnobGuiPointer();
if (!useGuiCurve) {
curve = _imp->curves[dimension];
} else {
curve = hasGui->getCurve(view, dimension);
setGuiCurveHasChanged(view, dimension, true);
}
assert(curve);
// We are about to remove the last keyframe, ensure that the internal value of the knob is the one of the animation
if (copyCurveValueAtTimeToInternalValue) {
copyValuesFromCurve(dimension);
}
try {
for (std::list<double>::const_iterator it = times.begin(); it != times.end(); ++it) {
curve->removeKeyFrameWithTime(*it);
}
} catch (const std::exception & e) {
//qDebug() << e.what();
}
if (!useGuiCurve && hasGui) {
CurvePtr guiCurve = hasGui->getCurve(view, dimension);
assert(guiCurve);
for (std::list<double>::const_iterator it = times.begin(); it != times.end(); ++it) {
guiCurve->removeKeyFrameWithTime(*it);
}
}
//virtual portion
for (std::list<double>::const_iterator it = times.begin(); it != times.end(); ++it) {
keyframeRemoved_virtual(dimension, *it);
}
if (_imp->holder) {
_imp->holder->updateHasAnimation();
}
ValueChangedReasonEnum reason = eValueChangedReasonNatronInternalEdited;
if (!useGuiCurve) {
checkAnimationLevel(view, dimension);
evaluateValueChange(dimension, *times.begin(), view, reason);
}
if (_signalSlotHandler) {
_signalSlotHandler->s_redrawGuiCurve(curveChangeReason, view, dimension);
}
if (_signalSlotHandler /* && reason != eValueChangedReasonUserEdited*/) {
_signalSlotHandler->s_multipleKeyFramesRemoved(times, view, dimension, (int)reason);
}
} // KnobHelper::deleteValuesAtTime
void
KnobHelper::deleteValueAtTime(CurveChangeReason curveChangeReason,
double time,
ViewSpec view,
int dimension, bool copyCurveValueAtTimeToInternalValue)
{
if ( ( dimension > (int)_imp->curves.size() ) || (dimension < 0) ) {
throw std::invalid_argument("KnobHelper::deleteValueAtTime(): Dimension out of range");
}
if ( !canAnimate() || !isAnimated(dimension, view) ) {
return;
}
CurvePtr curve;
bool useGuiCurve = _imp->shouldUseGuiCurve();
KnobGuiIPtr hasGui = getKnobGuiPointer();
if (!useGuiCurve) {
curve = _imp->curves[dimension];
} else {
curve = hasGui->getCurve(view, dimension);
setGuiCurveHasChanged(view, dimension, true);
}
assert(curve);
// We are about to remove the last keyframe, ensure that the internal value of the knob is the one of the animation
if (copyCurveValueAtTimeToInternalValue) {
copyValuesFromCurve(dimension);
}
try {
curve->removeKeyFrameWithTime(time);
} catch (const std::exception & e) {
//qDebug() << e.what();
}
if (!useGuiCurve && hasGui) {
CurvePtr guiCurve = hasGui->getCurve(view, dimension);
assert(guiCurve);
guiCurve->removeKeyFrameWithTime(time);
}
//virtual portion
keyframeRemoved_virtual(dimension, time);
if (_imp->holder) {
_imp->holder->updateHasAnimation();
}
ValueChangedReasonEnum reason = eValueChangedReasonNatronInternalEdited;
if (!useGuiCurve) {
checkAnimationLevel(view, dimension);
evaluateValueChange(dimension, time, view, reason);
}
if (_signalSlotHandler) {
_signalSlotHandler->s_redrawGuiCurve(curveChangeReason, view, dimension);
}