[Pxr] Add UsdStage::GetObjectAtPath. #390

superfunc · 2018-01-27T10:11:11Z

Description of Change(s)

This allows a convenient way to get items in a stage from paths,
whether they are property paths or prim paths.

Fixes Issue(s)

This was requested on the interest forum a while back, don't have the link handy.

jtran56 · 2018-01-29T17:54:53Z

Filed as internal issue #156422.

sunyab

Passing along some review notes, thanks!

sunyab · 2018-03-16T20:07:42Z

pxr/usd/lib/usd/stage.h

+    /// Suggested use:
+    ///
+    /// \code
+    /// if (UsdObject myObj = stage.GetObjectAtPath(path)) {


We can just use UsdObject::As in this example, since As is documented to return an invalid object if it's called on an invalid object, like:

if (UsdObject obj = stage->GetObjectAtPath(path)) { if (UsdPrim prim = obj.As<UsdPrim>()) { // Do things with prim } else if (UsdProperty prop = obj.As<UsdProperty>()) { // Do things with property. We can also cast to // UsdRelationship or UsdAttribute using this same pattern. } } else { // No object at specified path }

sunyab · 2018-03-16T20:08:07Z

pxr/usd/lib/usd/stage.h

+    /// proxy prim if a prim exists at the corresponding path in that instance's 
+    /// master.
+    ///
+    /// Suggested use:


Instead of 'Suggested use:', can we say 'Example:' instead?

sunyab · 2018-03-16T20:09:26Z

pxr/usd/lib/usd/stage.cpp

+    }
+
+    bool isPrimPath = path.IsPrimPath();
+    bool isPropPath = path.IsPropertyPath();


Can we make these bools const? Also, can we avoid calling IsPropertyPath() if isPrimPath is already true:

const bool isPrimPath = path.IsPrimPath(); const bool isPropPath = !isPrimPath && path.IsPropertyPath();

sunyab · 2018-03-16T20:10:22Z

pxr/usd/lib/usd/stage.cpp

+    }
+
+    // A valid prim must be found to return either a prim or prop
+    auto prim = GetPrimAtPath(path.GetPrimPath());


Can we avoid calling GetPrimPath() on paths we already know are prim paths?

sunyab · 2018-03-16T20:11:46Z

pxr/usd/lib/usd/stage.cpp

