-
Notifications
You must be signed in to change notification settings - Fork 202
/
Copy pathproxyShapeBase.cpp
2423 lines (2044 loc) · 92.3 KB
/
proxyShapeBase.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
//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include "proxyShapeBase.h"
#include <mayaUsd/base/debugCodes.h>
#include <mayaUsd/base/tokens.h>
#include <mayaUsd/fileio/utils/readUtil.h>
#include <mayaUsd/fileio/utils/writeUtil.h>
#include <mayaUsd/listeners/proxyShapeNotice.h>
#include <mayaUsd/nodes/layerManager.h>
#include <mayaUsd/nodes/proxyShapeStageExtraData.h>
#include <mayaUsd/nodes/stageData.h>
#include <mayaUsd/ufe/Utils.h>
#include <mayaUsd/undo/OpUndoItemMuting.h>
#include <mayaUsd/utils/customLayerData.h>
#include <mayaUsd/utils/diagnosticDelegate.h>
#include <mayaUsd/utils/layerLocking.h>
#include <mayaUsd/utils/layerMuting.h>
#include <mayaUsd/utils/loadRules.h>
#include <mayaUsd/utils/query.h>
#include <mayaUsd/utils/stageCache.h>
#include <mayaUsd/utils/targetLayer.h>
#include <mayaUsd/utils/util.h>
#include <mayaUsd/utils/utilFileSystem.h>
#include <mayaUsd/utils/variantFallbacks.h>
#include <usdUfe/utils/layers.h>
#include <pxr/base/gf/bbox3d.h>
#include <pxr/base/gf/range3d.h>
#include <pxr/base/gf/ray.h>
#include <pxr/base/gf/vec3d.h>
#include <pxr/base/js/json.h>
#include <pxr/base/tf/envSetting.h>
#include <pxr/base/tf/fileUtils.h>
#include <pxr/base/tf/hash.h>
#include <pxr/base/tf/pathUtils.h>
#include <pxr/base/tf/staticData.h>
#include <pxr/base/tf/staticTokens.h>
#include <pxr/base/tf/stringUtils.h>
#include <pxr/base/tf/token.h>
#include <pxr/base/trace/trace.h>
#include <pxr/pxr.h>
#include <pxr/usd/ar/resolver.h>
#include <pxr/usd/pcp/types.h>
#include <pxr/usd/sdf/attributeSpec.h>
#include <pxr/usd/sdf/layer.h>
#include <pxr/usd/sdf/path.h>
#include <pxr/usd/usd/editContext.h>
#include <pxr/usd/usd/prim.h>
#include <pxr/usd/usd/stage.h>
#include <pxr/usd/usd/stageCacheContext.h>
#include <pxr/usd/usd/timeCode.h>
#include <pxr/usd/usdGeom/bboxCache.h>
#include <pxr/usd/usdGeom/boundable.h>
#include <pxr/usd/usdGeom/gprim.h>
#include <pxr/usd/usdGeom/imageable.h>
#include <pxr/usd/usdGeom/tokens.h>
#include <pxr/usd/usdUtils/stageCache.h>
#include <maya/MBoundingBox.h>
#include <maya/MDGContext.h>
#include <maya/MDGContextGuard.h>
#include <maya/MDataBlock.h>
#include <maya/MDataHandle.h>
#include <maya/MEvaluationNode.h>
#include <maya/MFileIO.h>
#include <maya/MFnCompoundAttribute.h>
#include <maya/MFnDagNode.h>
#include <maya/MFnData.h>
#include <maya/MFnDependencyNode.h>
#include <maya/MFnEnumAttribute.h>
#include <maya/MFnNumericAttribute.h>
#include <maya/MFnPluginData.h>
#include <maya/MFnReference.h>
#include <maya/MFnStringArrayData.h>
#include <maya/MFnStringData.h>
#include <maya/MFnTypedAttribute.h>
#include <maya/MFnUnitAttribute.h>
#include <maya/MGlobal.h>
#include <maya/MItDependencyNodes.h>
#include <maya/MObject.h>
#include <maya/MPlug.h>
#include <maya/MPlugArray.h>
#include <maya/MPoint.h>
#include <maya/MProfiler.h>
#include <maya/MPxSurfaceShape.h>
#include <maya/MSceneMessage.h>
#include <maya/MSelectionMask.h>
#include <maya/MStatus.h>
#include <maya/MString.h>
#include <maya/MTime.h>
#include <maya/MUuid.h>
#include <maya/MViewport2Renderer.h>
#include <ufe/path.h>
#include <ufe/pathString.h>
#include <ghc/filesystem.hpp>
#include <map>
#include <string>
#include <utility>
#include <vector>
using MayaUsd::LayerManager;
using MayaUsd::ProxyAccessor;
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PUBLIC_TOKENS(MayaUsdProxyShapeBaseTokens, MAYAUSD_PROXY_SHAPE_BASE_TOKENS);
MayaUsdProxyShapeBase::ClosestPointDelegate MayaUsdProxyShapeBase::_sharedClosestPointDelegate
= nullptr;
const std::string kAnonymousLayerName { "anonymousLayer1" };
const std::string kSessionLayerPostfix { "-session" };
const std::string kUnsharedStageLayerName { "unshareableLayer" };
static const char* kMutedLayersAttrName = "mutedLayers";
static const char* kLockedLayersAttrName = "lockedLayers";
// ========================================================
// TypeID from the MayaUsd type ID range.
const MTypeId MayaUsdProxyShapeBase::typeId(0x58000094);
const MString MayaUsdProxyShapeBase::typeName(MayaUsdProxyShapeBaseTokens->MayaTypeName.GetText());
const MString MayaUsdProxyShapeBase::displayFilterName(
TfStringPrintf("%sDisplayFilter", MayaUsdProxyShapeBaseTokens->MayaTypeName.GetText()).c_str());
const MString MayaUsdProxyShapeBase::displayFilterLabel("USD Proxies");
std::atomic<int> g_proxyShapeInstancesCount;
// Attributes
MObject MayaUsdProxyShapeBase::filePathAttr;
MObject MayaUsdProxyShapeBase::filePathRelativeAttr;
MObject MayaUsdProxyShapeBase::primPathAttr;
MObject MayaUsdProxyShapeBase::excludePrimPathsAttr;
MObject MayaUsdProxyShapeBase::loadPayloadsAttr;
MObject MayaUsdProxyShapeBase::shareStageAttr;
MObject MayaUsdProxyShapeBase::timeAttr;
MObject MayaUsdProxyShapeBase::complexityAttr;
MObject MayaUsdProxyShapeBase::inStageDataAttr;
MObject MayaUsdProxyShapeBase::inStageDataCachedAttr;
MObject MayaUsdProxyShapeBase::stageCacheIdAttr;
MObject MayaUsdProxyShapeBase::drawRenderPurposeAttr;
MObject MayaUsdProxyShapeBase::drawProxyPurposeAttr;
MObject MayaUsdProxyShapeBase::drawGuidePurposeAttr;
MObject MayaUsdProxyShapeBase::sessionLayerNameAttr;
MObject MayaUsdProxyShapeBase::rootLayerNameAttr;
MObject MayaUsdProxyShapeBase::mutedLayersAttr;
MObject MayaUsdProxyShapeBase::lockedLayersAttr;
// Change counter attributes
MObject MayaUsdProxyShapeBase::updateCounterAttr;
MObject MayaUsdProxyShapeBase::resyncCounterAttr;
// Output attributes
MObject MayaUsdProxyShapeBase::outTimeAttr;
MObject MayaUsdProxyShapeBase::outStageDataAttr;
MObject MayaUsdProxyShapeBase::outStageCacheIdAttr;
MObject MayaUsdProxyShapeBase::variantFallbacksAttr;
MObject MayaUsdProxyShapeBase::layerManagerAttr;
namespace {
// utility function to extract the tag name from an anonymous layer.
// e.g
// given layer identifier = anon:00000232FE3FB470:anonymousLayer1234
// tag name = anonymousLayer1234
std::string extractAnonTagName(const std::string& identifier)
{
std::size_t found = identifier.find_last_of(":");
return identifier.substr(found + 1);
}
// recursive function to create new anonymous Sublayer(s)
// and set the edit target accordingly.
void createNewAnonSubLayerRecursive(
const UsdStageRefPtr& newUsdStage,
const SdfLayerRefPtr& targetLayer,
const SdfLayerRefPtr& parentLayer)
{
if (!parentLayer->IsAnonymous()) {
return;
}
SdfSubLayerProxy sublayers = parentLayer->GetSubLayerPaths();
for (auto path : sublayers) {
SdfLayerRefPtr subLayer = SdfLayer::Find(path);
if (subLayer) {
const std::string tagName = extractAnonTagName(subLayer->GetIdentifier());
if (subLayer->IsAnonymous()) {
SdfLayerRefPtr newLayer = SdfLayer::CreateAnonymous(tagName);
newLayer->TransferContent(subLayer);
size_t index = sublayers.Find(path);
parentLayer->RemoveSubLayerPath(index);
parentLayer->InsertSubLayerPath(newLayer->GetIdentifier(), index);
if (extractAnonTagName(targetLayer->GetIdentifier()) == tagName) {
newUsdStage->SetEditTarget(newLayer);
}
createNewAnonSubLayerRecursive(newUsdStage, targetLayer, newLayer);
} else {
if (extractAnonTagName(targetLayer->GetIdentifier()) == tagName) {
newUsdStage->SetEditTarget(subLayer);
}
}
}
}
}
//! Profiler category for proxy accessor events
const int _shapeBaseProfilerCategory
= MProfiler::addCategory("ProxyShapeBase", "ProxyShapeBase events");
struct InComputeGuard
{
InComputeGuard(MayaUsdProxyShapeBase& proxy)
: _proxy(proxy)
{
_proxy.in_compute++;
}
~InComputeGuard() { _proxy.in_compute--; }
private:
MayaUsdProxyShapeBase& _proxy;
};
} // namespace
/* static */
void* MayaUsdProxyShapeBase::creator() { return new MayaUsdProxyShapeBase(); }
/* static */
MStatus MayaUsdProxyShapeBase::initialize()
{
MStatus retValue = MS::kSuccess;
//
// create attr factories
//
MFnNumericAttribute numericAttrFn;
MFnTypedAttribute typedAttrFn;
MFnUnitAttribute unitAttrFn;
filePathAttr
= typedAttrFn.create("filePath", "fp", MFnData::kString, MObject::kNullObj, &retValue);
typedAttrFn.setInternal(true);
typedAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
CHECK_MSTATUS_AND_RETURN_IT(typedAttrFn.setUsedAsFilename(true));
retValue = addAttribute(filePathAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
filePathRelativeAttr
= numericAttrFn.create("filePathRelative", "fpr", MFnNumericData::kBoolean, 0.0, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setInternal(true);
numericAttrFn.setStorable(false);
numericAttrFn.setWritable(false);
retValue = addAttribute(filePathRelativeAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
primPathAttr
= typedAttrFn.create("primPath", "pp", MFnData::kString, MObject::kNullObj, &retValue);
typedAttrFn.setInternal(true);
typedAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(primPathAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
excludePrimPathsAttr = typedAttrFn.create(
"excludePrimPaths", "epp", MFnData::kString, MObject::kNullObj, &retValue);
typedAttrFn.setInternal(true);
typedAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(excludePrimPathsAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
loadPayloadsAttr
= numericAttrFn.create("loadPayloads", "lpl", MFnNumericData::kBoolean, 1.0, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setKeyable(false);
numericAttrFn.setReadable(false);
numericAttrFn.setInternal(true);
numericAttrFn.setHidden(true);
numericAttrFn.setAffectsAppearance(true);
retValue = addAttribute(loadPayloadsAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
shareStageAttr
= numericAttrFn.create("shareStage", "scmp", MFnNumericData::kBoolean, 1.0, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setKeyable(false);
numericAttrFn.setReadable(false);
numericAttrFn.setAffectsAppearance(true);
retValue = addAttribute(shareStageAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
timeAttr = unitAttrFn.create("time", "tm", MFnUnitAttribute::kTime, 0.0, &retValue);
unitAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(timeAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
complexityAttr = numericAttrFn.create("complexity", "cplx", MFnNumericData::kInt, 0, &retValue);
numericAttrFn.setMin(0);
numericAttrFn.setSoftMax(4);
numericAttrFn.setMax(8);
numericAttrFn.setChannelBox(true);
numericAttrFn.setStorable(false);
numericAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(complexityAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
inStageDataAttr = typedAttrFn.create(
"inStageData", "id", MayaUsdStageData::mayaTypeId, MObject::kNullObj, &retValue);
typedAttrFn.setReadable(false);
typedAttrFn.setStorable(false);
typedAttrFn.setDisconnectBehavior(MFnNumericAttribute::kReset); // on disconnect, reset to Null
typedAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(inStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
// inStageData or filepath-> inStageDataCached -> outStageData
inStageDataCachedAttr = typedAttrFn.create(
"inStageDataCached", "idc", MayaUsdStageData::mayaTypeId, MObject::kNullObj, &retValue);
typedAttrFn.setStorable(false);
typedAttrFn.setWritable(false);
typedAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(inStageDataCachedAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
stageCacheIdAttr
= numericAttrFn.create("stageCacheId", "stcid", MFnNumericData::kInt, -1, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setDisconnectBehavior(
MFnNumericAttribute::kReset); // on disconnect, reset to default
numericAttrFn.setStorable(false);
numericAttrFn.setCached(true);
numericAttrFn.setConnectable(true);
numericAttrFn.setReadable(true);
numericAttrFn.setInternal(true);
numericAttrFn.setAffectsAppearance(true);
retValue = addAttribute(stageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
drawRenderPurposeAttr = numericAttrFn.create(
"drawRenderPurpose", "drp", MFnNumericData::kBoolean, 0.0, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setKeyable(true);
numericAttrFn.setReadable(false);
numericAttrFn.setAffectsAppearance(true);
retValue = addAttribute(drawRenderPurposeAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
drawProxyPurposeAttr
= numericAttrFn.create("drawProxyPurpose", "dpp", MFnNumericData::kBoolean, 1.0, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setKeyable(true);
numericAttrFn.setReadable(false);
numericAttrFn.setAffectsAppearance(true);
retValue = addAttribute(drawProxyPurposeAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
drawGuidePurposeAttr
= numericAttrFn.create("drawGuidePurpose", "dgp", MFnNumericData::kBoolean, 0.0, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setKeyable(true);
numericAttrFn.setReadable(false);
numericAttrFn.setAffectsAppearance(true);
retValue = addAttribute(drawGuidePurposeAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
variantFallbacksAttr = typedAttrFn.create(
"variantFallbacks", "vfs", MFnData::kString, MObject::kNullObj, &retValue);
typedAttrFn.setReadable(true);
typedAttrFn.setWritable(true);
typedAttrFn.setConnectable(true);
typedAttrFn.setStorable(true);
typedAttrFn.setAffectsAppearance(true);
typedAttrFn.setInternal(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(variantFallbacksAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
// outputs
outTimeAttr = unitAttrFn.create("outTime", "otm", MFnUnitAttribute::kTime, 0.0, &retValue);
unitAttrFn.setCached(false);
unitAttrFn.setConnectable(true);
unitAttrFn.setReadable(true);
unitAttrFn.setStorable(false);
unitAttrFn.setWritable(false);
unitAttrFn.setAffectsAppearance(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(outTimeAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
outStageDataAttr = typedAttrFn.create(
"outStageData", "od", MayaUsdStageData::mayaTypeId, MObject::kNullObj, &retValue);
typedAttrFn.setStorable(false);
typedAttrFn.setWritable(false);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
updateCounterAttr
= numericAttrFn.create("updateId", "upid", MFnNumericData::kInt64, -1, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setStorable(false);
numericAttrFn.setWritable(false);
numericAttrFn.setHidden(true);
numericAttrFn.setInternal(true);
retValue = addAttribute(updateCounterAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
resyncCounterAttr
= numericAttrFn.create("resyncId", "rsid", MFnNumericData::kInt64, -1, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setStorable(false);
numericAttrFn.setWritable(false);
numericAttrFn.setHidden(true);
numericAttrFn.setInternal(true);
retValue = addAttribute(resyncCounterAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
outStageCacheIdAttr
= numericAttrFn.create("outStageCacheId", "ostcid", MFnNumericData::kInt, -1, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
numericAttrFn.setStorable(false);
numericAttrFn.setWritable(false);
retValue = addAttribute(outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
sessionLayerNameAttr = typedAttrFn.create(
"outStageSessionLayerId", "oslid", MFnData::kString, MObject::kNullObj, &retValue);
typedAttrFn.setInternal(true);
typedAttrFn.setHidden(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(sessionLayerNameAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
rootLayerNameAttr = typedAttrFn.create(
"outStageRootLayerId", "orlid", MFnData::kString, MObject::kNullObj, &retValue);
typedAttrFn.setInternal(true);
typedAttrFn.setHidden(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(rootLayerNameAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
mutedLayersAttr = typedAttrFn.create(
kMutedLayersAttrName, "mla", MFnData::kStringArray, MObject::kNullObj, &retValue);
typedAttrFn.setStorable(true);
typedAttrFn.setWritable(true);
typedAttrFn.setReadable(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(mutedLayersAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
lockedLayersAttr = typedAttrFn.create(
kLockedLayersAttrName, "lockla", MFnData::kStringArray, MObject::kNullObj, &retValue);
typedAttrFn.setStorable(true);
typedAttrFn.setWritable(true);
typedAttrFn.setReadable(true);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(lockedLayersAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
layerManagerAttr = typedAttrFn.create(
"layerManager", "lymgr", MFnData::kString, MObject::kNullObj, &retValue);
typedAttrFn.setStorable(true);
typedAttrFn.setWritable(true);
typedAttrFn.setReadable(true);
typedAttrFn.setInternal(true);
typedAttrFn.setHidden(true);
typedAttrFn.setDisconnectBehavior(MFnNumericAttribute::kReset); // on disconnect, reset to Null
typedAttrFn.setAffectsAppearance(false);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = addAttribute(layerManagerAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
//
// add attribute dependencies
//
retValue = attributeAffects(timeAttr, outTimeAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(filePathAttr, inStageDataCachedAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(filePathAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(filePathAttr, outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(filePathAttr, rootLayerNameAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(filePathAttr, sessionLayerNameAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(filePathAttr, primPathAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(primPathAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(primPathAttr, outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(shareStageAttr, inStageDataCachedAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(shareStageAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(shareStageAttr, outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(loadPayloadsAttr, inStageDataCachedAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(loadPayloadsAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(loadPayloadsAttr, outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(inStageDataAttr, inStageDataCachedAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(inStageDataAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(inStageDataAttr, outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(stageCacheIdAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(stageCacheIdAttr, inStageDataCachedAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(stageCacheIdAttr, outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(inStageDataCachedAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(inStageDataCachedAttr, outStageCacheIdAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(variantFallbacksAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
retValue = attributeAffects(layerManagerAttr, outStageDataAttr);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
return retValue;
}
/* static */
MayaUsdProxyShapeBase* MayaUsdProxyShapeBase::GetShapeAtDagPath(const MDagPath& dagPath)
{
MObject mObj = dagPath.node();
if (mObj.apiType() != MFn::kPluginShape) {
TF_CODING_ERROR(
"Could not get MayaUsdProxyShapeBase for non-plugin shape node "
"at DAG path: %s (apiTypeStr = %s)",
dagPath.fullPathName().asChar(),
mObj.apiTypeStr());
return nullptr;
}
const MFnDependencyNode depNodeFn(mObj);
MayaUsdProxyShapeBase* pShape = static_cast<MayaUsdProxyShapeBase*>(depNodeFn.userNode());
if (!pShape) {
TF_CODING_ERROR(
"Could not get MayaUsdProxyShapeBase for node at DAG path: %s",
dagPath.fullPathName().asChar());
return nullptr;
}
return pShape;
}
/* static */
int MayaUsdProxyShapeBase::countProxyShapeInstances() { return g_proxyShapeInstancesCount; }
/* static */
void MayaUsdProxyShapeBase::SetClosestPointDelegate(ClosestPointDelegate delegate)
{
_sharedClosestPointDelegate = delegate;
}
/* virtual */
bool MayaUsdProxyShapeBase::GetObjectSoftSelectEnabled() const { return false; }
void MayaUsdProxyShapeBase::enableProxyAccessor()
{
_usdAccessor = ProxyAccessor::createAndRegister(*this);
}
void beforeSaveCallback(void* clientData)
{
auto proxyShape = static_cast<MayaUsdProxyShapeBase*>(clientData);
if (!proxyShape) {
return;
}
MStatus status;
MFnDependencyNode depNode(proxyShape->thisMObject(), &status);
CHECK_MSTATUS(status);
MPlug filePathPlug = depNode.findPlug(MayaUsdProxyShapeBase::filePathAttr);
MPlug filePathRelativePlug = depNode.findPlug(MayaUsdProxyShapeBase::filePathRelativeAttr);
// Make proxy shape's file path relative if needed
ghc::filesystem::path filePath(filePathPlug.asString().asChar());
if (filePath.is_absolute() && filePathRelativePlug.asBool()) {
auto relativePath
= UsdMayaUtilFileSystem::getPathRelativeToMayaSceneFile(filePath.generic_string());
filePathPlug.setString(relativePath.c_str());
}
}
/* virtual */
void MayaUsdProxyShapeBase::postConstructor()
{
MProfilingScope profilingScope(
_shapeBaseProfilerCategory, MProfiler::kColorE_L3, "Issue Invalidate Stage Notice");
setRenderable(true);
MayaUsdProxyStageInvalidateNotice(*this).Send();
if (_preSaveCallbackId == 0) {
_preSaveCallbackId
= MSceneMessage::addCallback(MSceneMessage::kBeforeSave, beforeSaveCallback, this);
}
MayaUsd::MayaNodeTypeObserver& shapeObserver = getProxyShapesObserver();
MayaUsd::MayaNodeObserver* observer = shapeObserver.addObservedNode(thisMObject());
if (observer)
observer->addListener(*this);
}
/* virtual */
bool MayaUsdProxyShapeBase::getInternalValue(const MPlug& plug, MDataHandle& handle)
{
bool retVal = true;
if (plug == updateCounterAttr) {
handle.set(_UsdStageUpdateCounter);
} else if (plug == resyncCounterAttr) {
handle.set(_UsdStageResyncCounter);
} else {
retVal = MPxSurfaceShape::getInternalValue(plug, handle);
}
return retVal;
}
/* virtual */
MStatus MayaUsdProxyShapeBase::compute(const MPlug& plug, MDataBlock& dataBlock)
{
InComputeGuard inComputeGuard(*this);
if (plug == excludePrimPathsAttr || plug == timeAttr || plug == complexityAttr
|| plug == drawRenderPurposeAttr || plug == drawProxyPurposeAttr
|| plug == drawGuidePurposeAttr) {
MProfilingScope profilingScope(
_shapeBaseProfilerCategory,
MProfiler::kColorE_L3,
"Call MHWRender::MRenderer::setGeometryDrawDirty from compute");
// If the attribute that needs to be computed is one of these, then it
// does not affect the ouput stage data, but it *does* affect imaging
// the shape. In that case, we notify Maya that the shape needs to be
// redrawn and let it take care of computing the attribute. This covers
// the case where an attribute on the proxy shape may have an incoming
// connection from another node (e.g. "time1.outTime" being connected
// to the proxy shape's "time" attribute). In that case,
// setDependentsDirty() might not get called and only compute() might.
MHWRender::MRenderer::setGeometryDrawDirty(thisMObject());
return MS::kUnknownParameter;
} else if (plug == inStageDataCachedAttr) {
return computeInStageDataCached(dataBlock);
} else if (plug == outTimeAttr) {
auto retStatus = computeOutputTime(dataBlock);
ProxyAccessor::compute(_usdAccessor, plug, dataBlock);
return retStatus;
} else if (plug == outStageDataAttr) {
auto ret = computeOutStageData(dataBlock);
return ret;
} else if (plug == outStageCacheIdAttr) {
return computeOutStageCacheId(dataBlock);
} else if (plug.isDynamic()) {
return ProxyAccessor::compute(_usdAccessor, plug, dataBlock);
}
return MS::kUnknownParameter;
}
/* virtual */
SdfLayerRefPtr MayaUsdProxyShapeBase::computeRootLayer(MDataBlock& dataBlock, const std::string&)
{
if (LayerManager::supportedNodeType(MPxNode::typeId())) {
const MString rootLayerName = dataBlock.inputValue(rootLayerNameAttr).asString();
return LayerManager::findLayer(UsdMayaUtil::convert(rootLayerName), this);
} else {
return nullptr;
}
}
/* virtual */
SdfLayerRefPtr MayaUsdProxyShapeBase::computeSessionLayer(MDataBlock& dataBlock)
{
if (LayerManager::supportedNodeType(MPxNode::typeId())) {
auto sessionLayerName = dataBlock.inputValue(sessionLayerNameAttr).asString();
return LayerManager::findLayer(UsdMayaUtil::convert(sessionLayerName), this);
} else {
return nullptr;
}
}
namespace {
void remapSublayerRecursive(
const SdfLayerRefPtr& layer,
std::map<std::string, std::string> remappedLayers)
{
if (!layer || remappedLayers.empty())
return;
bool updated = false;
SdfSubLayerProxy sublayerPaths = layer->GetSubLayerPaths();
std::vector<std::string> newSublayerPaths;
newSublayerPaths.reserve(sublayerPaths.size());
for (const auto sublayerPath : sublayerPaths) {
auto sublayer = SdfLayer::Find(sublayerPath);
remapSublayerRecursive(sublayer, remappedLayers);
if (remappedLayers.empty())
return;
if (remappedLayers.find(sublayerPath) != remappedLayers.end()) {
updated = true;
if (!remappedLayers[sublayerPath].empty())
newSublayerPaths.push_back(remappedLayers[sublayerPath]);
remappedLayers.erase(sublayerPath);
} else {
newSublayerPaths.push_back(sublayerPath);
}
}
if (updated) {
layer->SetSubLayerPaths(newSublayerPaths);
}
}
void reproduceSharedStageState(
const UsdStageRefPtr& stage,
const SdfLayerRefPtr& sharedRootLayer,
const SdfLayerRefPtr& unsharedRootLayer)
{
if (!TF_VERIFY(stage))
return;
if (!TF_VERIFY(sharedRootLayer))
return;
if (!TF_VERIFY(unsharedRootLayer))
return;
// Transfer the FPS (frames-per-second) of the original root layer to the new unshared
// root layer, so that the animation timeline does not change. We copy both the metadata
// on the layer and on the stage object itself.
if (sharedRootLayer->HasFramesPerSecond()) {
const double fps = sharedRootLayer->GetFramesPerSecond();
unsharedRootLayer->SetFramesPerSecond(fps);
stage->SetFramesPerSecond(fps);
}
// Transfer the TCPS (timecodes-per-second) for the same reason as above.
if (sharedRootLayer->HasTimeCodesPerSecond()) {
const double tcps = sharedRootLayer->GetTimeCodesPerSecond();
unsharedRootLayer->SetTimeCodesPerSecond(tcps);
stage->SetTimeCodesPerSecond(tcps);
}
}
} // namespace
MStatus MayaUsdProxyShapeBase::computeInStageDataCached(MDataBlock& dataBlock)
{
MProfilingScope profilingScope(
_shapeBaseProfilerCategory, MProfiler::kColorE_L3, "Compute inStageDataCached plug");
MStatus retValue = MS::kSuccess;
// Background computation is relying on normal context
if (!dataBlock.context().isNormal()) {
// Create the output outData ========
MFnPluginData pluginDataFn;
MObject stageDataObj = pluginDataFn.create(MayaUsdStageData::mayaTypeId, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
MayaUsdStageData* outData
= reinterpret_cast<MayaUsdStageData*>(pluginDataFn.data(&retValue));
CHECK_MSTATUS_AND_RETURN_IT(retValue);
// When evaluating in background we should point to the same stage as in normal context
// This way we will share the stage between all evaluation context and avoid losing data
// in case of dirty stage, i.e. stage with new or modified layers.
MDGContext normalContext;
{
MDGContextGuard contextGuard(normalContext);
MDataBlock dataBlockForNormalContext = forceCache();
MDataHandle inDataCachedHandleForNormalContext
= dataBlockForNormalContext.inputValue(inStageDataCachedAttr, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
MayaUsdStageData* inData = dynamic_cast<MayaUsdStageData*>(
inDataCachedHandleForNormalContext.asPluginData());
// Set the outUsdStageData
outData->stage = inData->stage;
outData->primPath = inData->primPath;
}
// Retrieve data handle for stage data cache
MDataHandle outDataCachedHandle = dataBlock.outputValue(inStageDataCachedAttr, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
outDataCachedHandle.set(outData);
outDataCachedHandle.setClean();
return MS::kSuccess;
}
// Normal context computation
UsdStageRefPtr sharedUsdStage;
UsdStageRefPtr unsharedUsdStage;
UsdStageRefPtr finalUsdStage;
SdfPath primPath;
MayaUsd::LayerNameMap layerNameMap = LayerManager::getLayerNameMap(this);
MDataHandle inDataHandle = dataBlock.inputValue(inStageDataAttr, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
bool sharableStage = isShareableStage();
// Load the unshared comp from file
// This is so that we can remap the anon layer identifiers that have been loaded from disk which
// are saved in the unshared root layer
if (!_unsharedStageRootLayer && !sharableStage) {
// Once an anon layer is loaded the identifier changes
_unsharedStageRootLayer = computeRootLayer(dataBlock, "");
if (_unsharedStageRootLayer) {
// Anon layers when loaded will have difference identifiers, remap them
auto referencedLayers = MayaUsd::CustomLayerData::getStringArray(
_unsharedStageRootLayer, MayaUsdMetadata->ReferencedLayers);
VtArray<std::string> updatedReferences;
for (const auto& identifier : referencedLayers) {
// Update the identifier reference in the customer layer data
auto layer = LayerManager::findLayer(identifier, this);
if (layer) {
updatedReferences.push_back(layer->GetIdentifier());
}
// We also need to push this anyway in case we dont find it since file backed layers
// arent in the layermanager database
else {
updatedReferences.push_back(identifier);
}
}
if (!updatedReferences.empty()) {
MayaUsd::CustomLayerData::setStringArray(
updatedReferences, _unsharedStageRootLayer, MayaUsdMetadata->ReferencedLayers);
}
}
}
bool isIncomingStage = false;
// Note: we explicitly always load no payload initially and will load them
// later on if requested. The reason is that there are other code elsewhere
// that updates the stages. Those functions must find the same existing stages.
// Somewhat unfortunately, the OpenUSD API to open a stage only finds an existing
// stage if *all* parameters passed to open the stage match, including the initial
// load set. In order to be consistent everywhere, we must always pass in the same
// initial load set. Given that not loading payloads is the "lightest" version,
// that is what we request.
//
// Furthermore, for any stage that had its payload loaded or unloaded by the user
// we keep the detailed load and unload state of all prims, so we would use the
// load-none mode anyway and apply the detailed rules afterward, and this is
// probably the common case for stages that actually contain payloads.
//
// TODO: in the future, we need to provide a stage (and layer) internal manager
// that would stand between MayaUSD and OpenUSD and manage stages and layers
// and deal with consistent Open and other considerations, like updating stages
// and layers when anonymous layers are saved to disk.
const UsdStage::InitialLoadSet loadSet = UsdStage::InitialLoadSet::LoadNone;
// If inData has an incoming connection, then use it. Otherwise generate stage from the filepath
if (!inDataHandle.data().isNull()) {
MayaUsdStageData* inStageData
= dynamic_cast<MayaUsdStageData*>(inDataHandle.asPluginData());
sharedUsdStage = inStageData->stage;
primPath = inStageData->primPath;
isIncomingStage = true;
} else {
// Check if we have a Stage from the Cache Id
const auto cacheIdNum = dataBlock.inputValue(stageCacheIdAttr, &retValue).asInt();
CHECK_MSTATUS_AND_RETURN_IT(retValue);
const auto cacheId = UsdStageCache::Id::FromLongInt(cacheIdNum);
const auto stageCached = cacheId.IsValid() && UsdUtilsStageCache::Get().Contains(cacheId);
if (stageCached) {
sharedUsdStage = UsdUtilsStageCache::Get().Find(cacheId);
// Check what is the cache connected to
MStringArray result;
MGlobal::executeCommand(
("listConnections -t shape -shapes on " + this->name()), result);
// The stage is only incoming if the cache is connected to a shape
if (stageCached && result.length()) {
isIncomingStage = true;
}
// If the stage set by stage ID is not anonymous, set the filePath
// attribute to it so that it can be reloaded when the Maya scene
// is re-opened.
SdfLayerHandle rootLayer = sharedUsdStage->GetRootLayer();
if (rootLayer && !rootLayer->IsAnonymous()) {
MDataHandle outDataHandle = dataBlock.outputValue(filePathAttr, &retValue);
CHECK_MSTATUS_AND_RETURN_IT(retValue);
outDataHandle.set(MString(rootLayer->GetIdentifier().c_str()));
}
} else {
//
// Calculate from USD filepath and primPath and variantKey
//
// Get variant fallback from the proxy shape and set it as Global Variant fallbacks.
PcpVariantFallbackMap defaultVariantFallbacks;
PcpVariantFallbackMap fallbacks(updateVariantFallbacks(defaultVariantFallbacks, *this));
// Get input attr values
const MString file = dataBlock.inputValue(filePathAttr, &retValue).asString();
CHECK_MSTATUS_AND_RETURN_IT(retValue);
//
// let the usd stage cache deal with caching the usd stage data
//
std::string fileString = TfStringTrimRight(file.asChar());
TF_DEBUG(USDMAYA_PROXYSHAPEBASE)
.Msg(
"ProxyShapeBase::reloadStage original USD file path is %s\n",
fileString.c_str());
ghc::filesystem::path filestringPath(fileString);
if (filestringPath.is_absolute()) {
fileString = UsdMayaUtilFileSystem::resolvePath(fileString);
TF_DEBUG(USDMAYA_PROXYSHAPEBASE)
.Msg(
"ProxyShapeBase::reloadStage resolved the USD file path to %s\n",
fileString.c_str());
} else {
fileString = UsdMayaUtilFileSystem::resolveRelativePathWithinMayaContext(
thisMObject(), fileString);
TF_DEBUG(USDMAYA_PROXYSHAPEBASE)
.Msg(
"ProxyShapeBase::reloadStage resolved the relative USD file path to %s\n",
fileString.c_str());
}
// Fall back on providing the path "as is" to USD
if (fileString.empty()) {
fileString.assign(file.asChar(), file.length());
}
TF_DEBUG(USDMAYA_PROXYSHAPEBASE)
.Msg("ProxyShapeBase::loadStage called for the usd file: %s\n", fileString.c_str());
// == Load the Stage
{
#if AR_VERSION == 1
PXR_NS::ArGetResolver().ConfigureResolverForAsset(fileString);
#endif
// When opening or creating stages we must have an active UsdStageCache.
// The stage cache is the only one who holds a strong reference to the
// UsdStage. See https://github.com/Autodesk/maya-usd/issues/528 for
// more information.
UsdStageCacheContext ctx(
UsdMayaStageCache::Get(loadSet, UsdMayaStageCache::ShareMode::Shared));
SdfLayerRefPtr rootLayer