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"
40 #include "pxr/base/tf/hashmap.h"
43 #include "pxr/usd/ar/ar.h"
44 #include "pxr/usd/ar/notice.h"
46 #include "pxr/usd/sdf/notice.h"
47 #include "pxr/usd/sdf/path.h"
49 #include "pxr/usd/pcp/cache.h"
50 #include "pxr/base/vt/value.h"
53 #include <boost/optional.hpp>
55 #include <tbb/concurrent_vector.h>
56 #include <tbb/concurrent_unordered_set.h>
57 #include <tbb/spin_rw_mutex.h>
62 #include <unordered_map>
65 PXR_NAMESPACE_OPEN_SCOPE
72 class Usd_InstanceCache;
73 class Usd_InstanceChanges;
74 class Usd_InterpolatorBase;
187 static UsdStageRefPtr
192 static UsdStageRefPtr
194 const SdfLayerHandle& sessionLayer,
198 static UsdStageRefPtr
200 const SdfLayerHandle& sessionLayer,
205 static UsdStageRefPtr
228 static UsdStageRefPtr
232 static UsdStageRefPtr
237 static UsdStageRefPtr
243 static UsdStageRefPtr
245 const SdfLayerHandle &sessionLayer,
249 static UsdStageRefPtr
251 const SdfLayerHandle &sessionLayer,
271 static UsdStageRefPtr
275 static UsdStageRefPtr
276 Open(
const std::string& filePath,
298 static UsdStageRefPtr
304 static UsdStageRefPtr
339 static UsdStageRefPtr
340 Open(
const SdfLayerHandle& rootLayer,
344 static UsdStageRefPtr
345 Open(
const SdfLayerHandle& rootLayer,
346 const SdfLayerHandle& sessionLayer,
350 static UsdStageRefPtr
351 Open(
const SdfLayerHandle& rootLayer,
356 static UsdStageRefPtr
357 Open(
const SdfLayerHandle& rootLayer,
358 const SdfLayerHandle& sessionLayer,
383 static UsdStageRefPtr
389 static UsdStageRefPtr
391 const SdfLayerHandle& sessionLayer,
396 static UsdStageRefPtr
403 static UsdStageRefPtr
405 const SdfLayerHandle& sessionLayer,
603 void LoadAndUnload(
const SdfPathSet &loadSet,
const SdfPathSet &unloadSet,
665 return _populationMask;
685 std::function<
bool (
UsdRelationship const &)>
const &relPred =
nullptr,
686 std::function<
bool (
UsdAttribute const &)>
const &attrPred =
nullptr);
825 Usd_PrimDataConstPtr _GetPrimDataAtPath(
const SdfPath &path)
const;
826 Usd_PrimDataPtr _GetPrimDataAtPath(
const SdfPath &path);
832 _GetPrimDataAtPathOrInPrototype(
const SdfPath &path)
const;
836 _GetInstancesForPrototype(
const UsdPrim& prototype)
const;
1003 SdfLayerHandleVector
GetLayerStack(
bool includeSessionLayers=
true)
const;
1017 SdfLayerHandleVector
GetUsedLayers(
bool includeClipLayers=
true)
const;
1085 void MuteLayer(
const std::string &layerIdentifier);
1090 void UnmuteLayer(
const std::string &layerIdentifier);
1101 const std::vector<std::string> &unmuteLayers);
1112 bool IsLayerMuted(
const std::string& layerIdentifier)
const;
1135 bool Export(
const std::string &filename,
1136 bool addSourceFileComment=
true,
1149 bool addSourceFileComment=
true)
const;
1237 template<
typename T>
1269 template<
typename T>
1314 template<
typename T>
1316 const T& value)
const;
1547 TfToken *colorManagementSystem);
1565 const TfToken &colorManagementSystem);
1606 struct _IncludePayloadsPredicate;
1619 template <
class... Args>
1620 static UsdStageRefPtr _OpenImpl(
InitialLoadSet load, Args
const &... args);
1630 static UsdStageRefPtr
1641 SdfPropertySpecHandleVector
1644 SdfPropertySpecHandle
1645 _GetSchemaPropertySpec(
const UsdPrim &prim,
const TfToken &propName)
const;
1647 SdfPropertySpecHandle
1648 _GetSchemaPropertySpec(
const UsdProperty &prop)
const;
1650 template <
class PropType>
1652 _GetSchemaPropertySpec(
const UsdProperty &prop)
const;
1654 SdfAttributeSpecHandle
1655 _GetSchemaAttributeSpec(
const UsdAttribute &attr)
const;
1657 SdfRelationshipSpecHandle
1661 _CreatePrimSpecForEditing(
const UsdPrim& prim);
1663 template <
class PropType>
1665 _CreatePropertySpecForEditing(
const UsdProperty &prop);
1667 SdfPropertySpecHandle
1668 _CreatePropertySpecForEditing(
const UsdProperty &prop);
1670 SdfAttributeSpecHandle
1671 _CreateAttributeSpecForEditing(
const UsdAttribute &attr);
1673 SdfRelationshipSpecHandle
1679 std::pair<bool, UsdPrim>
1680 _IsValidPathForCreatingPrim(
const SdfPath &path)
const;
1685 bool _ValidateEditPrim(
const UsdPrim &prim,
const char* operation)
const;
1686 bool _ValidateEditPrimAtPath(
const SdfPath &primPath,
1687 const char* operation)
const;
1691 bool _RemoveProperty(
const SdfPath& path);
1705 struct _IsEditTargetMappable {
1706 static const bool value =
1707 std::is_same<T, SdfTimeCode>::value ||
1708 std::is_same<T, VtArray<SdfTimeCode>>::value ||
1709 std::is_same<T, SdfTimeSampleMap>::value ||
1710 std::is_same<T, VtDictionary>::value;
1715 typename std::enable_if<!_IsEditTargetMappable<T>::value,
bool>::type
1721 typename std::enable_if<_IsEditTargetMappable<T>::value,
bool>::type
1731 bool _SetEditTargetMappedValue(
1742 typename std::enable_if<!_IsEditTargetMappable<T>::value,
bool>::type
1744 const TfToken &keyPath,
const T& value);
1748 typename std::enable_if<_IsEditTargetMappable<T>::value,
bool>::type
1750 const TfToken &keyPath,
const T& value);
1755 bool _SetMetadata(
const UsdObject &
object,
1761 bool _SetEditTargetMappedMetadata(
1763 const TfToken &keyPath,
const T &newValue);
1766 bool _SetMetadataImpl(
1768 const TfToken &keyPath,
const T &value);
1778 PcpCache const *_GetPcpCache()
const {
return _cache.get(); }
1779 PcpCache *_GetPcpCache() {
return _cache.get(); }
1787 void _ReportPcpErrors(
const PcpErrorVector &errors,
1788 const std::string &context)
const;
1789 void _ReportErrors(
const PcpErrorVector &errors,
1790 const std::vector<std::string>& otherErrors,
1791 const std::string &context)
const;
1801 void _ComposePrimIndexesInParallel(
1802 const std::vector<SdfPath>& primIndexPaths,
1803 const std::string& context,
1804 Usd_InstanceChanges* instanceChanges =
nullptr);
1808 void _ComposeSubtree(
1809 Usd_PrimDataPtr prim, Usd_PrimDataConstPtr parent,
1812 void _ComposeSubtreeImpl(
1813 Usd_PrimDataPtr prim, Usd_PrimDataConstPtr parent,
1816 void _ComposeSubtreeInParallel(Usd_PrimDataPtr prim);
1817 void _ComposeSubtreesInParallel(
1818 const std::vector<Usd_PrimDataPtr> &prims,
1819 const std::vector<SdfPath> *primIndexPaths =
nullptr);
1824 void _ComposeChildSubtree(Usd_PrimDataPtr prim,
1825 Usd_PrimDataConstPtr parent,
1838 void _ComposeChildren(Usd_PrimDataPtr prim,
1843 Usd_PrimDataPtr _InstantiatePrim(
const SdfPath &primPath);
1847 Usd_PrimDataPtr _InstantiatePrototypePrim(
const SdfPath &primPath);
1851 void _DestroyPrim(Usd_PrimDataPtr prim);
1855 void _DestroyPrimsInParallel(
const std::vector<SdfPath>& paths);
1858 void _DestroyDescendents(Usd_PrimDataPtr prim);
1863 bool _IsObjectDescendantOfInstance(
const SdfPath& path)
const;
1867 Usd_PrimDataConstPtr _GetPrototypeForInstance(Usd_PrimDataConstPtr p)
const;
1870 SdfPath _GetPrimPathUsingPrimIndexAtPath(
const SdfPath& primIndexPath)
const;
1880 void _ProcessPendingChanges();
1884 bool _RemovePrim(
const SdfPath& fullPath);
1886 SdfPrimSpecHandle _GetPrimSpec(
const SdfPath& fullPath);
1893 SdfSpecType _GetDefiningSpecType(Usd_PrimDataConstPtr primData,
1894 const TfToken &propName)
const;
1900 void _Recompose(
const PcpChanges &changes, T *pathsToRecompose);
1902 void _RecomposePrims(T *pathsToRecompose);
1908 template <
class Iter>
1909 void _ComputeSubtreesToRecompose(Iter start, Iter finish,
1910 std::vector<Usd_PrimDataPtr>* recompose);
1914 bool _IsValidForLoad(
const SdfPath& path)
const;
1915 bool _IsValidForUnload(
const SdfPath& path)
const;
1925 void _DiscoverPayloads(
const SdfPath& rootPath,
1927 SdfPathSet* primIndexPaths,
1928 bool unloadedOnly =
false,
1929 SdfPathSet* usdPrimPaths =
nullptr)
const;
1940 static SdfSpecifier _GetSpecifier(Usd_PrimDataConstPtr primData);
1941 static TfToken _GetKind(Usd_PrimDataConstPtr primData);
1942 static bool _IsActive(Usd_PrimDataConstPtr primData);
1953 size_t numAssetPaths,
1954 bool anchorAssetPathsOnly =
false)
const;
1958 bool anchorAssetPathsOnly =
false)
const;
1962 size_t numTimeCodes)
const;
1977 struct _HasTypeSpecificResolution {
1978 static const bool value =
1979 std::is_same<T, SdfAssetPath>::value ||
1980 std::is_same<T, VtArray<SdfAssetPath>>::value ||
1981 std::is_same<T, SdfTimeCode>::value ||
1982 std::is_same<T, VtArray<SdfTimeCode>>::value ||
1983 std::is_same<T, SdfTimeSampleMap>::value ||
1984 std::is_same<T, VtDictionary>::value;
1990 typename std::enable_if<!_HasTypeSpecificResolution<T>::value,
bool>::type
1999 typename std::enable_if<_HasTypeSpecificResolution<T>::value,
bool>::type
2018 bool _GetStrongestResolvedMetadata(
const UsdObject &obj,
2029 bool _GetTypeSpecificResolvedMetadata(
const UsdObject &obj,
2035 template <
class Composer>
2039 Composer *composer)
const;
2041 template <
class Composer>
2044 Composer *composer)
const;
2046 template <
class Composer>
2049 Composer *composer)
const;
2051 template <
class Composer>
2052 bool _GetSpecialPropMetadataImpl(
const UsdObject &obj,
2056 Composer *composer)
const;
2057 template <
class Composer>
2058 bool _GetMetadataImpl(
const UsdObject &obj,
2061 bool includeFallbacks,
2062 Composer *composer)
const;
2064 template <
class Composer>
2065 bool _GetGeneralMetadataImpl(
const UsdObject &obj,
2068 bool includeFallbacks,
2069 Composer *composer)
const;
2075 const TfToken &keyPath,
bool useFallbacks)
const;
2078 _ListMetadataFields(
const UsdObject &obj,
bool useFallbacks)
const;
2080 void _GetAllMetadata(
const UsdObject &obj,
2082 UsdMetadataValueMap* result,
2083 bool anchorAssetPathsOnly =
false)
const;
2093 template <
class T>
struct _ExtraResolveInfo;
2099 _ExtraResolveInfo<T> *extraInfo =
nullptr)
const;
2101 template <
class T>
struct _ResolveInfoResolver;
2102 struct _PropertyStackResolver;
2104 template <
class Resolver>
2105 void _GetResolvedValueImpl(
const UsdProperty &prop,
2118 Usd_InterpolatorBase* interpolator,
2122 _GetLayerWithStrongestValue(
2141 Usd_InterpolatorBase* interpolator,
2154 bool _GetTimeSamplesInInterval(
const UsdAttribute &attr,
2156 std::vector<double>* times)
const;
2158 bool _GetTimeSamplesInIntervalFromResolveInfo(
2162 std::vector<double>* times)
const;
2164 size_t _GetNumTimeSamples(
const UsdAttribute &attr)
const;
2166 size_t _GetNumTimeSamplesFromResolveInfo(
const UsdResolveInfo &info,
2172 bool _GetBracketingTimeSamples(
const UsdAttribute &attr,
2177 bool* hasSamples)
const;
2179 bool _GetBracketingTimeSamplesFromResolveInfo(
const UsdResolveInfo &info,
2185 bool* hasSamples)
const;
2187 bool _ValueMightBeTimeVarying(
const UsdAttribute &attr)
const;
2189 bool _ValueMightBeTimeVaryingFromResolveInfo(
const UsdResolveInfo &info,
2192 void _RegisterPerLayerNotices();
2193 void _RegisterResolverChangeNotice();
2198 Usd_PrimDataPtr _pseudoRoot;
2210 std::unique_ptr<PcpCache> _cache;
2211 std::unique_ptr<Usd_ClipCache> _clipCache;
2212 std::unique_ptr<Usd_InstanceCache> _instanceCache;
2214 TfHashMap<TfToken, TfToken, TfHash> _invalidPrimTypeToFallbackMap;
2216 size_t _usedLayersRevision;
2220 SdfPath, Usd_PrimDataIPtr, SdfPath::Hash> PathToNodeMap;
2221 PathToNodeMap _primMap;
2222 mutable boost::optional<tbb::spin_rw_mutex> _primMapMutex;
2227 typedef std::vector<
2228 std::pair<SdfLayerHandle, TfNotice::Key> > _LayerAndNoticeKeyVec;
2229 _LayerAndNoticeKeyVec _layersAndNoticeKeys;
2230 size_t _lastChangeSerialNumber;
2235 class _PendingChanges;
2236 _PendingChanges* _pendingChanges;
2238 boost::optional<WorkDispatcher> _dispatcher;
2242 char const *_mallocTagID;
2253 bool _isClosingStage;
2254 bool _isWritingFallbackPrimTypes;
2268 friend class Usd_FlattenAccess;
2269 friend class Usd_PcpCacheAccess;
2270 friend class Usd_PrimData;
2271 friend class Usd_StageOpenRequest;
2272 template <
class T>
friend struct Usd_AttrGetValueHelper;
2273 friend struct Usd_AttrGetUntypedValueHelper;
2274 template <
class RefsOrPayloadsEditorType,
class RefsOrPayloadsProxyType>
2275 friend struct Usd_ListEditImpl;
2284 UsdStage::_GetTypeSpecificResolvedMetadata(
const UsdObject &obj,
2290 template<
typename T>
2304 " match retrieved type %s",
2305 ArchGetDemangled<T>().c_str(),
2312 template<
typename T>
2320 template<
typename T>
2334 TF_CODING_ERROR(
"Requested type %s for stage metadatum %s[%s] does not"
2335 " match retrieved type %s",
2336 ArchGetDemangled<T>().c_str(),
2344 template<
typename T>
2347 const T& value)
const
2355 typename std::enable_if<
2356 !UsdStage::_HasTypeSpecificResolution<T>::value,
bool>::type
2357 UsdStage::_GetMetadata(
const UsdObject &obj,
2366 return _GetStrongestResolvedMetadata(
2367 obj, fieldName, keyPath, useFallbacks, &out);
2372 typename std::enable_if<
2373 UsdStage::_HasTypeSpecificResolution<T>::value,
bool>::type
2374 UsdStage::_GetMetadata(
const UsdObject &obj,
2382 return _GetTypeSpecificResolvedMetadata(
2383 obj, fieldName, keyPath, useFallbacks, result);
2389 typename std::enable_if<!UsdStage::_IsEditTargetMappable<T>::value,
bool>::type
2391 const TfToken &keyPath,
const T& value)
2396 return _SetMetadataImpl<SdfAbstractDataConstValue>(
2397 object, key, keyPath, in);
2402 typename std::enable_if<UsdStage::_IsEditTargetMappable<T>::value,
bool>::type
2404 const TfToken &keyPath,
const T& value)
2406 return _SetEditTargetMappedMetadata(
object, key, keyPath, value);
2410 PXR_NAMESPACE_CLOSE_SCOPE
2412 #endif //PXR_USD_USD_STAGE_H
USD_API void ExpandPopulationMask(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...
static USD_API void SetGlobalVariantFallbacks(const PcpVariantFallbackMap &fallbacks)
Set the global variant fallback preferences used in new UsdStages.
A proxy class for applying listOp edits to the specializes list for a prim.
Handle-object returned by TfNotice::Register().
A unit of scene description that you combine with other units of scene description to form a shot...
USD_API void SetStartTimeCode(double)
Sets the stage's start timeCode.
USD_API UsdPrimRange Traverse()
Traverse the active, loaded, defined, non-abstract prims on this stage depth-first.
static USD_API void GetColorConfigFallbacks(SdfAssetPath *colorConfiguration, TfToken *colorManagementSystem)
Returns the global fallback values of 'colorConfiguration' and 'colorManagementSystem'.
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 UsdPrim GetPseudoRoot() const
Return the stage's "pseudo-root" prim, whose name is defined by Usd.
PcpPrimIndex is an index of the all sites of scene description that contribute opinions to a specific...
T const & UncheckedGet() const
Returns a const reference to the held object if the held object is of type T.
USD_API void SetLoadRules(UsdStageLoadRules const &rules)
Set the UsdStageLoadRules to govern payload inclusion on this stage.
Standard pointer typedefs.
USD_API void SetDefaultPrim(const UsdPrim &prim)
Set the default prim layer metadata in this stage's root layer.
USD_API SdfAssetPath GetColorConfiguration() const
Returns the default color configuration used to interpret the per- attribute color-spaces in the comp...
USD_API void SetInterpolationType(UsdInterpolationType interpolationType)
Sets the interpolation type used during value resolution for all attributes on this stage...
The fully-typed container for a field value in an SdfAbstractData.
USD_API UsdPrim OverridePrim(const SdfPath &path)
Attempt to ensure a UsdPrim at path exists on this stage.
USD_API UsdInterpolationType GetInterpolationType() const
Returns the interpolation type used during value resolution for all attributes on this stage...
A type-erased container for a field value in an SdfAbstractData.
Object for efficiently making repeated queries for attribute values.
USD_API void LoadAndUnload(const SdfPathSet &loadSet, const SdfPathSet &unloadSet, UsdLoadPolicy policy=UsdLoadWithDescendants)
Unload and load the given path sets.
USD_API double GetFramesPerSecond() const
Returns the stage's framesPerSecond value.
USD_API const UsdEditTarget & GetEditTarget() const
Return the stage's EditTarget.
USD_API UsdPrim CreateClassPrim(const SdfPath &rootPrimPath)
Author an SdfPrimSpec with specifier == SdfSpecifierClass for the class at root prim path path at the...
#define TF_CODING_ERROR(fmt, args)
Issue an internal programming error, but continue execution.
static USD_API UsdStageRefPtr CreateInMemory(InitialLoadSet load=LoadAll)
Creates a new stage only in memory, analogous to creating an anonymous SdfLayer.
PcpCache is the context required to make requests of the Pcp composition algorithm and cache the resu...
bool IsHolding() const
Return true if this value is holding an object of type T, false otherwise.
static USD_API bool IsSupportedFile(const std::string &filePath)
Indicates whether the specified file is supported by UsdStage.
USD_API UsdPrim GetPrimAtPath(const SdfPath &path) const
Return the UsdPrim at path, or an invalid UsdPrim if none exists.
The outermost container for scene description, which owns and presents composed prims as a scenegraph...
UsdStageLoadRules const & GetLoadRules() const
Return the stage's current UsdStageLoadRules governing payload inclusion.
USD_API void SetTimeCodesPerSecond(double timeCodesPerSecond) const
Sets the stage's timeCodesPerSecond value.
Load a prim plus all its descendants.
A proxy class for applying listOp edits to the inherit paths list for a prim.
USD_API UsdPrim GetDefaultPrim() const
Return the root UsdPrim on this stage whose name is the root layer's defaultPrim metadata's value...
USD_API void Save()
Calls SdfLayer::Save on all dirty layers contributing to this stage except session layers and sublaye...
USD_API SdfLayerHandle GetRootLayer() const
Return this stage's root layer.
USD_API bool IsLayerMuted(const std::string &layerIdentifier) const
Returns true if the layer specified by layerIdentifier is muted in this cache, false otherwise...
The base class for all API schemas.
Container for information about the source of an attribute's value, i.e.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
USD_API UsdProperty GetPropertyAtPath(const SdfPath &path) const
Return the UsdProperty at path, or an invalid UsdProperty if none exists.
SdfHandle is a smart ptr that calls IsDormant() on the pointed-to object as an extra expiration check...
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 std::vector< UsdPrim > GetPrototypes() const
Returns all native instancing prototype prims.
Enable a concrete base class for use with TfRefPtr.
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 void SetColorConfiguration(const SdfAssetPath &colorConfig) const
Sets the default color configuration to be used to interpret the per-attribute color-spaces in the co...
UsdStagePopulationMask GetPopulationMask() const
Return this stage's population mask.
Token for efficient comparison, assignment, and hashing of known strings.
USD_API SdfLayerHandleVector GetLayerStack(bool includeSessionLayers=true) const
Return this stage's local layers in strong-to-weak order.
USD_API double GetEndTimeCode() const
Returns the stage's end timeCode.
USD_API bool ClearMetadataByDictKey(const TfToken &key, const TfToken &keyPath) const
Clear any authored value identified by key and keyPath at the current EditTarget. ...
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 void UnmuteLayer(const std::string &layerIdentifier)
Unmute the layer identified by layerIdentifier if it had previously been muted.
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.
Value type that represents a time code.
A UsdVariantSet represents a single VariantSet in USD (e.g.
USD_API void SetFramesPerSecond(double framesPerSecond) const
Sets the stage's framesPerSecond value.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
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 ...
Base class for Usd scenegraph objects, providing common API.
Defines a mapping from scene graph paths to Sdf spec paths in a SdfLayer where edits should be direct...
The fully-typed container for a field value in an SdfAbstractData.
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.
This class represents rules that govern payload inclusion on UsdStages.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
USD_API UsdAttribute GetAttributeAtPath(const SdfPath &path) const
Return the UsdAttribute at path, or an invalid UsdAttribute if none exists.
InitialLoadSet
Specifies the initial set of prims to load when opening a UsdStage.
SdfSpecifier
An enum that identifies the possible specifiers for an SdfPrimSpec.
std::map< std::string, std::string > FileFormatArguments
Type for specifying additional file format-specific arguments to layer API.
USD_API SdfPathSet GetLoadSet()
Returns a set of all loaded paths.
std::vector< TfToken > TfTokenVector
Convenience types.
Notice sent when asset paths may resolve to a different path than before due to a change in the resol...
A basic mathematical interval class.
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 ...
A path value used to locate objects in layers or scenegraphs.
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 UsdRelationship GetRelationshipAtPath(const SdfPath &path) const
Return the UsdAttribute at path, or an invalid UsdAttribute if none exists.
VT_API std::string GetTypeName() const
Return the type name of the held typeid.
USD_API UsdObject GetObjectAtPath(const SdfPath &path) const
Return the UsdObject at path, or an invalid UsdObject if none exists.
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
USD_API double GetStartTimeCode() const
Returns the stage's start timeCode.
USD_API UsdPrimRange TraverseAll()
Traverse all the prims on this stage depth-first.
USD_API void SaveSessionLayers()
Calls SdfLayer::Save on all dirty session layers and sublayers of session layers contributing to this...
USD_API void SetPopulationMask(UsdStagePopulationMask const &mask)
Set this stage's population mask and recompose the stage.
SdfVariability
An enum that identifies variability types for attributes.
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 void SetEndTimeCode(double)
Sets the stage's end timeCode.
UsdLoadPolicy
Controls UsdStage::Load() and UsdPrim::Load() behavior regarding whether or not descendant prims are ...
bool GetMetadataByDictKey(const TfToken &key, const TfToken &keyPath, T *value) const
Resolve the requested dictionary sub-element keyPath of dictionary-valued metadatum named key...
Contains an asset path and an optional resolved path.
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 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...
Notice sent per-layer indicating all layers whose contents have changed within a single round of chan...
Base class for UsdAttribute and UsdRelationship scenegraph objects.
An forward-iterable range that traverses a subtree of prims rooted at a given prim in depth-first ord...
SdfSpecType
An enum that specifies the type of an object.
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 SDF_API const SdfPath & AbsoluteRootPath()
The absolute path representing the top of the namespace hierarchy.
USD_API double GetTimeCodesPerSecond() const
Returns the stage's timeCodesPerSecond value.
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 const std::vector< std::string > & GetMutedLayers() const
Returns a vector of all layers that have been muted on this stage.
USD_API void Reload()
Calls SdfLayer::Reload on all layers contributing to this stage, except session layers and sublayers ...
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 SdfPathSet FindLoadable(const SdfPath &rootPath=SdfPath::AbsoluteRootPath())
Returns an SdfPathSet of all paths that can be loaded.
USD_API void SetEditTarget(const UsdEditTarget &editTarget)
Set the stage's EditTarget.
USD_API TfToken GetColorManagementSystem() const
Sets the name of the color management system to be used for loading and interpreting the color config...
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...
static USD_API void SetColorConfigFallbacks(const SdfAssetPath &colorConfiguration, const TfToken &colorManagementSystem)
Sets the global fallback values of color configuration metadata which includes the 'colorConfiguratio...
USD_API SdfLayerHandle GetSessionLayer() const
Return this stage's root session layer.
USD_API void WriteFallbackPrimTypes()
Writes the fallback prim types defined in the schema registry to the stage as dictionary valued fallb...
UsdInterpolationType
Attribute value interpolation options.
An asset resolver context allows clients to provide additional data to the resolver for use during re...
USD_API void MuteLayer(const std::string &layerIdentifier)
Mute the layer identified by layerIdentifier.
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.
USD_API SdfLayerRefPtr Flatten(bool addSourceFileComment=true) const
Returns a single, anonymous, merged layer for this composite scene.
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(...
UsdVariantSets represents the collection of VariantSets that are present on a UsdPrim.
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...
std::map< double, VtValue > SdfTimeSampleMap
A map from sample times to sample values.
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...
static USD_API PcpVariantFallbackMap GetGlobalVariantFallbacks()
Get the global variant fallback preferences used in new UsdStages.
Enable a concrete base class for use with TfWeakPtr.
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.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
This class represents a mask that may be applied to a UsdStage to limit the set of UsdPrim s it popul...
std::map< std::string, std::vector< std::string > > PcpVariantFallbackMap
typedef std::map<std::string, std::vector<std::string>> PcpVariantFallbackMap
USD_API ArResolverContext GetPathResolverContext() const
Return the path resolver context for all path resolution during composition of this stage...
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 UsdEditTarget GetEditTargetForLocalLayer(size_t i)
Return a UsdEditTarget for editing the layer at index i in the layer stack.
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...
char const * GetText() const
Return the text that this token represents.