EMSUSD-3563: Add new reference workflow implementation #4591
+233
−2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| // | ||
| // Copyright 2026 Autodesk | ||
| // | ||
| // 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 "UsdUndoAddReferenceToNewPrimCommand.h" | ||
|
|
||
| #include <usdUfe/ufe/Utils.h> | ||
| #include <usdUfe/utils/editRouterContext.h> | ||
|
|
||
| #include <pxr/base/tf/token.h> | ||
| #include <pxr/usd/sdf/path.h> | ||
| #include <pxr/usd/sdf/payload.h> | ||
| #include <pxr/usd/sdf/reference.h> | ||
| #include <pxr/usd/usd/payloads.h> | ||
| #include <pxr/usd/usd/references.h> | ||
| #include <pxr/usd/usd/stage.h> | ||
|
|
||
| namespace USDUFE_NS_DEF { | ||
|
|
||
| PXR_NAMESPACE_USING_DIRECTIVE | ||
|
|
||
| USDUFE_VERIFY_CLASS_SETUP( | ||
| UsdUndoableCommand<Ufe::UndoableCommand>, | ||
| UsdUndoAddReferenceToNewPrimCommand); | ||
|
|
||
| /* static */ | ||
| UsdListPosition UsdUndoAddReferenceToNewPrimCommand::getListPosition(bool prepend) | ||
| { | ||
| return prepend ? UsdListPositionBackOfPrependList : UsdListPositionBackOfAppendList; | ||
| } | ||
|
|
||
| UsdUndoAddReferenceToNewPrimCommand::UsdUndoAddReferenceToNewPrimCommand( | ||
| const UsdPrim& parentPrim, | ||
| const std::string& newPrimName, | ||
| const std::string& newPrimType, | ||
| const std::string& filePath, | ||
| const std::string& primPath, | ||
| bool prepend, | ||
| bool isPayload, | ||
| bool preload) | ||
| : _parentPrim(parentPrim) | ||
| , _newPrimName(newPrimName) | ||
| , _newPrimType(newPrimType) | ||
| , _filePath(filePath) | ||
| , _primPath(primPath) | ||
| , _prepend(prepend) | ||
| , _isPayload(isPayload) | ||
| , _preload(preload) | ||
| { | ||
| } | ||
|
|
||
| void UsdUndoAddReferenceToNewPrimCommand::executeImplementation() | ||
| { | ||
| if (!_parentPrim.IsValid()) | ||
| return; | ||
|
|
||
| auto stage = _parentPrim.GetStage(); | ||
| if (!stage) | ||
| return; | ||
|
|
||
| const std::string uniqueName = UsdUfe::uniqueChildName(_parentPrim, _newPrimName); | ||
| const SdfPath childPath = _parentPrim.GetPath().AppendChild(TfToken(uniqueName)); | ||
|
|
||
| UsdPrim newPrim; | ||
| if (_newPrimType == "Class") { | ||
| newPrim = stage->CreateClassPrim(childPath); | ||
|
Collaborator
There was a problem hiding this comment. is that a real workflow, to reference a class prim into a new class prim? seems weird. Having a default class prim seems weird as well, dunno what that means |
||
| } else { | ||
| TfToken typeToken = _newPrimType.empty() ? TfToken() : TfToken(_newPrimType); | ||
|
Collaborator
There was a problem hiding this comment. i dont htink empty type is a good default |
||
| newPrim = stage->DefinePrim(childPath, typeToken); | ||
| } | ||
|
|
||
| if (!newPrim.IsValid()) { | ||
| TF_RUNTIME_ERROR( | ||
| "UsdUndoAddReferenceToNewPrimCommand: failed to create prim '%s'", | ||
| childPath.GetText()); | ||
| return; | ||
| } | ||
|
|
||
| const SdfPath refPrimPath = _primPath.empty() ? SdfPath() : SdfPath(_primPath); | ||
|
Collaborator
There was a problem hiding this comment. I assume below here is like the add reference command? Would it not be simpler to just have a composite command and reuse the add reference command we already have? |
||
| const auto listPos = getListPosition(_prepend); | ||
|
|
||
| if (_isPayload) { | ||
| SdfPayload payload(_filePath, refPrimPath); | ||
| UsdPayloads primPayloads = newPrim.GetPayloads(); | ||
| PrimMetadataEditRouterContext ctx(newPrim, SdfFieldKeys->Payload); | ||
| primPayloads.AddPayload(payload, listPos); | ||
| if (_preload) { | ||
| stage->LoadAndUnload( | ||
| SdfPathSet { newPrim.GetPath() }, SdfPathSet {}, UsdLoadWithDescendants); | ||
| } else { | ||
| stage->LoadAndUnload(SdfPathSet {}, SdfPathSet { newPrim.GetPath() }); | ||
| } | ||
| } else { | ||
| SdfReference ref(_filePath, refPrimPath); | ||
| UsdReferences primRefs = newPrim.GetReferences(); | ||
| PrimMetadataEditRouterContext ctx(newPrim, SdfFieldKeys->References); | ||
| primRefs.AddReference(ref, listPos); | ||
| } | ||
| } | ||
|
|
||
| } // namespace USDUFE_NS_DEF | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| // | ||
| // Copyright 2026 Autodesk | ||
| // | ||
| // 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. | ||
| // | ||
| #ifndef USD_UFE_ADD_REFERENCE_TO_NEW_PRIM_COMMAND | ||
| #define USD_UFE_ADD_REFERENCE_TO_NEW_PRIM_COMMAND | ||
|
|
||
| #include <usdUfe/base/api.h> | ||
| #include <usdUfe/ufe/UsdUndoableCommand.h> | ||
|
|
||
| #include <pxr/usd/usd/common.h> | ||
| #include <pxr/usd/usd/prim.h> | ||
|
|
||
| #include <ufe/undoableCommand.h> | ||
|
|
||
| #include <string> | ||
|
|
||
| namespace USDUFE_NS_DEF { | ||
|
|
||
| //! \brief Command that creates a new child prim and adds a reference (or payload) arc to | ||
| //! it in a single atomic undo/redo operation. | ||
| class USDUFE_PUBLIC UsdUndoAddReferenceToNewPrimCommand | ||
| : public UsdUndoableCommand<Ufe::UndoableCommand> | ||
| { | ||
| public: | ||
| UsdUndoAddReferenceToNewPrimCommand( | ||
|
Collaborator
There was a problem hiding this comment. the other add ref command is exposed to python maya-usd/lib/usdUfe/python/wrapCommands.cpp Line 147 in 139c895
Collaborator
There was a problem hiding this comment. useful if only for tests : |
||
| const PXR_NS::UsdPrim& parentPrim, | ||
| const std::string& newPrimName, | ||
| const std::string& newPrimType, | ||
| const std::string& filePath, | ||
| const std::string& primPath, | ||
| bool prepend, | ||
| bool isPayload = false, | ||
| bool preload = false); | ||
|
|
||
| USDUFE_DISALLOW_COPY_MOVE_AND_ASSIGNMENT(UsdUndoAddReferenceToNewPrimCommand); | ||
|
|
||
| protected: | ||
| void executeImplementation() override; | ||
|
|
||
| private: | ||
| static PXR_NS::UsdListPosition getListPosition(bool prepend); | ||
|
|
||
| PXR_NS::UsdPrim _parentPrim; | ||
| std::string _newPrimName; | ||
| std::string _newPrimType; | ||
| std::string _filePath; | ||
| std::string _primPath; | ||
| bool _prepend; | ||
| bool _isPayload; | ||
| bool _preload; | ||
| }; | ||
|
|
||
| } // namespace USDUFE_NS_DEF | ||
|
|
||
| #endif /* USD_UFE_ADD_REFERENCE_TO_NEW_PRIM_COMMAND */ | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should that cover \ and /. , maybe use the filesystem util maya-usd uses?