+    auto prim = GetPrimAtPath(path.GetPrimPath());
+    if (prim) {
+        if (isPrimPath) {
+            return prim.As<UsdObject>();


Shouldn't need to explicitly cast to UsdObject using As() here and below, the implicit derived-to-base conversion should be sufficient.

sunyab · 2018-03-16T20:15:30Z

pxr/usd/lib/usd/stage.h

@@ -700,6 +700,33 @@ class UsdStage : public TfRefBase, public TfWeakBase {
    USD_API
    UsdPrim GetPrimAtPath(const SdfPath &path) const;

+    /// Return the UsdObject at \p path, or an invalid UsdObject if none exists.
+    ///
+    /// If \p path indicates a prim beneath an instance, returns an instance


Can we add to this doc to mention properties and instance proxies as well? Something like,

If \p path indicates a property beneath a child of an instance, returns a property whose parent prim is an instance proxy prim.

Thanks for the notes, I'll get an updated branch pushed up this weekend.

Sorry for the delay @sunyab, updated

sunyab

Sorry for the delay, just have a few small follow-up notes. Thanks!

sunyab · 2018-04-27T18:13:03Z

pxr/usd/lib/usd/stage.cpp

+
+    // A valid prim must be found to return either a prim or prop
+    if (isPrimPath) {
+        if (auto prim = GetPrimAtPath(path)) {


I think we can just return GetPrimAtPath(path) here and avoid unnecessarily checking the validity of the prim here.

sunyab · 2018-04-27T18:14:15Z

pxr/usd/lib/usd/stage.cpp

+        }
+    } else if (isPropPath) {
+        if (auto prim = GetPrimAtPath(path.GetPrimPath())) {
+            if (auto prop = prim.GetProperty(path.GetNameToken())) {


Similar here; we need to check the validity of the prim, but we should be able to just return prim.GetProperty(...) and not need to check the validity of the property object before returning it.

sunyab

testUsdPrims is currently failing on the asserts I commented on below. I tested the fixes I noted in the comments and verified they work, so if you can make these changes I should be able to (finally) merge this in. Thanks!

sunyab · 2018-05-17T22:28:45Z

pxr/usd/lib/usd/testenv/testUsdPrims.py

+            # check for prims/props that dont exist
+            p = s.GetObjectAtPath(u'/nonexistent')
+            assert not p
+            assert type(p) is Usd.Object


These asserts are failing now. I think this assert needs to be:

assert type(p) is Usd.Prim

sunyab · 2018-05-17T22:28:56Z

pxr/usd/lib/usd/testenv/testUsdPrims.py

+
+            a = s.GetObjectAtPath(u'/foo.nonexistentattr')
+            assert not a
+            assert type(a) is Usd.Object


assert type(p) is Usd.Property

sunyab · 2018-05-17T22:29:10Z

pxr/usd/lib/usd/testenv/testUsdPrims.py

+
+            r = s.GetObjectAtPath(u'/foo.nonexistentrelationship')
+            assert not r 
+            assert type(r) is Usd.Object


assert type(r) is Usd.Property

superfunc · 2018-05-18T01:38:06Z

Sorry about that! I forgot CI isn't running the tests, I'll get this pushed in a few

This allows a convenient way to get items in a stage from paths, whether they are property paths or prim paths.

superfunc · 2018-05-18T04:34:54Z

Ok @sunyab should be good to go. I also smashed it down into one commit.

[Pxr] Add UsdStage::GetObjectAtPath.

superfunc force-pushed the stagegetobjectatpath branch from e74f0c4 to 5efc44c Compare January 27, 2018 23:18

sunyab requested changes Mar 16, 2018

View reviewed changes

superfunc force-pushed the stagegetobjectatpath branch from 5efc44c to c8dce55 Compare March 23, 2018 08:26

sunyab requested changes Apr 27, 2018

View reviewed changes

sunyab added the blocked Issue fix or pull request blocked until questions are answered or pending notes are addressed label Apr 27, 2018

superfunc force-pushed the stagegetobjectatpath branch from c8dce55 to b179b9c Compare April 28, 2018 16:12

sunyab requested changes May 17, 2018

View reviewed changes

superfunc force-pushed the stagegetobjectatpath branch from b179b9c to f4b05ce Compare May 18, 2018 02:27

[Pxr] Add UsdStage::GetObjectAtPath.

069c4b1

This allows a convenient way to get items in a stage from paths, whether they are property paths or prim paths.

superfunc force-pushed the stagegetobjectatpath branch from f4b05ce to 069c4b1 Compare May 18, 2018 04:30

sunyab added pending push and removed blocked Issue fix or pull request blocked until questions are answered or pending notes are addressed labels May 21, 2018

pixar-oss merged commit 069c4b1 into PixarAnimationStudios:dev May 21, 2018

pixar-oss added a commit that referenced this pull request May 21, 2018

Merge pull request #390 from superfunc/stagegetobjectatpath

0f35a32

[Pxr] Add UsdStage::GetObjectAtPath.

superfunc deleted the stagegetobjectatpath branch May 21, 2018 18:31

sunyab removed the pending push label Aug 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Pxr] Add UsdStage::GetObjectAtPath. #390

[Pxr] Add UsdStage::GetObjectAtPath. #390

superfunc commented Jan 27, 2018

jtran56 commented Jan 29, 2018

sunyab left a comment

sunyab Mar 16, 2018

sunyab Mar 16, 2018

sunyab Mar 16, 2018

sunyab Mar 16, 2018

sunyab Mar 16, 2018

sunyab Mar 16, 2018

superfunc Mar 16, 2018

superfunc Mar 23, 2018

sunyab left a comment

sunyab Apr 27, 2018

sunyab Apr 27, 2018

sunyab left a comment

sunyab May 17, 2018

sunyab May 17, 2018

sunyab May 17, 2018

superfunc commented May 18, 2018

superfunc commented May 18, 2018

[Pxr] Add UsdStage::GetObjectAtPath. #390

[Pxr] Add UsdStage::GetObjectAtPath. #390

Conversation

superfunc commented Jan 27, 2018

Description of Change(s)

Fixes Issue(s)

jtran56 commented Jan 29, 2018

sunyab left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunyab left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunyab left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

superfunc commented May 18, 2018

superfunc commented May 18, 2018