Add setNameGlobal which updates connections downstream#2386
Conversation
ld-kerley
left a comment
There was a problem hiding this comment.
Thanks @rasmustilljander - this looks like it's gonna make editing documents a lot more straight forwards!
jstone-lucasfilm
left a comment
There was a problem hiding this comment.
This looks very promising, @rasmustilljander, and I've written up a suggested improvement.
jstone-lucasfilm
left a comment
There was a problem hiding this comment.
Great work, @rasmustilljander, and I've written up a proposal for the language of the doc strings.
| /// @name Name | ||
| /// @{ | ||
|
|
||
| /// Set the element's name string. The name of a MaterialX element must be |
There was a problem hiding this comment.
For these new docstrings, my recommendation would be to be specific about the element subclass (e.g. Node, NodeGraph), and to omit the repeated language of the general rules for MaterialX element names.
Here's a proposed update to the doc string for the Node method, and the same approach should work for NodeGraph as well:
/// Set the name string of this Node, propagating the updated name to all
/// downstream ports.
/// @throws Exception if an element at the same scope already possesses the
/// given name.
There was a problem hiding this comment.
Looks great, I updated the docs to align with your suggestion!
Signed-off-by: Jonathan Stone <jstone@lucasfilm.com>
Signed-off-by: Jonathan Stone <jstone@lucasfilm.com>
Signed-off-by: Jonathan Stone <jstone@lucasfilm.com>
jstone-lucasfilm
left a comment
There was a problem hiding this comment.
This looks good to me, thanks @rasmustilljander!
f564898
into
AcademySoftwareFoundation:main
This solves (or partially solves): #1847
This commit adds the method
setNameGlobalforNodeandNodeGraph. It behaves likesetNamebut also walk downstream and updates corresponding node or nodegraph name.API added