 |
|
|
|
Notice sent in response to authored changes that affect UsdObjects. More...
#include <notice.h>
Inheritance diagram for UsdNotice::ObjectsChanged:Classes | |
| class | PathRange |
| An iterable range of paths to objects that have changed. More... | |
Public Types | |
| enum class | PrimResyncType { RenameSource , RenameDestination , ReparentSource , ReparentDestination , RenameAndReparentSource , RenameAndReparentDestination , Delete , UnchangedPrimStack , Other , Invalid } |
| A type for further classifying objects that have may have been resynced because of namespace edits. More... | |
| using | RenamedProperties = std::vector< std::pair< SdfPath, TfToken > > |
| Value type holding a list of property paths that have been renamed via the UsdNamespaceEditor paired with the new name of the property. | |
| Public Types inherited from TfNotice | |
| typedef TfWeakPtr< Probe > | WeakProbePtr |
| typedef std::vector< Key > | Keys |
A TfNotice::Key container. | |
Public Member Functions | |
| bool | AffectedObject (const UsdObject &obj) const |
Return true if obj was possibly affected by the layer changes that generated this notice. | |
| USD_API bool | ResyncedObject (const UsdObject &obj) const |
Return true if obj was resynced by the layer changes that generated this notice. | |
| USD_API bool | ResolvedAssetPathsResynced (const UsdObject &obj) const |
Return true if asset path values in obj were resynced by the layer changes that generated this notice. | |
| USD_API bool | ChangedInfoOnly (const UsdObject &obj) const |
Return true if obj was changed but not resynced by the layer changes that generated this notice. | |
| USD_API PathRange | GetResyncedPaths () const |
| Return the set of paths that are resynced in lexicographical order. | |
| USD_API PathRange | GetChangedInfoOnlyPaths () const |
| Return the set of paths that have only info changes (those that do not affect the structure of cached UsdPrims on a UsdStage) in lexicographical order. | |
| USD_API PathRange | GetResolvedAssetPathsResyncedPaths () const |
| Return the set of paths affected by changes that may cause asset path values to resolve to different locations, even though the asset path authored in scene description has not changed. | |
| USD_API TfTokenVector | GetChangedFields (const UsdObject &obj) const |
Return the set of changed fields in layers that affected obj. | |
| USD_API TfTokenVector | GetChangedFields (const SdfPath &path) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| USD_API bool | HasChangedFields (const UsdObject &obj) const |
Return true if there are any changed fields that affected obj, false otherwise. | |
| USD_API bool | HasChangedFields (const SdfPath &path) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| USD_API PrimResyncType | GetPrimResyncType (const SdfPath &primPath, SdfPath *associatedPrimPath=nullptr) const |
Returns the type of resync that has occurred for the prim at primPath. | |
| const RenamedProperties & | GetRenamedProperties () const |
| Return the list of property paths that have been renamed via a UsdNamespaceEditor ApplyEdits operation along with the new names of those properties. | |
| Public Member Functions inherited from UsdNotice::StageNotice | |
| USD_API | StageNotice (const UsdStageWeakPtr &stage) |
| const UsdStageWeakPtr & | GetStage () const |
| Return the stage associated with this notice. | |
| Public Member Functions inherited from TfNotice | |
| TF_API size_t | Send () const |
| Deliver the notice to interested listeners, returning the number of interested listeners. | |
| template<typename SenderPtr > | |
| size_t | Send (SenderPtr const &s) const |
| Deliver the notice to interested listeners, returning the number of interested listeners. | |
| TF_API size_t | SendWithWeakBase (const TfWeakBase *senderWeakBase, const void *senderUniqueId, const std::type_info &type) const |
| Variant of Send() that takes a specific sender in the form of a TfWeakBase pointer and a typeid. | |
Friends | |
| class | UsdStage |
Additional Inherited Members | |
| Static Public Member Functions inherited from TfNotice | |
| static TF_API void | InsertProbe (const WeakProbePtr &probe) |
| Register a probe that will be invoked when notices are sent and delivered. | |
| static TF_API void | RemoveProbe (const WeakProbePtr &probe) |
Remove a probe that was previously registered with InsertProbe. | |
| template<class LPtr , class MethodPtr > | |
| static TfNotice::Key | Register (LPtr const &listener, MethodPtr method) |
Register a listener as being interested in a TfNotice. | |
| template<class LPtr , class MethodPtr , class SenderPtr > | |
| static TfNotice::Key | Register (LPtr const &listener, MethodPtr method, SenderPtr const &sender) |
| template<class LPtr , class MethodPtr > | |
| static TfNotice::Key | Register (LPtr const &listener, MethodPtr method, const TfType ¬iceType, const TfAnyWeakPtr &sender) |
| static TF_API bool | Revoke (TfNotice::Key &key) |
| Revoke interest by a listener. | |
| static TF_API void | Revoke (TfNotice::Keys *keys) |
| Revoke interest by listeners. | |
| static TF_API bool | RevokeAndWait (TfNotice::Key &key) |
| Revoke interest by a listener. | |
| static TF_API void | RevokeAndWait (TfNotice::Keys *keys) |
| Revoke interest by listeners. | |
Notice sent in response to authored changes that affect UsdObjects.
The kinds of object changes are divided into these categories:
"Resyncs" are potentially structural changes that invalidate entire subtrees of UsdObjects (including prims and properties). For example, if the path "/foo" is resynced, then all subpaths like "/foo/bar" and "/foo/bar.baz" may be arbitrarily changed.
When a prim is resynced, say "/foo/bar", it might have been created or destroyed. Indication of possible changes flows down the resynced prim namespace, implicitly via prim resync notices. We do not consider the parent "/foo" to be resynced, as this would incorrectly imply that some or all of "/foo/bar"'s siblings (and their descendants) have also changed. Additionally, we do not propagate change indication to objects associated with the changed object through relationships or connections.
"Resolved asset path resyncs" invalidate asset paths in a subtree of objects. Asset paths authored anywhere in this subtree of objects (e.g. as attribute or metadata values) may now resolve to different locations, even though the asset path authored in scene description has not changed.
"Changed-info" means that a nonstructural change has occurred, like an attribute value change or a value change to a metadata field not related to composition. Unlike resyncs, changed-info notices for an object do not imply that the subtree beneath that object have changed.
This notice provides API for two client use-cases. Clients interested in testing whether specific objects are affected by the changes should use the methods that return a bool, like AffectedObject(). Clients that wish to reason about all changes as a whole should use the methods that return a PathRange, like GetResyncedPaths().
| using RenamedProperties = std::vector<std::pair<SdfPath, TfToken> > |
Value type holding a list of property paths that have been renamed via the UsdNamespaceEditor paired with the new name of the property.
|
strong |
A type for further classifying objects that have may have been resynced because of namespace edits.
| Enumerator | |
|---|---|
| RenameSource | These six types indicate that a resynced object was moved to a new path, via a UsdNamespaceEditor, and that object at the new path has the same computed prim stack as the objects at the original path did (i.e. the new object composes the exact same layer opinions in the exact same order as the original object). The old path resync will be classified as a Source and the new path resync will be classified as a Destination. |
| Delete | This Delete type indicates that an object has been removed from the stage without an indication that it was the source of a rename and/or a reparent operation. |
| UnchangedPrimStack | The UnchangedPrimStack type indicates that the resynced object still exists and is effectively unchanged in that it has the same composed prim stack as before it was resynced. This can occur when composition arcs are changed or dependent layer specs are moved to maintain prims of dependent stages in a UsdNamespaceEditor edit. |
| Other | This type indicates all other resyncs that we cannot classify based on namespace edit information. This other type does not necesarily imply that we don't have a rename, reparent, noop, etc. but rather that we cannot determine the type and need to treat it as a full resync. |
| Invalid | Invalid indicates that the object has not been resynced. |
|
inline |
Return true if obj was possibly affected by the layer changes that generated this notice.
This is the case if either the object is subject to a resync or has changed info. Equivalent to:
| USD_API bool ChangedInfoOnly | ( | const UsdObject & | obj | ) | const |
Return true if obj was changed but not resynced by the layer changes that generated this notice.
This is the case if this object's exact path is present in GetChangedInfoOnlyPaths().
| USD_API TfTokenVector GetChangedFields | ( | const SdfPath & | path | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| USD_API TfTokenVector GetChangedFields | ( | const UsdObject & | obj | ) | const |
Return the set of changed fields in layers that affected obj.
This set will be empty for objects whose paths are not in GetResyncedPaths() or GetChangedInfoOnlyPaths().
If a field is present in this set, it does not necessarily mean the composed value of that field on obj has changed. For example, if a metadata value on obj is overridden in a stronger layer and is changed in a weaker layer, that field will appear in this set. However, since the value in the stronger layer did not change, the composed value returned by GetMetadata() will not have changed.
| USD_API PathRange GetChangedInfoOnlyPaths | ( | ) | const |
Return the set of paths that have only info changes (those that do not affect the structure of cached UsdPrims on a UsdStage) in lexicographical order.
Info changes do not imply entire subtree invalidation, so this set is not minimal regarding ancestors and descendants, as opposed to GetResyncedPaths(). For example, both the paths '/foo' and '/foo/bar' may appear in this set.
| USD_API PrimResyncType GetPrimResyncType | ( | const SdfPath & | primPath, |
| SdfPath * | associatedPrimPath = nullptr |
||
| ) | const |
Returns the type of resync that has occurred for the prim at primPath.
When prims are edited through the UsdNamespaceEditor we'll have additional information about whether the prim resyncs that have occurred are for prims that have been renamed, reparented, or just adjusted to maintain composition without changing the prim path itself. These are all resyncs that are expected to have no net effect on the prim's composed contents relative to the original prim. This function returns the the prim's resync type based on that information.
If the prim path is the source of a rename and/or reparent operation the returned type will be a "Source" type and the associatedPrimPath, if provided, will be set to the path of the corresponding destination prim. Likewise, if the prim path is the destination of a rename and/or reparent operation the returned type will be a "Destination" type and the associatedPrimPath, if provided, will be set to the path of the corresponding source prim. See PrimSyncType for more information about the other return types.
|
inline |
Return the list of property paths that have been renamed via a UsdNamespaceEditor ApplyEdits operation along with the new names of those properties.
When multiple properties have been edited, this list will contain them in no particular order.
| USD_API PathRange GetResolvedAssetPathsResyncedPaths | ( | ) | const |
Return the set of paths affected by changes that may cause asset path values to resolve to different locations, even though the asset path authored in scene description has not changed.
For example, asset paths using expression variables may be invalidated when a variable value is modified, even though the authored asset paths have not changed. The set of paths are returned in lexicographical order.
Resolved asset path resyncs imply invalidation of asset paths within entire subtrees including all descendant prims and properties, so this set is minimal regarding ancestors and descendants. For example, if the path '/foo' appears in this set, all asset paths in the entire subtree at '/foo' are invalidated, so the path '/foo/bar' will not appear, but asset paths on that prim should be considered invalidated.
| USD_API PathRange GetResyncedPaths | ( | ) | const |
Return the set of paths that are resynced in lexicographical order.
Resyncs imply entire subtree invalidation of all descendant prims and properties, so this set is minimal regarding ancestors and descendants. For example, if the path '/foo' appears in this set, the entire subtree at '/foo' is resynced so the path '/foo/bar' will not appear, but it should be considered resynced.
Since object resyncs fully invalidate entire subtrees, this set of paths subsumes all other paths. For example, if the path '/foo' appears in this set, but an attribute value was changed at '/foo/bar.x', this notice will only contain '/foo' in the set returned by this path and empty sets from all other functions. This is because the change to '/foo/bar.x' is implied by the resync of '/foo'.
| USD_API bool HasChangedFields | ( | const SdfPath & | path | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| USD_API bool HasChangedFields | ( | const UsdObject & | obj | ) | const |
Return true if there are any changed fields that affected obj, false otherwise.
See GetChangedFields for more details.
| USD_API bool ResolvedAssetPathsResynced | ( | const UsdObject & | obj | ) | const |
Return true if asset path values in obj were resynced by the layer changes that generated this notice.
This is the case if the object's path or an ancestor path is present in GetResolvedAssetPathsResyncedPaths().
| USD_API bool ResyncedObject | ( | const UsdObject & | obj | ) | const |
Return true if obj was resynced by the layer changes that generated this notice.
This is the case if the object's path or an ancestor path is present in GetResyncedPaths().
1.9.6 