forked from NatronGitHub/Natron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OfxParamInstance.h
987 lines (761 loc) · 36.8 KB
/
OfxParamInstance.h
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
/* ***** 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 ***** */
#ifndef NATRON_ENGINE_OFXPARAMINSTANCE_H
#define NATRON_ENGINE_OFXPARAMINSTANCE_H
// ***** 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 "Global/Macros.h"
#include <map>
#include <string>
#include <vector>
#if !defined(Q_MOC_RUN) && !defined(SBK_RUN)
#include <boost/shared_ptr.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/weak_ptr.hpp>
#endif
CLANG_DIAG_OFF(deprecated)
#include <QtCore/QStringList>
#include <QtCore/QMutex>
CLANG_DIAG_ON(deprecated)
#include "Global/GlobalDefines.h"
//ofx
#include <ofxInteract.h>
#include <ofxhParametricParam.h>
#include <ofxhInteract.h>
#include "Engine/KnobTypes.h"
#include "Engine/ViewIdx.h"
#include "Engine/EffectInstance.h"
#include "Engine/EngineFwd.h"
NATRON_NAMESPACE_ENTER
/*This file contains the classes that connect the knobs to the OpenFX params.
Note that all the get(...) and set(...) functions are called BY PLUGIN and you should
never call them. When the user interact with a knob, the onInstanceChanged() slot
is called. In turn, the plug-in will fetch the value that has changed by calling get(...).
*/
class OfxParamToKnob;
class PropertyModified_RAII
{
OfxParamToKnob* _h;
public:
PropertyModified_RAII(OfxParamToKnob* h);
~PropertyModified_RAII();
};
#define SET_DYNAMIC_PROPERTY_EDITED() PropertyModified_RAII dynamic_prop_edited_raii(this)
#define DYNAMIC_PROPERTY_CHECK() if ( isDynamicPropertyBeingModified() ) { \
return; \
} \
SET_DYNAMIC_PROPERTY_EDITED();
class OfxParamToKnob
: public QObject
{
Q_OBJECT
friend class PropertyModified_RAII;
OFX::Host::Interact::Descriptor interactDesc;
mutable QMutex dynamicPropModifiedMutex;
int _dynamicPropModified;
EffectInstanceWPtr _effect;
public:
OfxParamToKnob(const EffectInstancePtr& effect)
: dynamicPropModifiedMutex()
, _dynamicPropModified(0)
, _effect(effect)
{
}
virtual OfxPluginEntryPoint* getCustomOverlayInteractEntryPoint(const OFX::Host::Param::Instance* param) const
{
GCC_DIAG_PEDANTIC_OFF
return (OfxPluginEntryPoint*)param->getProperties().getPointerProperty(kOfxParamPropInteractV1);
GCC_DIAG_PEDANTIC_ON
}
virtual KnobIPtr getKnob() const = 0;
virtual OFX::Host::Param::Instance* getOfxParam() = 0;
OFX::Host::Interact::Descriptor & getInteractDesc()
{
return interactDesc;
}
EffectInstancePtr getKnobHolder() const;
void connectDynamicProperties();
//these are per ofxparam thread-local data
struct OfxParamTLSData
{
//only for string-param for now
std::string str;
};
static std::string getParamLabel(OFX::Host::Param::Instance* param)
{
std::string label = param->getLabel();
/*if ( label.empty() ) {
label = param->getShortLabel();
}
if ( label.empty() ) {
label = param->getLongLabel();
}*/
return label;
}
template <typename TYPE>
boost::shared_ptr<TYPE>checkIfKnobExistsWithNameOrCreate(const std::string& scriptName,
OFX::Host::Param::Instance* param,
int dimension)
{
EffectInstancePtr holder = getKnobHolder();
assert(holder);
#ifdef NATRON_ENABLE_IO_META_NODES
boost::shared_ptr<TYPE> isType = holder->getKnobByNameAndType<TYPE>(scriptName);
if (isType) {
//Remove from the parent if it exists, because it will be added again afterwards
isType->resetParent();
return isType;
}
#else
Q_UNUSED(scriptName);
#endif
boost::shared_ptr<TYPE> ret = AppManager::createKnob<TYPE>(holder.get(), getParamLabel(param), dimension);
ret->setName(scriptName);
return ret;
}
public Q_SLOTS:
/*
These are called when the properties are changed on the Natron side
*/
void onEvaluateOnChangeChanged(bool evaluate);
void onSecretChanged();
void onHintTooltipChanged();
void onEnabledChanged();
void onLabelChanged();
void onDisplayMinMaxChanged(double min, double max, int index);
void onMinMaxChanged(double min, double max, int index);
void onKnobAnimationLevelChanged(ViewSpec view, int dimension);
void onChoiceMenuReset();
void onChoiceMenuPopulated();
void onChoiceMenuEntryAppended();
void onInViewportSecretChanged();
void onInViewportLabelChanged();
protected:
void setDynamicPropertyModified(bool dynamicPropModified)
{
QMutexLocker k(&dynamicPropModifiedMutex);
if (dynamicPropModified) {
++_dynamicPropModified;
} else {
if (_dynamicPropModified > 0) {
--_dynamicPropModified;
}
}
}
bool isDynamicPropertyBeingModified() const
{
QMutexLocker k(&dynamicPropModifiedMutex);
return _dynamicPropModified > 0;
}
virtual bool hasDoubleMinMaxProps() const { return true; }
};
class OfxPushButtonInstance
: public OfxParamToKnob, public OFX::Host::Param::PushbuttonInstance
{
public:
OfxPushButtonInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
KnobButtonWPtr _knob;
};
class OfxIntegerInstance
: public OfxParamToKnob, public OFX::Host::Param::IntegerInstance
{
public:
OfxIntegerInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(int &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, int &) OVERRIDE FINAL;
virtual OfxStatus set(int) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, int) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
virtual bool hasDoubleMinMaxProps() const OVERRIDE FINAL { return false; }
KnobIntWPtr _knob;
};
class OfxDoubleInstance
: public OfxParamToKnob, public OFX::Host::Param::DoubleInstance
{
public:
OfxDoubleInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(double &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, double &) OVERRIDE FINAL;
virtual OfxStatus set(double) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, double) OVERRIDE FINAL;
virtual OfxStatus derive(OfxTime time, double &) OVERRIDE FINAL;
virtual OfxStatus integrate(OfxTime time1, OfxTime time2, double &) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
bool isAnimated() const;
private:
KnobDoubleWPtr _knob;
};
class OfxBooleanInstance
: public OfxParamToKnob, public OFX::Host::Param::BooleanInstance
{
public:
OfxBooleanInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(bool &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, bool &) OVERRIDE FINAL;
virtual OfxStatus set(bool) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, bool) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
virtual bool hasDoubleMinMaxProps() const OVERRIDE FINAL { return false; }
KnobBoolWPtr _knob;
};
class OfxChoiceInstance
: public OfxParamToKnob, public OFX::Host::Param::ChoiceInstance
{
public:
OfxChoiceInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(int &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, int &) OVERRIDE FINAL;
virtual OfxStatus set(int) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, int) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
// callback which should set option as appropriate
virtual void setOption(int num) OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
virtual bool hasDoubleMinMaxProps() const OVERRIDE FINAL { return false; }
KnobChoiceWPtr _knob;
};
class OfxRGBAInstance
: public OfxParamToKnob, public OFX::Host::Param::RGBAInstance
{
public:
OfxRGBAInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(double &, double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, double &, double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus set(double, double, double, double) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, double, double, double, double) OVERRIDE FINAL;
virtual OfxStatus derive(OfxTime time, double &, double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus integrate(OfxTime time1, OfxTime time2, double &, double &, double &, double &) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
bool isAnimated(int dimension) const;
bool isAnimated() const;
private:
KnobColorWPtr _knob;
};
class OfxRGBInstance
: public OfxParamToKnob, public OFX::Host::Param::RGBInstance
{
public:
OfxRGBInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus set(double, double, double) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, double, double, double) OVERRIDE FINAL;
virtual OfxStatus derive(OfxTime time, double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus integrate(OfxTime time1, OfxTime time2, double &, double &, double &) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
bool isAnimated(int dimension) const;
bool isAnimated() const;
private:
KnobColorWPtr _knob;
};
class OfxDouble2DInstance
: public OfxParamToKnob, public OFX::Host::Param::Double2DInstance
{
public:
OfxDouble2DInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(double &, double &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, double &, double &) OVERRIDE FINAL;
virtual OfxStatus set(double, double) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, double, double) OVERRIDE FINAL;
virtual OfxStatus derive(OfxTime time, double &, double &) OVERRIDE FINAL;
virtual OfxStatus integrate(OfxTime time1, OfxTime time2, double &, double &) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
//bool isAnimated(int dimension) const;
bool isAnimated() const;
private:
int _startIndex;
KnobDoubleWPtr _knob;
};
class OfxInteger2DInstance
: public OfxParamToKnob, public OFX::Host::Param::Integer2DInstance
{
public:
OfxInteger2DInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(int &, int &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, int &, int &) OVERRIDE FINAL;
virtual OfxStatus set(int, int) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, int, int) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
virtual bool hasDoubleMinMaxProps() const OVERRIDE FINAL { return false; }
int _startIndex;
KnobIntWPtr _knob;
};
class OfxDouble3DInstance
: public OfxParamToKnob, public OFX::Host::Param::Double3DInstance
{
public:
OfxDouble3DInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus set(double, double, double) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, double, double, double) OVERRIDE FINAL;
virtual OfxStatus derive(OfxTime time, double &, double &, double &) OVERRIDE FINAL;
virtual OfxStatus integrate(OfxTime time1, OfxTime time2, double &, double &, double &) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
bool isAnimated(int dimension) const;
bool isAnimated() const;
private:
int _startIndex;
KnobDoubleWPtr _knob;
};
class OfxInteger3DInstance
: public OfxParamToKnob, public OFX::Host::Param::Integer3DInstance
{
public:
OfxInteger3DInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual OfxStatus get(int &, int &, int &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, int &, int &, int &) OVERRIDE FINAL;
virtual OfxStatus set(int, int, int) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, int, int, int) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
virtual void setDisplayRange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
virtual bool hasDoubleMinMaxProps() const OVERRIDE FINAL { return false; }
KnobIntWPtr _knob;
};
class OfxGroupInstance
: public OfxParamToKnob, public OFX::Host::Param::GroupInstance
{
public:
OfxGroupInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
void addKnob(KnobIPtr k);
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
virtual ~OfxGroupInstance()
{
}
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setOpen() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
private:
KnobGroupWPtr _groupKnob;
};
class OfxPageInstance
: public OfxParamToKnob, public OFX::Host::Param::PageInstance
{
public:
OfxPageInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
KnobPageWPtr _pageKnob;
};
struct OfxStringInstancePrivate;
class OfxStringInstance
: public OfxParamToKnob, public OFX::Host::Param::StringInstance
{
public:
OfxStringInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual ~OfxStringInstance();
virtual OfxStatus get(std::string &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, std::string &) OVERRIDE FINAL;
virtual OfxStatus set(const char*) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, const char*) OVERRIDE FINAL;
/// implementation of var args function
/// Be careful: the char* is only valid until next API call
/// see http://openfx.sourceforge.net/Documentation/1.3/ofxProgrammingReference.html#ArchitectureStrings
virtual OfxStatus getV(va_list arg) OVERRIDE FINAL;
/// implementation of var args function
/// Be careful: the char* is only valid until next API call
/// see http://openfx.sourceforge.net/Documentation/1.3/ofxProgrammingReference.html#ArchitectureStrings
virtual OfxStatus getV(OfxTime time, va_list arg) OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
private:
/**
* @brief Expand any project path contained in str
**/
void projectEnvVar_getProxy(std::string& str) const;
/**
* @brief Find any project path contained in str and replace it by the associated name
**/
void projectEnvVar_setProxy(std::string& str) const;
boost::scoped_ptr<OfxStringInstancePrivate> _imp;
};
struct OfxCustomInstancePrivate;
class OfxCustomInstance
: public OfxParamToKnob, public OFX::Host::Param::CustomInstance
{
public:
OfxCustomInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual ~OfxCustomInstance();
virtual OfxStatus get(std::string &) OVERRIDE FINAL;
virtual OfxStatus get(OfxTime time, std::string &) OVERRIDE FINAL;
virtual OfxStatus set(const char*) OVERRIDE FINAL;
virtual OfxStatus set(OfxTime time, const char*) OVERRIDE FINAL;
/// implementation of var args function
/// Be careful: the char* is only valid until next API call
/// see http://openfx.sourceforge.net/Documentation/1.3/ofxProgrammingReference.html#ArchitectureStrings
virtual OfxStatus getV(va_list arg) OVERRIDE FINAL;
/// implementation of var args function
/// Be careful: the char* is only valid until next API call
/// see http://openfx.sourceforge.net/Documentation/1.3/ofxProgrammingReference.html#ArchitectureStrings
virtual OfxStatus getV(OfxTime time, va_list arg) OVERRIDE FINAL;
virtual void setHint() OVERRIDE FINAL;
virtual void setDefault() OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
virtual void setLabel() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
///keyframes support
virtual OfxStatus getNumKeys(unsigned int &nKeys) const OVERRIDE FINAL;
virtual OfxStatus getKeyTime(int nth, OfxTime & time) const OVERRIDE FINAL;
virtual OfxStatus getKeyIndex(OfxTime time, int direction, int & index) const OVERRIDE FINAL;
virtual OfxStatus deleteKey(OfxTime time) OVERRIDE FINAL;
virtual OfxStatus deleteAllKeys() OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
typedef OfxStatus (*customParamInterpolationV1Entry_t)(const void* handleRaw,
OfxPropertySetHandle inArgsRaw,
OfxPropertySetHandle outArgsRaw);
private:
void getCustomParamAtTime(double time, std::string &str) const;
boost::scoped_ptr<OfxCustomInstancePrivate> _imp;
};
class OfxParametricInstance
: public OfxParamToKnob, public OFX::Host::ParametricParam::ParametricInstance
{
GCC_DIAG_SUGGEST_OVERRIDE_OFF
Q_OBJECT
GCC_DIAG_SUGGEST_OVERRIDE_ON
public:
explicit OfxParametricInstance(const OfxEffectInstancePtr& node,
OFX::Host::Param::Descriptor & descriptor);
virtual ~OfxParametricInstance();
virtual OfxPluginEntryPoint* getCustomOverlayInteractEntryPoint(const OFX::Host::Param::Instance* param) const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual void setHint() OVERRIDE FINAL;
// callback which should set enabled state as appropriate
virtual void setEnabled() OVERRIDE FINAL;
// callback which should set secret state as appropriate
virtual void setSecret() OVERRIDE FINAL;
/// callback which should update label
virtual void setLabel() OVERRIDE FINAL;
virtual void setInViewportSecret() OVERRIDE FINAL;
virtual void setInViewportLabel() OVERRIDE FINAL;
virtual void setRange() OVERRIDE FINAL;
/// callback which should set
virtual void setDisplayRange() OVERRIDE FINAL;
/// callback which should set evaluate on change
virtual void setEvaluateOnChange() OVERRIDE FINAL;
void onCurvesDefaultInitialized();
///derived from CurveHolder
virtual OfxStatus getValue(int curveIndex, OfxTime time, double parametricPosition, double *returnValue) OVERRIDE FINAL;
virtual OfxStatus getNControlPoints(int curveIndex, double time, int *returnValue) OVERRIDE FINAL;
virtual OfxStatus getNthControlPoint(int curveIndex,
double time,
int nthCtl,
double *key,
double *value) OVERRIDE FINAL;
virtual OfxStatus setNthControlPoint(int curveIndex,
double time,
int nthCtl,
double key,
double value,
bool addAnimationKey) OVERRIDE FINAL;
virtual OfxStatus addControlPoint(int curveIndex,
double time,
double key,
double value,
bool addAnimationKey) OVERRIDE FINAL;
virtual OfxStatus deleteControlPoint(int curveIndex, int nthCtl) OVERRIDE FINAL;
virtual OfxStatus deleteAllControlPoints(int curveIndex) OVERRIDE FINAL;
virtual OfxStatus copyFrom(const OFX::Host::Param::Instance &instance, OfxTime offset, const OfxRangeD* range) OVERRIDE FINAL;
virtual KnobIPtr getKnob() const OVERRIDE FINAL;
virtual OFX::Host::Param::Instance* getOfxParam() OVERRIDE FINAL { return this; }
KnobParametricWPtr _knob;
};
NATRON_NAMESPACE_EXIT
#endif // NATRON_ENGINE_OFXPARAMINSTANCE_H