24#ifndef PXR_USD_USD_STAGE_H
25#define PXR_USD_USD_STAGE_H
30#include "pxr/usd/usd/api.h"
32#include "pxr/usd/usd/editTarget.h"
34#include "pxr/usd/usd/schemaRegistry.h"
36#include "pxr/usd/usd/stagePopulationMask.h"
37#include "pxr/usd/usd/primDefinition.h"
41#include "pxr/base/tf/hashmap.h"
44#include "pxr/usd/ar/ar.h"
45#include "pxr/usd/ar/notice.h"
47#include "pxr/usd/sdf/notice.h"
48#include "pxr/usd/sdf/path.h"
50#include "pxr/usd/pcp/cache.h"
51#include "pxr/base/vt/value.h"
54#include <tbb/concurrent_vector.h>
55#include <tbb/concurrent_unordered_set.h>
56#include <tbb/concurrent_hash_map.h>
57#include <tbb/spin_rw_mutex.h>
63#include <unordered_map>
66PXR_NAMESPACE_OPEN_SCOPE
71class Usd_AssetPathContext;
73class Usd_InstanceCache;
74class Usd_InstanceChanges;
75class Usd_InterpolatorBase;
193 static UsdStageRefPtr
198 static UsdStageRefPtr
200 const SdfLayerHandle& sessionLayer,
204 static UsdStageRefPtr
206 const SdfLayerHandle& sessionLayer,
211 static UsdStageRefPtr
234 static UsdStageRefPtr
238 static UsdStageRefPtr
243 static UsdStageRefPtr
249 static UsdStageRefPtr
251 const SdfLayerHandle &sessionLayer,
255 static UsdStageRefPtr
257 const SdfLayerHandle &sessionLayer,
277 static UsdStageRefPtr
281 static UsdStageRefPtr
282 Open(
const std::string& filePath,
304 static UsdStageRefPtr
310 static UsdStageRefPtr
345 static UsdStageRefPtr
346 Open(
const SdfLayerHandle& rootLayer,
350 static UsdStageRefPtr
351 Open(
const SdfLayerHandle& rootLayer,
352 const SdfLayerHandle& sessionLayer,
356 static UsdStageRefPtr
357 Open(
const SdfLayerHandle& rootLayer,
362 static UsdStageRefPtr
363 Open(
const SdfLayerHandle& rootLayer,
364 const SdfLayerHandle& sessionLayer,
389 static UsdStageRefPtr
395 static UsdStageRefPtr
397 const SdfLayerHandle& sessionLayer,
402 static UsdStageRefPtr
409 static UsdStageRefPtr
411 const SdfLayerHandle& sessionLayer,
671 return _populationMask;
693 Usd_PrimFlagsPredicate
const &traversalPredicate,
694 std::function<
bool (
UsdRelationship const &)>
const &relPred =
nullptr,
695 std::function<
bool (
UsdAttribute const &)>
const &attrPred =
nullptr);
702 std::function<
bool (
UsdRelationship const &)>
const &relPred =
nullptr,
703 std::function<
bool (
UsdAttribute const &)>
const &attrPred =
nullptr);
847 Usd_PrimDataConstPtr _GetPrimDataAtPath(
const SdfPath &path)
const;
848 Usd_PrimDataPtr _GetPrimDataAtPath(
const SdfPath &path);
854 _GetPrimDataAtPathOrInPrototype(
const SdfPath &path)
const;
858 _GetInstancesForPrototype(
const UsdPrim& prototype)
const;
1118 const std::vector<std::string> &unmuteLayers);
1153 bool addSourceFileComment=
true,
1166 bool addSourceFileComment=
true)
const;
1254 template<
typename T>
1286 template<
typename T>
1331 template<
typename T>
1333 const T& value)
const;
1564 TfToken *colorManagementSystem);
1582 const TfToken &colorManagementSystem);
1623 struct _IncludePayloadsPredicate;
1636 template <
class... Args>
1637 static UsdStageRefPtr _OpenImpl(
InitialLoadSet load, Args
const &... args);
1647 static UsdStageRefPtr
1658 SdfPropertySpecHandleVector
1661 std::vector<std::pair<SdfPropertySpecHandle, SdfLayerOffset>>
1662 _GetPropertyStackWithLayerOffsets(
1665 static SdfPrimSpecHandleVector
1666 _GetPrimStack(
const UsdPrim &prim);
1668 static std::vector<std::pair<SdfPrimSpecHandle, SdfLayerOffset>>
1669 _GetPrimStackWithLayerOffsets(
const UsdPrim &prim);
1672 _GetSchemaProperty(
const UsdProperty &prop)
const;
1680 SdfAttributeSpecHandle
1681 _CreateNewSpecFromSchemaAttribute(
1685 SdfRelationshipSpecHandle
1686 _CreateNewSpecFromSchemaRelationship(
1690 template <
class PropType>
1692 _CreateNewPropertySpecFromSchema(
const UsdProperty &prop);
1695 _CreatePrimSpecForEditing(
const UsdPrim& prim);
1697 template <
class PropType>
1699 _CreatePropertySpecForEditing(
const UsdProperty &prop);
1701 SdfPropertySpecHandle
1702 _CreatePropertySpecForEditing(
const UsdProperty &prop);
1704 SdfAttributeSpecHandle
1705 _CreateAttributeSpecForEditing(
const UsdAttribute &attr);
1707 SdfRelationshipSpecHandle
1713 std::pair<bool, UsdPrim>
1714 _IsValidPathForCreatingPrim(
const SdfPath &path)
const;
1719 bool _ValidateEditPrim(
const UsdPrim &prim,
const char* operation)
const;
1720 bool _ValidateEditPrimAtPath(
const SdfPath &primPath,
1721 const char* operation)
const;
1725 bool _RemoveProperty(
const SdfPath& path);
1739 struct _IsEditTargetMappable {
1740 static const bool value =
1741 std::is_same<T, SdfTimeCode>::value ||
1742 std::is_same<T, VtArray<SdfTimeCode>>::value ||
1743 std::is_same<T, SdfPathExpression>::value ||
1744 std::is_same<T, VtArray<SdfPathExpression>>::value ||
1745 std::is_same<T, SdfTimeSampleMap>::value ||
1746 std::is_same<T, VtDictionary>::value;
1751 typename std::enable_if<!_IsEditTargetMappable<T>::value,
bool>::type
1757 typename std::enable_if<_IsEditTargetMappable<T>::value,
bool>::type
1767 bool _SetEditTargetMappedValue(
1778 typename std::enable_if<!_IsEditTargetMappable<T>::value,
bool>::type
1780 const TfToken &keyPath,
const T& value);
1784 typename std::enable_if<_IsEditTargetMappable<T>::value,
bool>::type
1786 const TfToken &keyPath,
const T& value);
1791 bool _SetMetadata(
const UsdObject &
object,
1797 bool _SetEditTargetMappedMetadata(
1799 const TfToken &keyPath,
const T &newValue);
1802 bool _SetMetadataImpl(
1804 const TfToken &keyPath,
const T &value);
1814 PcpCache const *_GetPcpCache()
const {
return _cache.get(); }
1815 PcpCache *_GetPcpCache() {
return _cache.get(); }
1823 void _ReportPcpErrors(
const PcpErrorVector &errors,
1824 const std::string &context)
const;
1825 void _ReportErrors(
const PcpErrorVector &errors,
1826 const std::vector<std::string>& otherErrors,
1827 const std::string &context)
const;
1837 void _ComposePrimIndexesInParallel(
1838 const std::vector<SdfPath>& primIndexPaths,
1839 const std::string& context,
1840 Usd_InstanceChanges* instanceChanges =
nullptr);
1844 void _ComposeSubtree(
1845 Usd_PrimDataPtr prim, Usd_PrimDataConstPtr parent,
1848 void _ComposeSubtreeImpl(
1849 Usd_PrimDataPtr prim, Usd_PrimDataConstPtr parent,
1852 void _ComposeSubtreesInParallel(
1853 const std::vector<Usd_PrimDataPtr> &prims,
1854 const std::vector<SdfPath> *primIndexPaths =
nullptr);
1858 void _ComposePrimTypeInfoImpl(Usd_PrimDataPtr prim);
1863 void _ComposeChildSubtree(Usd_PrimDataPtr prim,
1864 Usd_PrimDataConstPtr parent,
1877 void _ComposeChildren(Usd_PrimDataPtr prim,
1882 Usd_PrimDataPtr _InstantiatePrim(
const SdfPath &primPath);
1886 Usd_PrimDataPtr _InstantiatePrototypePrim(
const SdfPath &primPath);
1890 void _DestroyPrim(Usd_PrimDataPtr prim);
1894 void _DestroyPrimsInParallel(
const std::vector<SdfPath>& paths);
1897 void _DestroyDescendents(Usd_PrimDataPtr prim);
1902 bool _IsObjectDescendantOfInstance(
const SdfPath& path)
const;
1906 Usd_PrimDataConstPtr _GetPrototypeForInstance(Usd_PrimDataConstPtr p)
const;
1909 SdfPath _GetPrimPathUsingPrimIndexAtPath(
const SdfPath& primIndexPath)
const;
1919 void _ProcessPendingChanges();
1923 bool _RemovePrim(
const SdfPath& fullPath);
1925 SdfPrimSpecHandle _GetPrimSpec(
const SdfPath& fullPath);
1932 SdfSpecType _GetDefiningSpecType(Usd_PrimDataConstPtr primData,
1933 const TfToken &propName)
const;
1939 void _Recompose(
const PcpChanges &changes, T *pathsToRecompose);
1941 void _RecomposePrims(T *pathsToRecompose);
1948 template <
class Iter>
1949 void _ComputeSubtreesToRecompose(Iter start, Iter finish,
1950 std::vector<Usd_PrimDataPtr>* recompose);
1954 bool _IsValidForLoad(
const SdfPath& path)
const;
1955 bool _IsValidForUnload(
const SdfPath& path)
const;
1965 void _DiscoverPayloads(
const SdfPath& rootPath,
1967 SdfPathSet* primIndexPaths,
1968 bool unloadedOnly =
false,
1969 SdfPathSet* usdPrimPaths =
nullptr)
const;
1980 static SdfSpecifier _GetSpecifier(Usd_PrimDataConstPtr primData);
1981 static TfToken _GetKind(Usd_PrimDataConstPtr primData);
1982 static bool _IsActive(Usd_PrimDataConstPtr primData);
1993 size_t numAssetPaths,
1994 bool anchorAssetPathsOnly =
false)
const;
1998 bool anchorAssetPathsOnly =
false)
const;
2002 size_t numTimeCodes)
const;
2004 void _MakeResolvedPathExpressions(
2007 size_t numPathExprs)
const;
2022 struct _HasTypeSpecificResolution {
2023 static const bool value =
2024 std::is_same<T, SdfAssetPath>::value ||
2025 std::is_same<T, VtArray<SdfAssetPath>>::value ||
2026 std::is_same<T, SdfTimeCode>::value ||
2027 std::is_same<T, VtArray<SdfTimeCode>>::value ||
2028 std::is_same<T, SdfPathExpression>::value ||
2029 std::is_same<T, VtArray<SdfPathExpression>>::value ||
2030 std::is_same<T, SdfTimeSampleMap>::value ||
2031 std::is_same<T, VtDictionary>::value;
2037 typename std::enable_if<!_HasTypeSpecificResolution<T>::value,
bool>::type
2046 typename std::enable_if<_HasTypeSpecificResolution<T>::value,
bool>::type
2065 bool _GetStrongestResolvedMetadata(
const UsdObject &obj,
2076 bool _GetTypeSpecificResolvedMetadata(
const UsdObject &obj,
2082 template <
class Composer>
2086 Composer *composer)
const;
2088 template <
class Composer>
2091 Composer *composer)
const;
2093 template <
class Composer>
2096 Composer *composer)
const;
2098 template <
class Composer>
2099 bool _GetSpecialPropMetadataImpl(
const UsdObject &obj,
2103 Composer *composer)
const;
2104 template <
class Composer>
2105 bool _GetMetadataImpl(
const UsdObject &obj,
2108 bool includeFallbacks,
2109 Composer *composer)
const;
2111 template <
class Composer>
2112 bool _GetGeneralMetadataImpl(
const UsdObject &obj,
2115 bool includeFallbacks,
2116 Composer *composer)
const;
2122 const TfToken &keyPath,
bool useFallbacks)
const;
2125 _ListMetadataFields(
const UsdObject &obj,
bool useFallbacks)
const;
2127 void _GetAllMetadata(
const UsdObject &obj,
2129 UsdMetadataValueMap* result,
2130 bool anchorAssetPathsOnly =
false)
const;
2140 void _GetResolveInfoWithResolveTarget(
2146 template <
class T>
struct _ExtraResolveInfo;
2157 _ExtraResolveInfo<T> *extraInfo =
nullptr)
const;
2166 void _GetResolveInfoWithResolveTarget(
2171 _ExtraResolveInfo<T> *extraInfo =
nullptr)
const;
2178 template <
class T,
class MakeUsdResolverFn>
2182 _ExtraResolveInfo<T> *extraInfo,
2183 const MakeUsdResolverFn &makeUsdResolveFn)
const;
2185 template <
class T>
struct _ResolveInfoResolver;
2186 struct _PropertyStackResolver;
2188 template <
class Resolver,
class MakeUsdResolverFn>
2189 void _GetResolvedValueAtDefaultImpl(
2192 const MakeUsdResolverFn &makeUsdResolverFn)
const;
2194 template <
class Resolver,
class MakeUsdResolverFn>
2195 void _GetResolvedValueAtTimeImpl(
2199 const MakeUsdResolverFn &makeUsdResolverFn)
const;
2210 Usd_InterpolatorBase* interpolator,
2227 Usd_InterpolatorBase* interpolator,
2231 bool _GetDefaultValueFromResolveInfoImpl(
const UsdResolveInfo &info,
2235 Usd_AssetPathContext
2248 bool _GetTimeSamplesInInterval(
const UsdAttribute &attr,
2250 std::vector<double>* times)
const;
2252 bool _GetTimeSamplesInIntervalFromResolveInfo(
2256 std::vector<double>* times)
const;
2258 size_t _GetNumTimeSamples(
const UsdAttribute &attr)
const;
2260 size_t _GetNumTimeSamplesFromResolveInfo(
const UsdResolveInfo &info,
2266 bool _GetBracketingTimeSamples(
const UsdAttribute &attr,
2271 bool* hasSamples)
const;
2273 bool _GetBracketingTimeSamplesFromResolveInfo(
const UsdResolveInfo &info,
2279 bool* hasSamples)
const;
2281 bool _ValueMightBeTimeVarying(
const UsdAttribute &attr)
const;
2283 bool _ValueMightBeTimeVaryingFromResolveInfo(
const UsdResolveInfo &info,
2286 void _RegisterPerLayerNotices();
2287 void _RegisterResolverChangeNotice();
2290 inline char const *_GetMallocTagId()
const;
2295 Usd_PrimDataPtr _pseudoRoot;
2306 bool _editTargetIsLocalLayer;
2308 std::unique_ptr<PcpCache> _cache;
2309 std::unique_ptr<Usd_ClipCache> _clipCache;
2310 std::unique_ptr<Usd_InstanceCache> _instanceCache;
2312 TfHashMap<TfToken, TfToken, TfHash> _invalidPrimTypeToFallbackMap;
2314 size_t _usedLayersRevision;
2321 inline size_t hash(
SdfPath const &path)
const {
2322 return path.GetHash();
2325 using PathToNodeMap = tbb::concurrent_hash_map<
2327 PathToNodeMap _primMap;
2332 typedef std::vector<
2333 std::pair<SdfLayerHandle, TfNotice::Key> > _LayerAndNoticeKeyVec;
2334 _LayerAndNoticeKeyVec _layersAndNoticeKeys;
2335 size_t _lastChangeSerialNumber;
2340 class _PendingChanges;
2341 _PendingChanges* _pendingChanges;
2343 std::optional<WorkDispatcher> _dispatcher;
2347 std::unique_ptr<std::string> _mallocTagID;
2358 bool _isClosingStage;
2359 bool _isWritingFallbackPrimTypes;
2373 friend class Usd_AssetPathContext;
2374 friend class Usd_FlattenAccess;
2375 friend class Usd_PcpCacheAccess;
2376 friend class Usd_PrimData;
2377 friend class Usd_StageOpenRequest;
2378 template <
class T>
friend struct Usd_AttrGetValueHelper;
2379 friend struct Usd_AttrGetUntypedValueHelper;
2380 template <
class RefsOrPayloadsEditorType,
class RefsOrPayloadsProxyType>
2381 friend struct Usd_ListEditImpl;
2390UsdStage::_GetTypeSpecificResolvedMetadata(
const UsdObject &obj,
2410 " match retrieved type %s",
2411 ArchGetDemangled<T>().c_str(),
2440 TF_CODING_ERROR(
"Requested type %s for stage metadatum %s[%s] does not"
2441 " match retrieved type %s",
2442 ArchGetDemangled<T>().c_str(),
2453 const T& value)
const
2461typename std::enable_if<
2462 !UsdStage::_HasTypeSpecificResolution<T>::value,
bool>::type
2463UsdStage::_GetMetadata(
const UsdObject &obj,
2472 return _GetStrongestResolvedMetadata(
2473 obj, fieldName, keyPath, useFallbacks, &out);
2478typename std::enable_if<
2479 UsdStage::_HasTypeSpecificResolution<T>::value,
bool>::type
2480UsdStage::_GetMetadata(
const UsdObject &obj,
2488 return _GetTypeSpecificResolvedMetadata(
2489 obj, fieldName, keyPath, useFallbacks, result);
2495typename std::enable_if<!UsdStage::_IsEditTargetMappable<T>::value,
bool>::type
2497 const TfToken &keyPath,
const T& value)
2502 return _SetMetadataImpl<SdfAbstractDataConstValue>(
2503 object, key, keyPath, in);
2508typename std::enable_if<UsdStage::_IsEditTargetMappable<T>::value,
bool>::type
2510 const TfToken &keyPath,
const T& value)
2512 return _SetEditTargetMappedMetadata(
object, key, keyPath, value);
2515PXR_NAMESPACE_CLOSE_SCOPE
Notice sent when asset paths may resolve to a different path than before due to a change in the resol...
An asset resolver context allows clients to provide additional data to the resolver for use during re...
A basic mathematical interval class.
PcpCache is the context required to make requests of the Pcp composition algorithm and cache the resu...
PcpPrimIndex is an index of the all sites of scene description that contribute opinions to a specific...
The fully-typed container for a field value in an SdfAbstractData.
The fully-typed container for a field value in an SdfAbstractData.
A type-erased container for a field value in an SdfAbstractData.
Contains an asset path and an optional resolved path.
SdfHandle is a smart ptr that calls IsDormant() on the pointed-to object as an extra expiration check...
A scene description container that can combine with other such containers to form simple component as...
std::map< std::string, std::string > FileFormatArguments
Type for specifying additional file format-specific arguments to layer API.
Notice sent per-layer indicating all layers whose contents have changed within a single round of chan...
Objects of this class represent a logical expression syntax tree consisting of SdfPath matching patte...
A path value used to locate objects in layers or scenegraphs.
static SDF_API const SdfPath & AbsoluteRootPath()
The absolute path representing the top of the namespace hierarchy.
Value type that represents a time code.
Stores a pointer to a ValueType which uses TfDelegatedCountIncrement and TfDelegatedCountDecrement to...
Handle-object returned by TfNotice::Register().
Enable a concrete base class for use with TfRefPtr.
Token for efficient comparison, assignment, and hashing of known strings.
char const * GetText() const
Return the text that this token represents.
Enable a concrete base class for use with TfWeakPtr.
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Object for efficiently making repeated queries for attribute values.
Defines a mapping from scene graph paths to Sdf spec paths in a SdfLayer where edits should be direct...
A proxy class for applying listOp edits to the inherit paths list for a prim.
Base class for Usd scenegraph objects, providing common API.
Accessor to a attribute's definition in the prim definition.
Accessor to a property's definition in the prim definition.
Accessor to a relationship's definition in the prim definition.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
An forward-iterable range that traverses a subtree of prims rooted at a given prim in depth-first ord...
Base class for UsdAttribute and UsdRelationship scenegraph objects.
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Container for information about the source of an attribute's value, i.e.
Defines a subrange of nodes and layers within a prim's prim index to consider when performing value r...
A proxy class for applying listOp edits to the specializes list for a prim.
The outermost container for scene description, which owns and presents composed prims as a scenegraph...
USD_API void SetEndTimeCode(double)
Sets the stage's end timeCode.
USD_API bool SetMetadataByDictKey(const TfToken &key, const TfToken &keyPath, const VtValue &value) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API void LoadAndUnload(const SdfPathSet &loadSet, const SdfPathSet &unloadSet, UsdLoadPolicy policy=UsdLoadWithDescendants)
Unload and load the given path sets.
USD_API void WriteFallbackPrimTypes()
Writes the fallback prim types defined in the schema registry to the stage as dictionary valued fallb...
static USD_API void SetColorConfigFallbacks(const SdfAssetPath &colorConfiguration, const TfToken &colorManagementSystem)
Sets the global fallback values of color configuration metadata which includes the 'colorConfiguratio...
static USD_API UsdStageRefPtr Open(const SdfLayerHandle &rootLayer, const SdfLayerHandle &sessionLayer, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool ExportToString(std::string *result, bool addSourceFileComment=true) const
Writes the composite scene as a flattened Usd text representation into the given string.
bool SetMetadata(const TfToken &key, const T &value) const
Set the value of Stage metadatum key to value, if the stage's current UsdEditTarget is the root or se...
static USD_API UsdStageRefPtr OpenMasked(const SdfLayerHandle &rootLayer, const UsdStagePopulationMask &mask, InitialLoadSet load=LoadAll)
Open a stage rooted at rootLayer and with limited population subject to mask.
static USD_API UsdStageRefPtr CreateNew(const std::string &identifier, const SdfLayerHandle &sessionLayer, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API std::vector< UsdPrim > GetPrototypes() const
Returns all native instancing prototype prims.
USD_API bool HasAuthoredMetadataDictKey(const TfToken &key, const TfToken &keyPath) const
Return true if there exists any authored opinion (excluding fallbacks) for key and keyPath.
USD_API UsdPrim OverridePrim(const SdfPath &path)
Attempt to ensure a UsdPrim at path exists on this stage.
USD_API void SetPopulationMask(UsdStagePopulationMask const &mask)
Set this stage's population mask and recompose the stage.
USD_API void UnmuteLayer(const std::string &layerIdentifier)
Unmute the layer identified by layerIdentifier if it had previously been muted.
USD_API SdfPathSet GetLoadSet()
Returns a set of all loaded paths.
static USD_API PcpVariantFallbackMap GetGlobalVariantFallbacks()
Get the global variant fallback preferences used in new UsdStages.
USD_API void ExpandPopulationMask(std::function< bool(UsdRelationship const &)> const &relPred=nullptr, std::function< bool(UsdAttribute const &)> const &attrPred=nullptr)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool HasAuthoredMetadata(const TfToken &key) const
Returns true if the key has an authored value, false if no value was authored or the only value avail...
USD_API UsdEditTarget GetEditTargetForLocalLayer(size_t i)
Return a UsdEditTarget for editing the layer at index i in the layer stack.
USD_API SdfLayerHandleVector GetUsedLayers(bool includeClipLayers=true) const
Return a vector of all of the layers currently consumed by this stage, as determined by the compositi...
USD_API bool GetMetadataByDictKey(const TfToken &key, const TfToken &keyPath, VtValue *value) const
overload
USD_API double GetEndTimeCode() const
Returns the stage's end timeCode.
static USD_API UsdStageRefPtr CreateInMemory(const std::string &identifier, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdStagePopulationMask GetPopulationMask() const
Return this stage's population mask.
USD_API bool Export(const std::string &filename, bool addSourceFileComment=true, const SdfLayer::FileFormatArguments &args=SdfLayer::FileFormatArguments()) const
Writes out the composite scene as a single flattened layer into filename.
static USD_API UsdStageRefPtr CreateNew(const std::string &identifier, InitialLoadSet load=LoadAll)
Create a new stage with root layer identifier, destroying potentially existing files with that identi...
USD_API UsdPrim GetPseudoRoot() const
Return the stage's "pseudo-root" prim, whose name is defined by Usd.
USD_API double GetFramesPerSecond() const
Returns the stage's framesPerSecond value.
USD_API std::string ResolveIdentifierToEditTarget(std::string const &identifier) const
Resolve the given identifier using this stage's ArResolverContext and the layer of its GetEditTarget(...
USD_API void ExpandPopulationMask(Usd_PrimFlagsPredicate const &traversalPredicate, std::function< bool(UsdRelationship const &)> const &relPred=nullptr, std::function< bool(UsdAttribute const &)> const &attrPred=nullptr)
Expand this stage's population mask to include the targets of all relationships that pass relPred and...
USD_API UsdProperty GetPropertyAtPath(const SdfPath &path) const
Return the UsdProperty at path, or an invalid UsdProperty if none exists.
static USD_API UsdStageRefPtr CreateInMemory(const std::string &identifier, const SdfLayerHandle &sessionLayer, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API UsdPrim DefinePrim(const SdfPath &path, const TfToken &typeName=TfToken())
Attempt to ensure a UsdPrim at path is defined (according to UsdPrim::IsDefined()) on this stage.
USD_API void SetTimeCodesPerSecond(double timeCodesPerSecond) const
Sets the stage's timeCodesPerSecond value.
USD_API UsdAttribute GetAttributeAtPath(const SdfPath &path) const
Return the UsdAttribute at path, or an invalid UsdAttribute if none exists.
USD_API UsdPrim GetDefaultPrim() const
Return the UsdPrim on this stage whose path is the root layer's defaultPrim metadata's value.
USD_API bool HasDefaultPrim() const
Return true if this stage's root layer has an authored opinion for the default prim layer metadata.
USD_API UsdPrimRange Traverse(const Usd_PrimFlagsPredicate &predicate)
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API void GetColorConfigFallbacks(SdfAssetPath *colorConfiguration, TfToken *colorManagementSystem)
Returns the global fallback values of 'colorConfiguration' and 'colorManagementSystem'.
USD_API UsdPrim GetPrimAtPath(const SdfPath &path) const
Return the UsdPrim at path, or an invalid UsdPrim if none exists.
USD_API UsdInterpolationType GetInterpolationType() const
Returns the interpolation type used during value resolution for all attributes on this stage.
USD_API UsdPrimRange TraverseAll()
Traverse all the prims on this stage depth-first.
USD_API bool IsLayerMuted(const std::string &layerIdentifier) const
Returns true if the layer specified by layerIdentifier is muted in this cache, false otherwise.
USD_API void SetColorManagementSystem(const TfToken &cms) const
Sets the name of the color management system used to interpret the color configuration file pointed a...
USD_API void ClearDefaultPrim()
Clear the default prim layer metadata in this stage's root layer.
InitialLoadSet
Specifies the initial set of prims to load when opening a UsdStage.
@ LoadAll
Load all loadable prims.
@ LoadNone
Load no loadable prims.
bool SetMetadataByDictKey(const TfToken &key, const TfToken &keyPath, const T &value) const
Author value to the field identified by key and keyPath at the current EditTarget.
static USD_API UsdStageRefPtr CreateNew(const std::string &identifier, const SdfLayerHandle &sessionLayer, const ArResolverContext &pathResolverContext, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API UsdStageRefPtr CreateInMemory(InitialLoadSet load=LoadAll)
Creates a new stage only in memory, analogous to creating an anonymous SdfLayer.
USD_API void SetDefaultPrim(const UsdPrim &prim)
Set the default prim layer metadata in this stage's root layer.
USD_API double GetTimeCodesPerSecond() const
Returns the stage's timeCodesPerSecond value.
static USD_API UsdStageRefPtr OpenMasked(const SdfLayerHandle &rootLayer, const SdfLayerHandle &sessionLayer, const ArResolverContext &pathResolverContext, const UsdStagePopulationMask &mask, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API double GetStartTimeCode() const
Returns the stage's start timeCode.
USD_API void MuteLayer(const std::string &layerIdentifier)
Mute the layer identified by layerIdentifier.
USD_API const std::vector< std::string > & GetMutedLayers() const
Returns a vector of all layers that have been muted on this stage.
USD_API bool HasMetadataDictKey(const TfToken &key, const TfToken &keyPath) const
Return true if there exists any authored or fallback opinion for key and keyPath.
USD_API UsdPrim CreateClassPrim(const SdfPath &rootPrimPath)
Author an SdfPrimSpec with specifier == SdfSpecifierClass for the class at root prim path path at the...
USD_API void SaveSessionLayers()
Calls SdfLayer::Save on all dirty session layers and sublayers of session layers contributing to this...
static USD_API UsdStageRefPtr CreateInMemory(const std::string &identifier, const SdfLayerHandle &sessionLayer, const ArResolverContext &pathResolverContext, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API UsdStageRefPtr OpenMasked(const SdfLayerHandle &rootLayer, const ArResolverContext &pathResolverContext, const UsdStagePopulationMask &mask, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API UsdObject GetObjectAtPath(const SdfPath &path) const
Return the UsdObject at path, or an invalid UsdObject if none exists.
USD_API SdfLayerHandleVector GetLayerStack(bool includeSessionLayers=true) const
Return this stage's local layers in strong-to-weak order.
static USD_API UsdStageRefPtr CreateNew(const std::string &identifier, const ArResolverContext &pathResolverContext, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API bool IsSupportedFile(const std::string &filePath)
Indicates whether the specified file is supported by UsdStage.
static USD_API UsdStageRefPtr CreateInMemory(const std::string &identifier, const ArResolverContext &pathResolverContext, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API void MuteAndUnmuteLayers(const std::vector< std::string > &muteLayers, const std::vector< std::string > &unmuteLayers)
Mute and unmute the layers identified in muteLayers and unmuteLayers.
USD_API void SetColorConfiguration(const SdfAssetPath &colorConfig) const
Sets the default color configuration to be used to interpret the per-attribute color-spaces in the co...
USD_API bool HasLocalLayer(const SdfLayerHandle &layer) const
Return true if layer is one of the layers in this stage's local, root layerStack.
USD_API void SetFramesPerSecond(double framesPerSecond) const
Sets the stage's framesPerSecond value.
static USD_API UsdStageRefPtr Open(const SdfLayerHandle &rootLayer, const ArResolverContext &pathResolverContext, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
bool GetMetadataByDictKey(const TfToken &key, const TfToken &keyPath, T *value) const
Resolve the requested dictionary sub-element keyPath of dictionary-valued metadatum named key,...
USD_API SdfAssetPath GetColorConfiguration() const
Returns the default color configuration used to interpret the per- attribute color-spaces in the comp...
USD_API bool SetMetadata(const TfToken &key, const VtValue &value) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API UsdStageRefPtr Open(const std::string &filePath, InitialLoadSet load=LoadAll)
Attempt to find a matching existing stage in a cache if UsdStageCacheContext objects exist on the sta...
USD_API void Reload()
Calls SdfLayer::Reload on all layers contributing to this stage, except session layers and sublayers ...
USD_API bool RemovePrim(const SdfPath &path)
Remove all scene description for the given path and its subtree in the current UsdEditTarget.
USD_API bool HasAuthoredTimeCodeRange() const
Returns true if the stage has both start and end timeCodes authored in the session layer or the root ...
USD_API void SetEditTarget(const UsdEditTarget &editTarget)
Set the stage's EditTarget.
USD_API UsdEditTarget GetEditTargetForLocalLayer(const SdfLayerHandle &layer)
Return a UsdEditTarget for editing the given local layer.
USD_API void SetLoadRules(UsdStageLoadRules const &rules)
Set the UsdStageLoadRules to govern payload inclusion on this stage.
USD_API void SetInterpolationType(UsdInterpolationType interpolationType)
Sets the interpolation type used during value resolution for all attributes on this stage.
bool GetMetadata(const TfToken &key, T *value) const
Return in value an authored or fallback value (if one was defined for the given metadatum) for Stage ...
static USD_API UsdStageRefPtr Open(const SdfLayerHandle &rootLayer, InitialLoadSet load=LoadAll)
Open a stage rooted at rootLayer.
static USD_API UsdStageRefPtr OpenMasked(const std::string &filePath, const ArResolverContext &pathResolverContext, UsdStagePopulationMask const &mask, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API UsdStageRefPtr Open(const std::string &filePath, const ArResolverContext &pathResolverContext, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API ArResolverContext GetPathResolverContext() const
Return the path resolver context for all path resolution during composition of this stage.
USD_API TfToken GetColorManagementSystem() const
Sets the name of the color management system to be used for loading and interpreting the color config...
USD_API UsdPrimRange Traverse()
Traverse the active, loaded, defined, non-abstract prims on this stage depth-first.
UsdStageLoadRules const & GetLoadRules() const
Return the stage's current UsdStageLoadRules governing payload inclusion.
static USD_API void SetGlobalVariantFallbacks(const PcpVariantFallbackMap &fallbacks)
Set the global variant fallback preferences used in new UsdStages.
static USD_API UsdStageRefPtr OpenMasked(const std::string &filePath, UsdStagePopulationMask const &mask, InitialLoadSet load=LoadAll)
Create a new stage and recursively compose prims defined within and referenced by the layer at filePa...
USD_API void Save()
Calls SdfLayer::Save on all dirty layers contributing to this stage except session layers and sublaye...
USD_API SdfPathSet FindLoadable(const SdfPath &rootPath=SdfPath::AbsoluteRootPath())
Returns an SdfPathSet of all paths that can be loaded.
USD_API bool HasMetadata(const TfToken &key) const
Returns true if the key has a meaningful value, that is, if GetMetadata() will provide a value,...
USD_API SdfLayerRefPtr Flatten(bool addSourceFileComment=true) const
Returns a single, anonymous, merged layer for this composite scene.
USD_API SdfLayerHandle GetRootLayer() const
Return this stage's root layer.
static USD_API UsdStageRefPtr OpenMasked(const SdfLayerHandle &rootLayer, const SdfLayerHandle &sessionLayer, const UsdStagePopulationMask &mask, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API UsdRelationship GetRelationshipAtPath(const SdfPath &path) const
Return the UsdAttribute at path, or an invalid UsdAttribute if none exists.
USD_API UsdPrim Load(const SdfPath &path=SdfPath::AbsoluteRootPath(), UsdLoadPolicy policy=UsdLoadWithDescendants)
Modify this stage's load rules to load the prim at path, its ancestors, and all of its descendants if...
USD_API void Unload(const SdfPath &path=SdfPath::AbsoluteRootPath())
Modify this stage's load rules to unload the prim and its descendants specified by path.
USD_API void SetStartTimeCode(double)
Sets the stage's start timeCode.
USD_API bool GetMetadata(const TfToken &key, VtValue *value) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
static USD_API UsdStageRefPtr Open(const SdfLayerHandle &rootLayer, const SdfLayerHandle &sessionLayer, const ArResolverContext &pathResolverContext, InitialLoadSet load=LoadAll)
This is an overloaded member function, provided for convenience. It differs from the above function o...
USD_API bool ClearMetadata(const TfToken &key) const
Clear the value of stage metadatum key, if the stage's current UsdEditTarget is the root or session l...
USD_API SdfLayerHandle GetSessionLayer() const
Return this stage's root session layer.
USD_API const UsdEditTarget & GetEditTarget() const
Return the stage's EditTarget.
USD_API bool ClearMetadataByDictKey(const TfToken &key, const TfToken &keyPath) const
Clear any authored value identified by key and keyPath at the current EditTarget.
This class represents rules that govern payload inclusion on UsdStages.
This class represents a mask that may be applied to a UsdStage to limit the set of UsdPrim s it popul...
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
A UsdVariantSet represents a single VariantSet in USD (e.g.
UsdVariantSets represents the collection of VariantSets that are present on a UsdPrim.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
VT_API std::string GetTypeName() const
Return the type name of the held typeid.
bool IsHolding() const
Return true if this value is holding an object of type T, false otherwise.
T const & UncheckedGet() const &
Returns a const reference to the held object if the held object is of type T.
UsdLoadPolicy
Controls UsdStage::Load() and UsdPrim::Load() behavior regarding whether or not descendant prims are ...
@ UsdLoadWithDescendants
Load a prim plus all its descendants.
Standard pointer typedefs.
#define TF_CODING_ERROR(fmt, args)
Issue an internal programming error, but continue execution.
UsdInterpolationType
Attribute value interpolation options.
std::vector< TfToken > TfTokenVector
Convenience types.
std::map< std::string, std::vector< std::string > > PcpVariantFallbackMap
typedef std::map<std::string, std::vector<std::string>> PcpVariantFallbackMap
SdfSpecType
An enum that specifies the type of an object.
SdfSpecifier
An enum that identifies the possible specifiers for an SdfPrimSpec.
SdfVariability
An enum that identifies variability types for attributes.
std::map< double, VtValue > SdfTimeSampleMap
A map from sample times to sample values.