Update to newer UFE interface for Create Group #593
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| // | ||
| // Copyright 2019 Autodesk | ||
|
There was a problem hiding this comment. I guess we have to update the copyright year? There was a problem hiding this comment. Yeah, this is the new file and I should have 2020 here (it's there in the .h). We don't update these dates in all files though. |
||
| // | ||
| // 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 "UsdUndoAddNewPrimCommand.h" | ||
|
|
||
| #include <mayaUsd/ufe/Global.h> | ||
| #include <mayaUsd/ufe/Utils.h> | ||
|
|
||
| namespace { | ||
|
|
||
| Ufe::Path appendToPath(const Ufe::Path& path, const std::string& name) | ||
|
There was a problem hiding this comment. This is absolutely perfect, I know, and it's just a question of style, but I'm a ternary ops guy: return (1 == path.getSegments().size()) ? path + Ufe::PathSegment(Ufe::PathComponent(name), MayaUsd::ufe::getUsdRunTimeId(), '/') : path + name; Sorry, couldn't help myself, you can leave your code as-is. There was a problem hiding this comment. I'm going to leave as-is since this is one of those chunks of code where you occasionally do want to be able to set a breakpoint to stop in a certain situation (dealing with the proxy vs. a prim). |
||
| { | ||
| Ufe::Path newUfePath; | ||
| if (1 == path.getSegments().size()) { | ||
| newUfePath = path + Ufe::PathSegment( | ||
| Ufe::PathComponent(name), MayaUsd::ufe::getUsdRunTimeId(), '/'); | ||
|
There was a problem hiding this comment. This feels a bit awkward. I see that in places you start with a PathComponent, and convert it to a string, but here we're doing the reverse, converting the string back to a PathComponent. Why could we not stick with PathComponent throughout, if it's going to be used in a Path in the end? There was a problem hiding this comment. Not sure I'm seeing what change you're suggesting. Where are the other PathComponents? There was a problem hiding this comment. Here's the chain: UsdUndoCreateGroupCommand::redo() calls UsdUndoAddNewPrimCommand::create(), converts to string for the call. create() calls the UsdUndoAddNewPrimCommand, which calls appendToPath(), which takes the string and converts to a PathComponent. Therefore, could have been a PathComponent throughout, it seems. |
||
| } else { | ||
| newUfePath = path + name; | ||
| } | ||
| return newUfePath; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| MAYAUSD_NS_DEF { | ||
| namespace ufe { | ||
|
|
||
| UsdUndoAddNewPrimCommand::UsdUndoAddNewPrimCommand(const UsdSceneItem::Ptr& usdSceneItem, | ||
| const std::string& name, const std::string& type) | ||
| : Ufe::UndoableCommand() | ||
| { | ||
| // First get the stage from the proxy shape. | ||
| auto ufePath = usdSceneItem->path(); | ||
| auto segments = ufePath.getSegments(); | ||
| auto dagSegment = segments[0]; | ||
| _stage = MayaUsd::ufe::getStage(Ufe::Path(dagSegment)); | ||
|
There was a problem hiding this comment. Nit-pick: can remove the MayaUsd::ufe namespace prefix, that's the namespace we're in. There was a problem hiding this comment. Since you have a UsdSceneItem, to get the stage you can just use: usdSceneItem->prim().GetStage() |
||
| if (_stage) { | ||
| // Append the parent path and the requested name into a full ufe path. | ||
| _newUfePath = appendToPath(ufePath, name); | ||
|
|
||
| // Ensure the requested name is unique. | ||
| auto newPrimName = uniqueChildName(usdSceneItem, _newUfePath); | ||
|
|
||
| // If the name had to change then we need to update the full ufe path. | ||
| if (name != newPrimName) { | ||
| _newUfePath = appendToPath(ufePath, newPrimName); | ||
| } | ||
|
|
||
| // Build (and store) the usd path for the new prim with the unique name. | ||
| PXR_NS::SdfPath usdItemPath = usdSceneItem->prim().GetPath(); | ||
| _primPath = usdItemPath.AppendChild(PXR_NS::TfToken(newPrimName)); | ||
|
|
||
| // The type of prim we were asked to create. | ||
| // Note: "Def" means create typeless prim. | ||
| _primToken = (type.empty() || type == "Def") ? TfToken() : TfToken(name); | ||
| } | ||
| } | ||
|
|
||
| void UsdUndoAddNewPrimCommand::undo() | ||
| { | ||
| if (_stage) { | ||
| _stage->RemovePrim(_primPath); | ||
| } | ||
| } | ||
|
|
||
| void UsdUndoAddNewPrimCommand::redo() | ||
| { | ||
| if (_stage) { | ||
| auto prim = _stage->DefinePrim(_primPath, _primToken); | ||
| if (!prim.IsValid()) | ||
| TF_RUNTIME_ERROR("Failed to create new prim type: %s", _primToken.GetText()); | ||
| } | ||
| } | ||
|
|
||
| const Ufe::Path& UsdUndoAddNewPrimCommand::newUfePath() const | ||
| { | ||
| return _newUfePath; | ||
| } | ||
|
|
||
| /*static*/ | ||
| UsdUndoAddNewPrimCommand::Ptr UsdUndoAddNewPrimCommand::create(const UsdSceneItem::Ptr& usdSceneItem, | ||
| const std::string& name, const std::string& type) | ||
| { | ||
| return std::make_shared<UsdUndoAddNewPrimCommand>(usdSceneItem, name, type); | ||
| } | ||
|
|
||
| } // namespace ufe | ||
| } // namespace MayaUsd | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // | ||
| // Copyright 2020 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_ADD_NEW_PRIM_COMMAND | ||
| #define USD_ADD_NEW_PRIM_COMMAND | ||
|
|
||
| #include <ufe/undoableCommand.h> | ||
| #include <ufe/path.h> | ||
|
|
||
| #include <mayaUsd/base/api.h> | ||
| #include <mayaUsd/ufe/UsdSceneItem.h> | ||
|
|
||
| PXR_NAMESPACE_USING_DIRECTIVE | ||
|
|
||
| MAYAUSD_NS_DEF { | ||
| namespace ufe { | ||
|
|
||
| //! \brief Undoable command for add new prim | ||
| class MAYAUSD_CORE_PUBLIC UsdUndoAddNewPrimCommand : public Ufe::UndoableCommand | ||
| { | ||
| public: | ||
| typedef std::shared_ptr<UsdUndoAddNewPrimCommand> Ptr; | ||
|
|
||
| UsdUndoAddNewPrimCommand(const UsdSceneItem::Ptr& usdSceneItem, | ||
| const std::string& name, | ||
| const std::string& type); | ||
|
|
||
| void undo() override; | ||
| void redo() override; | ||
|
|
||
| const Ufe::Path& newUfePath() const; | ||
|
|
||
| static UsdUndoAddNewPrimCommand::Ptr create(const UsdSceneItem::Ptr& usdSceneItem, | ||
|
There was a problem hiding this comment. Actually I'm voting to leave as-is. All the other command classes have the full namespace listed here (so this one would look a bit odd if it was the only one that didn't), and I actually like it because there are multiple "Ptr" typedefs being used (e.g. this class has a Ptr and there's also the scene item Ptr's being used in the same functions). |
||
| const std::string& name, const std::string& type); | ||
| private: | ||
| PXR_NS::UsdStageWeakPtr _stage; | ||
| PXR_NS::SdfPath _primPath; | ||
| PXR_NS::TfToken _primToken; | ||
| Ufe::Path _newUfePath; | ||
|
|
||
| }; // UsdUndoAddNewPrimCommand | ||
|
|
||
| } // namespace ufe | ||
| } // namespace MayaUsd | ||
|
|
||
| #endif | ||
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.
Since these are shared_ptr, you don't really need '= nullptr'
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.
true