forked from dreamworksanimation/USD
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathimageable.cpp
544 lines (469 loc) · 15.9 KB
/
imageable.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
//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
// names, trademarks, service marks, or product names of the Licensor
// and its affiliates, except as required to comply with Section 4(c) of
// the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#include "pxr/usd/usdGeom/imageable.h"
#include "pxr/usd/usd/schemaRegistry.h"
#include "pxr/usd/usd/typed.h"
#include "pxr/usd/sdf/types.h"
#include "pxr/usd/sdf/assetPath.h"
PXR_NAMESPACE_OPEN_SCOPE
// Register the schema with the TfType system.
TF_REGISTRY_FUNCTION(TfType)
{
TfType::Define<UsdGeomImageable,
TfType::Bases< UsdTyped > >();
}
/* virtual */
UsdGeomImageable::~UsdGeomImageable()
{
}
/* static */
UsdGeomImageable
UsdGeomImageable::Get(const UsdStagePtr &stage, const SdfPath &path)
{
if (!stage) {
TF_CODING_ERROR("Invalid stage");
return UsdGeomImageable();
}
return UsdGeomImageable(stage->GetPrimAtPath(path));
}
/* static */
const TfType &
UsdGeomImageable::_GetStaticTfType()
{
static TfType tfType = TfType::Find<UsdGeomImageable>();
return tfType;
}
/* static */
bool
UsdGeomImageable::_IsTypedSchema()
{
static bool isTyped = _GetStaticTfType().IsA<UsdTyped>();
return isTyped;
}
/* virtual */
const TfType &
UsdGeomImageable::_GetTfType() const
{
return _GetStaticTfType();
}
UsdAttribute
UsdGeomImageable::GetVisibilityAttr() const
{
return GetPrim().GetAttribute(UsdGeomTokens->visibility);
}
UsdAttribute
UsdGeomImageable::CreateVisibilityAttr(VtValue const &defaultValue, bool writeSparsely) const
{
return UsdSchemaBase::_CreateAttr(UsdGeomTokens->visibility,
SdfValueTypeNames->Token,
/* custom = */ false,
SdfVariabilityVarying,
defaultValue,
writeSparsely);
}
UsdAttribute
UsdGeomImageable::GetPurposeAttr() const
{
return GetPrim().GetAttribute(UsdGeomTokens->purpose);
}
UsdAttribute
UsdGeomImageable::CreatePurposeAttr(VtValue const &defaultValue, bool writeSparsely) const
{
return UsdSchemaBase::_CreateAttr(UsdGeomTokens->purpose,
SdfValueTypeNames->Token,
/* custom = */ false,
SdfVariabilityUniform,
defaultValue,
writeSparsely);
}
UsdRelationship
UsdGeomImageable::GetProxyPrimRel() const
{
return GetPrim().GetRelationship(UsdGeomTokens->proxyPrim);
}
UsdRelationship
UsdGeomImageable::CreateProxyPrimRel() const
{
return GetPrim().CreateRelationship(UsdGeomTokens->proxyPrim,
/* custom = */ false);
}
namespace {
static inline TfTokenVector
_ConcatenateAttributeNames(const TfTokenVector& left,const TfTokenVector& right)
{
TfTokenVector result;
result.reserve(left.size() + right.size());
result.insert(result.end(), left.begin(), left.end());
result.insert(result.end(), right.begin(), right.end());
return result;
}
}
/*static*/
const TfTokenVector&
UsdGeomImageable::GetSchemaAttributeNames(bool includeInherited)
{
static TfTokenVector localNames = {
UsdGeomTokens->visibility,
UsdGeomTokens->purpose,
};
static TfTokenVector allNames =
_ConcatenateAttributeNames(
UsdTyped::GetSchemaAttributeNames(true),
localNames);
if (includeInherited)
return allNames;
else
return localNames;
}
PXR_NAMESPACE_CLOSE_SCOPE
// ===================================================================== //
// Feel free to add custom code below this line. It will be preserved by
// the code generator.
//
// Just remember to wrap code in the appropriate delimiters:
// 'PXR_NAMESPACE_OPEN_SCOPE', 'PXR_NAMESPACE_CLOSE_SCOPE'.
// ===================================================================== //
// --(BEGIN CUSTOM CODE)--
#include "pxr/usd/usdGeom/bboxCache.h"
#include "pxr/usd/usdGeom/xformCache.h"
#include "pxr/usd/usdGeom/primvarsAPI.h"
#include "pxr/base/tf/envSetting.h"
#include <boost/assign/list_of.hpp>
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_ENV_SETTING(
USD_GEOM_IMAGEABLE_DEPRECATE_PRIMVARS_API, false,
"Whether UsdGeomImageable's primvars API should issue deprecation warnings");
inline static void
_IssueAPIWarningIfDeprecationFlagEnabled()
{
if (TfGetEnvSetting(USD_GEOM_IMAGEABLE_DEPRECATE_PRIMVARS_API)) {
TF_WARN("API deprecation warning: UsdGeomImageable's primvars API "
"will be removed in the future. Use UsdGeomPrimvarsAPI "
"instead.");
}
}
UsdGeomPrimvar
UsdGeomImageable::CreatePrimvar(const TfToken& attrName,
const SdfValueTypeName &typeName,
const TfToken& interpolation,
int elementSize) const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim())
.CreatePrimvar(attrName, typeName, interpolation,
elementSize);
}
UsdGeomPrimvar
UsdGeomImageable::GetPrimvar(const TfToken &name) const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim()).GetPrimvar(name);
}
std::vector<UsdGeomPrimvar>
UsdGeomImageable::GetPrimvars() const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim()).GetPrimvars();
}
std::vector<UsdGeomPrimvar>
UsdGeomImageable::GetAuthoredPrimvars() const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim()).GetAuthoredPrimvars();
}
std::vector<UsdGeomPrimvar>
UsdGeomImageable::FindInheritedPrimvars() const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim()).FindInheritedPrimvars();
}
UsdGeomPrimvar
UsdGeomImageable::FindInheritedPrimvar(const TfToken &name) const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim()).FindInheritedPrimvar(name);
}
bool
UsdGeomImageable::HasPrimvar(const TfToken &name) const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim()).HasPrimvar(name);
}
bool
UsdGeomImageable::HasInheritedPrimvar(const TfToken &name) const
{
_IssueAPIWarningIfDeprecationFlagEnabled();
return UsdGeomPrimvarsAPI(GetPrim()).HasInheritedPrimvar(name);
}
/* static */
const TfTokenVector &
UsdGeomImageable::GetOrderedPurposeTokens()
{
static const TfTokenVector purposeTokens = boost::assign::list_of
(UsdGeomTokens->default_)
(UsdGeomTokens->render)
(UsdGeomTokens->proxy)
(UsdGeomTokens->guide);
return purposeTokens;
}
static
TfToken
_ComputeVisibility(UsdPrim const &prim, UsdTimeCode const &time)
{
TfToken localVis;
if (UsdGeomImageable ip = UsdGeomImageable(prim)) {
ip.GetVisibilityAttr().Get(&localVis, time);
if (localVis == UsdGeomTokens->invisible) {
return UsdGeomTokens->invisible;
}
}
if (UsdPrim parent = prim.GetParent()) {
return _ComputeVisibility(parent, time);
}
return UsdGeomTokens->inherited;
}
TfToken
UsdGeomImageable::ComputeVisibility(UsdTimeCode const &time) const
{
return _ComputeVisibility(GetPrim(), time);
}
static
TfToken
_ComputePurpose(UsdPrim const &prim, UsdPrim *root=NULL)
{
if (UsdPrim parent = prim.GetParent()){
TfToken myPurpose = _ComputePurpose(parent, root);
if (myPurpose != UsdGeomTokens->default_)
return myPurpose;
if (UsdGeomImageable ip = UsdGeomImageable(prim)){
ip.GetPurposeAttr().Get(&myPurpose);
if (root){
*root = prim;
}
}
return myPurpose;
}
return UsdGeomTokens->default_;
}
static void
_SetVisibility(const UsdGeomImageable &imageable, const TfToken &visState,
const UsdTimeCode &time)
{
imageable.CreateVisibilityAttr().Set(visState, time);
}
// Returns true if the imageable has its visibility set to 'invisible' at the
// given time. It also sets the visibility to inherited before returning.
static
bool
_SetInheritedIfInvisible(const UsdGeomImageable &imageable, const UsdTimeCode &time)
{
TfToken vis;
if (imageable.GetVisibilityAttr().Get(&vis, time)) {
if (vis == UsdGeomTokens->invisible) {
_SetVisibility(imageable, UsdGeomTokens->inherited, time);
return true;
}
}
return false;
}
static
void
_MakeVisible(const UsdPrim &prim, UsdTimeCode const &time, bool *hasInvisibleAncestor)
{
if (UsdPrim parent = prim.GetParent()) {
_MakeVisible(parent, time, hasInvisibleAncestor);
if (UsdGeomImageable imageableParent = UsdGeomImageable(parent)) {
// Change visibility of parent to inherited if it is invisible.
if (*hasInvisibleAncestor ||
_SetInheritedIfInvisible(imageableParent, time)) {
*hasInvisibleAncestor = true;
// Invis all siblings of prim.
UsdPrim::SiblingRange children = parent.GetAllChildren();
TF_FOR_ALL(childIt, children) {
const UsdPrim &childPrim = *childIt;
if (childPrim != prim) {
UsdGeomImageable imageableChild(childPrim);
if (imageableChild) {
_SetVisibility(imageableChild,
UsdGeomTokens->invisible, time);
}
}
}
}
}
}
}
void
UsdGeomImageable::MakeVisible(const UsdTimeCode &time) const
{
bool hasInvisibleAncestor = false;
_SetInheritedIfInvisible(*this, time);
_MakeVisible(GetPrim(), time, &hasInvisibleAncestor);
}
void
UsdGeomImageable::MakeInvisible(const UsdTimeCode &time) const
{
UsdAttribute visAttr = CreateVisibilityAttr();
TfToken myVis;
if (!visAttr.Get(&myVis, time) || myVis != UsdGeomTokens->invisible) {
visAttr.Set(UsdGeomTokens->invisible, time);
}
}
TfToken
UsdGeomImageable::ComputePurpose() const
{
return _ComputePurpose(GetPrim());
}
UsdPrim
UsdGeomImageable::ComputeProxyPrim(UsdPrim *renderPrim) const
{
UsdPrim purposeRoot, self=GetPrim();
TfToken purpose = _ComputePurpose(self, &purposeRoot);
if (purpose == UsdGeomTokens->render){
TF_VERIFY(purposeRoot);
SdfPathVector target;
UsdRelationship proxyPrimRel =
UsdGeomImageable(purposeRoot).GetProxyPrimRel();
if (proxyPrimRel.GetForwardedTargets(&target)){
if (target.size() == 1){
if (UsdPrim proxy = self.GetStage()->GetPrimAtPath(target[0])){
if (_ComputePurpose(proxy) != UsdGeomTokens->proxy){
TF_WARN("Prim <%s>, targeted as proxyPrim of prim "
"<%s> does not have purpose 'proxy'",
proxy.GetPath().GetText(),
purposeRoot.GetPath().GetText());
return UsdPrim();
}
if (renderPrim){
*renderPrim = purposeRoot;
}
return proxy;
}
}
else if (target.size() > 1){
TF_WARN("Found multiple targets for proxyPrim rel on "
"prim <%s>", purposeRoot.GetPath().GetText());
}
}
}
return UsdPrim();
}
bool
UsdGeomImageable::SetProxyPrim(const UsdPrim &proxy) const
{
if (proxy){
SdfPathVector targets {proxy.GetPath()};
return CreateProxyPrimRel().SetTargets(targets);
}
return false;
}
bool
UsdGeomImageable::SetProxyPrim(const UsdSchemaBase &proxy) const
{
if (proxy){
SdfPathVector targets {proxy.GetPrim().GetPath()};
return CreateProxyPrimRel().SetTargets(targets);
}
return false;
}
static
TfTokenVector
_MakePurposeVector(TfToken const &purpose1,
TfToken const &purpose2,
TfToken const &purpose3,
TfToken const &purpose4)
{
TfTokenVector purposes;
if (!purpose1.IsEmpty()) purposes.push_back(purpose1);
if (!purpose2.IsEmpty()) purposes.push_back(purpose2);
if (!purpose3.IsEmpty()) purposes.push_back(purpose3);
if (!purpose4.IsEmpty()) purposes.push_back(purpose4);
return purposes;
}
GfBBox3d
UsdGeomImageable::ComputeWorldBound(UsdTimeCode const& time,
TfToken const &purpose1,
TfToken const &purpose2,
TfToken const &purpose3,
TfToken const &purpose4) const
{
TfTokenVector purposes = _MakePurposeVector(purpose1, purpose2,
purpose3, purpose4);
if (purposes.empty()){
TF_CODING_ERROR("Must include at least one purpose when computing"
" bounds for prim at path <%s>. See "
"UsdGeomImageable::GetPurposeAttr().",
GetPrim().GetPath().GetText());
return GfBBox3d();
}
return UsdGeomBBoxCache(time, purposes).ComputeWorldBound(GetPrim());
}
GfBBox3d
UsdGeomImageable::ComputeLocalBound(UsdTimeCode const& time,
TfToken const &purpose1,
TfToken const &purpose2,
TfToken const &purpose3,
TfToken const &purpose4) const
{
TfTokenVector purposes = _MakePurposeVector(purpose1, purpose2,
purpose3, purpose4);
if (purposes.empty()){
TF_CODING_ERROR("Must include at least one purpose when computing"
" bounds for prim at path <%s>. See "
"UsdGeomImageable::GetPurposeAttr().",
GetPrim().GetPath().GetText());
return GfBBox3d();
}
return UsdGeomBBoxCache(time, purposes).ComputeLocalBound(GetPrim());
}
GfBBox3d
UsdGeomImageable::ComputeUntransformedBound(UsdTimeCode const& time,
TfToken const &purpose1,
TfToken const &purpose2,
TfToken const &purpose3,
TfToken const &purpose4) const
{
TfTokenVector purposes = _MakePurposeVector(purpose1, purpose2,
purpose3, purpose4);
if (purposes.empty()){
TF_CODING_ERROR("Must include at least one purpose when computing"
" bounds for prim at path <%s>. See "
"UsdGeomImageable::GetPurposeAttr().",
GetPrim().GetPath().GetText());
return GfBBox3d();
}
return
UsdGeomBBoxCache(time, purposes).ComputeUntransformedBound(GetPrim());
}
GfMatrix4d
UsdGeomImageable::ComputeLocalToWorldTransform(UsdTimeCode const &time) const
{
return UsdGeomXformCache(time).GetLocalToWorldTransform(GetPrim());
}
GfMatrix4d
UsdGeomImageable::ComputeParentToWorldTransform(UsdTimeCode const &time) const
{
return UsdGeomXformCache(time).GetParentToWorldTransform(GetPrim());
}
PXR_NAMESPACE_CLOSE_SCOPE