|
HDK
|
#include <layer.h>
Inheritance diagram for SdfLayer:Classes | |
| class | DetachedLayerRules |
Public Member Functions | |
| virtual SDF_API | ~SdfLayer () |
| Destructor. More... | |
| SdfLayer (const SdfLayer &)=delete | |
| Noncopyable. More... | |
| SdfLayer & | operator= (const SdfLayer &)=delete |
External references | |
| SDF_API std::set< std::string > | GetExternalReferences () const |
| SDF_API bool | UpdateExternalReference (const std::string &oldAssetPath, const std::string &newAssetPath=std::string()) |
| SDF_API std::set< std::string > | GetCompositionAssetDependencies () const |
| SDF_API bool | UpdateCompositionAssetDependency (const std::string &oldAssetPath, const std::string &newAssetPath=std::string()) |
| SDF_API std::set< std::string > | GetExternalAssetDependencies () const |
Fields | |
All scene description for a given object is stored as a set of key/value pairs called fields. These methods provide direct access to those fields, though most clients should use the Spec API to ensure data consistency. These methods all take SdfPath to identify the queried spec. | |
| SDF_API SdfSpecType | GetSpecType (const SdfPath &path) const |
| SDF_API bool | HasSpec (const SdfPath &path) const |
| Return whether a spec exists at path. More... | |
| SDF_API std::vector< TfToken > | ListFields (const SdfPath &path) const |
Return the names of all the fields that are set at path. More... | |
| SDF_API bool | HasField (const SdfPath &path, const TfToken &fieldName, VtValue *value=NULL) const |
| SDF_API bool | HasField (const SdfPath &path, const TfToken &fieldName, SdfAbstractDataValue *value) const |
| template<class T > | |
| bool | HasField (const SdfPath &path, const TfToken &name, T *value) const |
| std::type_info const & | GetFieldTypeid (const SdfPath &path, const TfToken &name) const |
| SDF_API bool | HasFieldDictKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, VtValue *value=NULL) const |
| SDF_API bool | HasFieldDictKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, SdfAbstractDataValue *value) const |
| template<class T > | |
| bool | HasFieldDictKey (const SdfPath &path, const TfToken &name, const TfToken &keyPath, T *value) const |
| SDF_API VtValue | GetField (const SdfPath &path, const TfToken &fieldName) const |
| template<class T > | |
| T | GetFieldAs (const SdfPath &path, const TfToken &fieldName, const T &defaultValue=T()) const |
| SDF_API VtValue | GetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath) const |
| SDF_API void | SetField (const SdfPath &path, const TfToken &fieldName, const VtValue &value) |
| Set the value of the given path and fieldName. More... | |
| SDF_API void | SetField (const SdfPath &path, const TfToken &fieldName, const SdfAbstractDataConstValue &value) |
| template<class T > | |
| void | SetField (const SdfPath &path, const TfToken &fieldName, const T &val) |
| Set the value of the given path and fieldName. More... | |
| SDF_API void | SetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, const VtValue &value) |
| SDF_API void | SetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, const SdfAbstractDataConstValue &value) |
| template<class T > | |
| void | SetFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath, const T &val) |
| SDF_API void | EraseField (const SdfPath &path, const TfToken &fieldName) |
Remove the field at path and fieldName, if one exists. More... | |
| SDF_API void | EraseFieldDictValueByKey (const SdfPath &path, const TfToken &fieldName, const TfToken &keyPath) |
Metadata | |
| SDF_API SdfAssetPath | GetColorConfiguration () const |
| SDF_API void | SetColorConfiguration (const SdfAssetPath &colorConfiguration) |
| Sets the color configuration asset-path for this layer. More... | |
| SDF_API bool | HasColorConfiguration () const |
| SDF_API void | ClearColorConfiguration () |
| SDF_API TfToken | GetColorManagementSystem () const |
| SDF_API void | SetColorManagementSystem (const TfToken &cms) |
| SDF_API bool | HasColorManagementSystem () const |
| SDF_API void | ClearColorManagementSystem () |
| SDF_API std::string | GetComment () const |
| SDF_API void | SetComment (const std::string &comment) |
| Sets the comment string for this layer. More... | |
| SDF_API TfToken | GetDefaultPrim () const |
| SDF_API void | SetDefaultPrim (const TfToken &name) |
| SDF_API void | ClearDefaultPrim () |
| SDF_API bool | HasDefaultPrim () |
| SDF_API std::string | GetDocumentation () const |
| SDF_API void | SetDocumentation (const std::string &documentation) |
| Sets the documentation string for this layer. More... | |
| SDF_API double | GetStartTimeCode () const |
| SDF_API void | SetStartTimeCode (double startTimecode) |
| Sets the layer's start timeCode. More... | |
| SDF_API bool | HasStartTimeCode () const |
| Returns true if the layer has a startTimeCode opinion. More... | |
| SDF_API void | ClearStartTimeCode () |
| Clear the startTimeCode opinion. More... | |
| SDF_API double | GetEndTimeCode () const |
| SDF_API void | SetEndTimeCode (double endTimeCode) |
| Sets the layer's end timeCode. More... | |
| SDF_API bool | HasEndTimeCode () const |
| Returns true if the layer has an endTimeCode opinion. More... | |
| SDF_API void | ClearEndTimeCode () |
| Clear the endTimeCode opinion. More... | |
| SDF_API double | GetTimeCodesPerSecond () const |
| SDF_API void | SetTimeCodesPerSecond (double timeCodesPerSecond) |
| Sets the layer's timeCodes per second. More... | |
| SDF_API bool | HasTimeCodesPerSecond () const |
| Returns true if the layer has a timeCodesPerSecond opinion. More... | |
| SDF_API void | ClearTimeCodesPerSecond () |
| Clear the timeCodesPerSecond opinion. More... | |
| SDF_API double | GetFramesPerSecond () const |
| SDF_API void | SetFramesPerSecond (double framesPerSecond) |
| Sets the layer's frames per second. More... | |
| SDF_API bool | HasFramesPerSecond () const |
| Returns true if the layer has a frames per second opinion. More... | |
| SDF_API void | ClearFramesPerSecond () |
| Clear the framesPerSecond opinion. More... | |
| SDF_API int | GetFramePrecision () const |
| Returns the layer's frame precision. More... | |
| SDF_API void | SetFramePrecision (int framePrecision) |
| Sets the layer's frame precision. More... | |
| SDF_API bool | HasFramePrecision () const |
| Returns true if the layer has a frames precision opinion. More... | |
| SDF_API void | ClearFramePrecision () |
| Clear the framePrecision opinion. More... | |
| SDF_API std::string | GetOwner () const |
| Returns the layer's owner. More... | |
| SDF_API void | SetOwner (const std::string &owner) |
| Sets the layer's owner. More... | |
| SDF_API bool | HasOwner () const |
| Returns true if the layer has an owner opinion. More... | |
| SDF_API void | ClearOwner () |
| Clear the owner opinion. More... | |
| SDF_API std::string | GetSessionOwner () const |
| SDF_API void | SetSessionOwner (const std::string &owner) |
| SDF_API bool | HasSessionOwner () const |
| Returns true if the layer has a session owner opinion. More... | |
| SDF_API void | ClearSessionOwner () |
| SDF_API bool | GetHasOwnedSubLayers () const |
| Returns true if the layer's sublayers are expected to have owners. More... | |
| SDF_API void | SetHasOwnedSubLayers (bool) |
| Sets whether the layer's sublayers are expected to have owners. More... | |
| SDF_API VtDictionary | GetCustomLayerData () const |
| SDF_API void | SetCustomLayerData (const VtDictionary &value) |
| Sets the CustomLayerData dictionary associated with this layer. More... | |
| SDF_API bool | HasCustomLayerData () const |
| Returns true if CustomLayerData is authored on the layer. More... | |
| SDF_API void | ClearCustomLayerData () |
| Clears out the CustomLayerData dictionary associated with this layer. More... | |
| SDF_API VtDictionary | GetExpressionVariables () const |
| SDF_API void | SetExpressionVariables (const VtDictionary &expressionVars) |
| Sets the expression variables dictionary for this layer. More... | |
| SDF_API bool | HasExpressionVariables () const |
| Returns true if expression variables are authored on this layer. More... | |
| SDF_API void | ClearExpressionVariables () |
| Clears the expression variables dictionary authored on this layer. More... | |
Sublayers | |
| SDF_API SdfSubLayerProxy | GetSubLayerPaths () const |
| SDF_API void | SetSubLayerPaths (const std::vector< std::string > &newPaths) |
| Sets the paths of the layer's sublayers. More... | |
| SDF_API size_t | GetNumSubLayerPaths () const |
| Returns the number of sublayer paths (and offsets). More... | |
| SDF_API void | InsertSubLayerPath (const std::string &path, int index=-1) |
| SDF_API void | RemoveSubLayerPath (int index) |
| Removes sublayer path at the given index. More... | |
| SDF_API SdfLayerOffsetVector | GetSubLayerOffsets () const |
| Returns the layer offsets for all the subLayer paths. More... | |
| SDF_API SdfLayerOffset | GetSubLayerOffset (int index) const |
| Returns the layer offset for the subLayer path at the given index. More... | |
| SDF_API void | SetSubLayerOffset (const SdfLayerOffset &offset, int index) |
| Sets the layer offset for the subLayer path at the given index. More... | |
Lookup | |
| SDF_API SdfPrimSpecHandle | GetPseudoRoot () const |
| SDF_API SdfSpecHandle | GetObjectAtPath (const SdfPath &path) |
| SDF_API SdfPrimSpecHandle | GetPrimAtPath (const SdfPath &path) |
| SDF_API SdfPropertySpecHandle | GetPropertyAtPath (const SdfPath &path) |
| SDF_API SdfAttributeSpecHandle | GetAttributeAtPath (const SdfPath &path) |
| SDF_API SdfRelationshipSpecHandle | GetRelationshipAtPath (const SdfPath &path) |
Permissions | |
| SDF_API bool | PermissionToEdit () const |
| SDF_API bool | PermissionToSave () const |
| SDF_API void | SetPermissionToEdit (bool allow) |
| Sets permission to edit. More... | |
| SDF_API void | SetPermissionToSave (bool allow) |
| Sets permission to save. More... | |
Batch namespace editing | |
| SDF_API SdfNamespaceEditDetail::Result | CanApply (const SdfBatchNamespaceEdit &, SdfNamespaceEditDetailVector *details=NULL) const |
| SDF_API bool | Apply (const SdfBatchNamespaceEdit &) |
Layer state | |
| SDF_API SdfLayerStateDelegateBasePtr | GetStateDelegate () const |
| SDF_API void | SetStateDelegate (const SdfLayerStateDelegateBaseRefPtr &delegate) |
| SDF_API bool | IsDirty () const |
| Public Member Functions inherited from TfRefBase | |
| TfRefBase () | |
| TfRefBase (TfRefBase const &) | |
| TfRefBase & | operator= (TfRefBase const &) |
| size_t | GetCurrentCount () const |
| Return the current reference count of this object. More... | |
| bool | IsUnique () const |
Return true if only one TfRefPtr points to this object. More... | |
| void | SetShouldInvokeUniqueChangedListener (bool shouldCall) |
| Public Member Functions inherited from TfWeakBase | |
| TfWeakBase () | |
| TfWeakBase (const TfWeakBase &) | |
| const TfWeakBase & | __GetTfWeakBase__ () const |
| const TfWeakBase & | operator= (const TfWeakBase &) |
| void | EnableNotification2 () const |
| TF_API void const * | GetUniqueIdentifier () const |
Static Public Member Functions | |
Detached Layers | |
Detached layers are layers that are detached from the serialized data store and isolated from any external changes to that serialized data. File format plugins may produce layers that maintain a persistent connection to their serialized representation to read data on-demand. For example, a file format might set up layers to hold an open file handle and read attribute time samples from it only when requested, to avoid pulling in unnecessary data. However, there may be times when keeping this connection is undesirable. In the previous example, a crash might occur if some other process were to change the file on disk, or users might be prevented from overwriting the file at all which could interfere with workflow. To avoid these problems, the functions below may be used to specify layers that are to be detached from the original serialized data. | |
| static SDF_API void | SetDetachedLayerRules (const DetachedLayerRules &mask) |
| static SDF_API const DetachedLayerRules & | GetDetachedLayerRules () |
| Returns the current rules for the detached layer set. More... | |
| static SDF_API bool | IsIncludedByDetachedLayerRules (const std::string &identifier) |
| Static Public Member Functions inherited from TfRefBase | |
| static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
Protected Member Functions | |
| SdfLayer (const SdfFileFormatConstPtr &fileFormat, const std::string &identifier, const std::string &realPath=std::string(), const ArAssetInfo &assetInfo=ArAssetInfo(), const FileFormatArguments &args=FileFormatArguments(), bool validateAuthoring=false) | |
| Protected Member Functions inherited from TfRefBase | |
| virtual TF_API | ~TfRefBase () |
| Protected Member Functions inherited from TfWeakBase | |
| ~TfWeakBase () | |
| TfRefPtr< Tf_Remnant > | _Register () const |
| template<class T > | |
| TfRefPtr< Tf_Remnant > | _Register (T *tempRmnt) const |
| bool | _HasRemnant () const |
Friends | |
| class | SdfSpec |
| class | SdfPropertySpec |
| class | SdfAttributeSpec |
| class | Sdf_ChangeManager |
| template<class ChildPolicy > | |
| class | Sdf_ChildrenUtils |
| class | SdfFileFormat |
| class | SdfLayerStateDelegateBase |
Primary API | |
| typedef std::map< std::string, std::string > | FileFormatArguments |
| SDF_API const SdfSchemaBase & | GetSchema () const |
| SDF_API const SdfFileFormatConstPtr & | GetFileFormat () const |
| Returns the file format used by this layer. More... | |
| SDF_API const FileFormatArguments & | GetFileFormatArguments () const |
| SDF_API SdfDataRefPtr | GetMetadata () const |
| Returns the data from the absolute root path of this layer. More... | |
| SDF_API SdfLayerHints | GetHints () const |
| SDF_API bool | IsEmpty () const |
| Returns whether this layer has no significant data. More... | |
| SDF_API bool | StreamsData () const |
| SDF_API bool | IsDetached () const |
| SDF_API void | TransferContent (const SdfLayerHandle &layer) |
| SDF_API bool | IsAnonymous () const |
| Returns true if this layer is an anonymous layer. More... | |
| static SDF_API SdfLayerRefPtr | CreateNew (const std::string &identifier, const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerRefPtr | CreateNew (const SdfFileFormatConstPtr &fileFormat, const std::string &identifier, const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerRefPtr | New (const SdfFileFormatConstPtr &fileFormat, const std::string &identifier, const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerHandle | Find (const std::string &identifier, const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerHandle | FindRelativeToLayer (const SdfLayerHandle &anchor, const std::string &identifier, const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerRefPtr | FindOrOpen (const std::string &identifier, const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerRefPtr | FindOrOpenRelativeToLayer (const SdfLayerHandle &anchor, const std::string &identifier, const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerRefPtr | OpenAsAnonymous (const std::string &layerPath, bool metadataOnly=false, const std::string &tag=std::string()) |
| static SDF_API SdfLayerHandleSet | GetLoadedLayers () |
| Returns handles for all layers currently held by the layer registry. More... | |
| static SDF_API SdfLayerRefPtr | CreateAnonymous (const std::string &tag=std::string(), const FileFormatArguments &args=FileFormatArguments()) |
| static SDF_API SdfLayerRefPtr | CreateAnonymous (const std::string &tag, const SdfFileFormatConstPtr &format, const FileFormatArguments &args=FileFormatArguments()) |
Create an anonymous layer with a specific format. More... | |
| static SDF_API bool | IsAnonymousLayerIdentifier (const std::string &identifier) |
| static SDF_API std::string | GetDisplayNameFromIdentifier (const std::string &identifier) |
File I/O | |
| SDF_API bool | Save (bool force=false) const |
| SDF_API bool | Export (const std::string &filename, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const |
| SDF_API bool | ExportToString (std::string *result) const |
| SDF_API bool | ImportFromString (const std::string &string) |
| SDF_API void | Clear () |
| SDF_API bool | Reload (bool force=false) |
| SDF_API bool | Import (const std::string &layerPath) |
| static SDF_API bool | ReloadLayers (const std::set< SdfLayerHandle > &layers, bool force=false) |
Identification | |
A layer's identifier is a string that uniquely identifies a layer. At minimum, it is the string by which the layer was created, either via FindOrOpen or CreateNew. If additional arguments were passed to those functions, those arguments will be encoded in the identifier. For example: FindOrOpen('foo.sdf', args={'a':'b', 'c':'d'}).identifier => "foo.sdf:SDF_FORMAT_ARGS:a=b&c=d" Note that this means the identifier may in general not be a path. The identifier format is subject to change; consumers should NOT parse layer identifiers themselves, but should use the supplied SplitIdentifier and CreateIdentifier helper functions. | |
| SDF_API const std::string & | GetIdentifier () const |
| Returns the layer identifier. More... | |
| SDF_API void | SetIdentifier (const std::string &identifier) |
| SDF_API void | UpdateAssetInfo () |
| SDF_API std::string | GetDisplayName () const |
| SDF_API const ArResolvedPath & | GetResolvedPath () const |
| SDF_API const std::string & | GetRealPath () const |
| SDF_API std::string | GetFileExtension () const |
| SDF_API const std::string & | GetVersion () const |
| SDF_API const std::string & | GetRepositoryPath () const |
| SDF_API const std::string & | GetAssetName () const |
| Returns the asset name associated with this layer. More... | |
| SDF_API const VtValue & | GetAssetInfo () const |
| SDF_API std::string | ComputeAbsolutePath (const std::string &assetPath) const |
| static SDF_API bool | SplitIdentifier (const std::string &identifier, std::string *layerPath, FileFormatArguments *arguments) |
| static SDF_API std::string | CreateIdentifier (const std::string &layerPath, const FileFormatArguments &arguments) |
| Joins the given layer path and arguments into an identifier. More... | |
Traversal | |
| typedef std::function< void(const SdfPath &)> | TraversalFunction |
| SDF_API void | Traverse (const SdfPath &path, const TraversalFunction &func) |
Prims | |
| typedef SdfPrimSpecView | RootPrimsView |
| Returns a vector of the layer's root prims. More... | |
| SDF_API RootPrimsView | GetRootPrims () const |
| Returns a vector of the layer's root prims. More... | |
| SDF_API void | SetRootPrims (const SdfPrimSpecHandleVector &rootPrims) |
| SDF_API bool | InsertRootPrim (const SdfPrimSpecHandle &prim, int index=-1) |
| SDF_API void | RemoveRootPrim (const SdfPrimSpecHandle &prim) |
| Remove a root prim. More... | |
| SDF_API void | ScheduleRemoveIfInert (const SdfSpec &spec) |
| SDF_API void | RemovePrimIfInert (SdfPrimSpecHandle prim) |
| SDF_API void | RemovePropertyIfHasOnlyRequiredFields (SdfPropertySpecHandle prop) |
| SDF_API void | RemoveInertSceneDescription () |
| SDF_API SdfNameOrderProxy | GetRootPrimOrder () const |
| SDF_API void | SetRootPrimOrder (const std::vector< TfToken > &names) |
| SDF_API void | InsertInRootPrimOrder (const TfToken &name, int index=-1) |
| SDF_API void | RemoveFromRootPrimOrder (const TfToken &name) |
| Removes a root prim name from the root prim order. More... | |
| SDF_API void | RemoveFromRootPrimOrderByIndex (int index) |
| Removes a root prim name from the root prim order by index. More... | |
| SDF_API void | ApplyRootPrimOrder (std::vector< TfToken > *vec) const |
Muting | |
| SDF_API bool | IsMuted () const |
Returns true if the current layer is muted. More... | |
| SDF_API void | SetMuted (bool muted) |
| static SDF_API std::set < std::string > | GetMutedLayers () |
| Returns the set of muted layer paths. More... | |
| static SDF_API bool | IsMuted (const std::string &path) |
Returns true if the specified layer path is muted. More... | |
| static SDF_API void | AddToMutedLayers (const std::string &mutedPath) |
| Add the specified path to the muted layers set. More... | |
| static SDF_API void | RemoveFromMutedLayers (const std::string &mutedPath) |
| Remove the specified path from the muted layers set. More... | |
Time-sample API | |
| SDF_API std::set< double > | ListAllTimeSamples () const |
| SDF_API std::set< double > | ListTimeSamplesForPath (const SdfPath &path) const |
| SDF_API bool | GetBracketingTimeSamples (double time, double *tLower, double *tUpper) |
| SDF_API size_t | GetNumTimeSamplesForPath (const SdfPath &path) const |
| SDF_API bool | GetBracketingTimeSamplesForPath (const SdfPath &path, double time, double *tLower, double *tUpper) |
| SDF_API bool | QueryTimeSample (const SdfPath &path, double time, VtValue *value=NULL) const |
| SDF_API bool | QueryTimeSample (const SdfPath &path, double time, SdfAbstractDataValue *value) const |
| template<class T > | |
| bool | QueryTimeSample (const SdfPath &path, double time, T *data) const |
| SDF_API void | SetTimeSample (const SdfPath &path, double time, const VtValue &value) |
| SDF_API void | SetTimeSample (const SdfPath &path, double time, const SdfAbstractDataConstValue &value) |
| template<class T > | |
| void | SetTimeSample (const SdfPath &path, double time, const T &value) |
| SDF_API void | EraseTimeSample (const SdfPath &path, double time) |
| SDF_API bool | WriteDataFile (const std::string &filename) |
| static SDF_API void | DumpLayerInfo () |
Additional Inherited Members | |
| Public Types inherited from TfRefBase | |
| typedef void(* | UniqueChangedFuncPtr )(TfRefBase const *, bool) |
A scene description container that can combine with other such containers to form simple component assets, and successively larger aggregates. The contents of an SdfLayer adhere to the SdfData data model. A layer can be ephemeral, or be an asset accessed and serialized through the ArAsset and ArResolver interfaces.
The SdfLayer class provides a consistent API for accesing and serializing scene description, using any data store provided by Ar plugins. Sdf itself provides a UTF-8 text format for layers identified by the ".sdf" identifier extension, but via the SdfFileFormat abstraction, allows downstream modules and plugins to adapt arbitrary data formats to the SdfData/SdfLayer model.
The FindOrOpen() method returns a new SdfLayer object with scene description from any supported asset format. Once read, a layer remembers which asset it was read from. The Save() method saves the layer back out to the original asset. You can use the Export() method to write the layer to a different location. You can use the GetIdentifier() method to get the layer's Id or GetRealPath() to get the resolved, full URI.
Layer identifiers are UTF-8 encoded strings. A layer's file format is determined via the identifier's extension (as resolved by Ar) with [A-Z] (and no other characters) explicitly case folded.
Layers can have a timeCode range (startTimeCode and endTimeCode). This range represents the suggested playback range, but has no impact on the extent of the animation data that may be stored in the layer. The metadatum "timeCodesPerSecond" is used to annotate how the time ordinate for samples contained in the file scales to seconds. For example, if timeCodesPerSecond is 24, then a sample at time ordinate 24 should be viewed exactly one second after the sample at time ordinate 0.
| typedef std::map<std::string, std::string> SdfLayer::FileFormatArguments |
| typedef std::function<void(const SdfPath&)> SdfLayer::TraversalFunction |
|
virtual |
Destructor.
|
delete |
Noncopyable.
|
protected |
|
static |
Add the specified path to the muted layers set.
| SDF_API bool SdfLayer::Apply | ( | const SdfBatchNamespaceEdit & | ) |
Performs a batch of namespace edits. Returns true on success and false on failure. On failure, no namespace edits will have occurred.
Reorders the given list of prim names according to the reorder rootPrims statement for this layer.
This routine employs the standard list editing operations for ordered items in a ListEditor.
| SDF_API SdfNamespaceEditDetail::Result SdfLayer::CanApply | ( | const SdfBatchNamespaceEdit & | , |
| SdfNamespaceEditDetailVector * | details = NULL |
||
| ) | const |
Check if a batch of namespace edits will succeed. This returns SdfNamespaceEditDetail::Okay if they will succeed as a batch, SdfNamespaceEditDetail::Unbatched if the edits will succeed but will be applied unbatched, and SdfNamespaceEditDetail::Error if they will not succeed. No edits will be performed in any case.
If details is not NULL and the method does not return Okay then details about the problems will be appended to details. A problem may cause the method to return early, so details may not list every problem.
Note that Sdf does not track backpointers so it's unable to fix up targets/connections to namespace edited objects. Clients must fix those to prevent them from falling off. In addition, this method will report failure if any relational attribute with a target to a namespace edited object is subsequently edited (in the same batch). Clients should perform edits on relational attributes first.
Clients may wish to report unbatch details to the user to confirm that the edits should be applied unbatched. This will give the user a chance to correct any problems that cause batching to fail and try again.
Clears the layer of all content.
This restores the layer to a state as if it had just been created with CreateNew(). This operation is Undo-able.
The fileName and whether journaling is enabled are not affected by this method.
Clears the color configuration metadata authored in this layer.
Clears the 'colorManagementSystem' metadata authored in this layer.
Clears out the CustomLayerData dictionary associated with this layer.
Clear the default prim metadata for this layer. See GetDefaultPrim() and SetDefaultPrim().
Clears the expression variables dictionary authored on this layer.
Returns the color configuration asset-path for this layer.
The default value is an empty asset-path.
| SDF_API std::string SdfLayer::ComputeAbsolutePath | ( | const std::string & | assetPath | ) | const |
Returns the path to the asset specified by assetPath using this layer to anchor the path if necessary. Returns assetPath if it's empty or an anonymous layer identifier.
This method can be used on asset paths that are authored in this layer to create new asset paths that can be copied to other layers. These new asset paths should refer to the same assets as the original asset paths. For example, if the underlying ArResolver is filesystem-based and assetPath is a relative filesystem path, this method might return the absolute filesystem path using this layer's location as the anchor.
The returned path should in general not be assumed to be an absolute filesystem path or any other specific form. It is "absolute" in that it should resolve to the same asset regardless of what layer it's authored in.
|
static |
Creates a new anonymous layer with an optional tag. An anonymous layer is a layer with a system assigned identifier, that cannot be saved to disk via Save(). Anonymous layers have an identifier, but no real path or other asset information fields.
Anonymous layers may be tagged, which can be done to aid debugging subsystems that make use of anonymous layers. The tag becomes the display name of an anonymous layer, and is also included in the generated identifier. Untagged anonymous layers have an empty display name.
Additional arguments may be supplied via the args parameter. These arguments may control behavior specific to the layer's file format.
|
static |
Create an anonymous layer with a specific format.
|
static |
Joins the given layer path and arguments into an identifier.
|
static |
Creates a new empty layer with the given identifier.
Additional arguments may be supplied via the args parameter. These arguments may control behavior specific to the layer's file format.
|
static |
Creates a new empty layer with the given identifier for a given file format class.
This function has the same behavior as the other CreateNew function, but uses the explicitly-specified fileFormat instead of attempting to discern the format from identifier.
Remove the field at path and fieldName, if one exists.
| SDF_API void SdfLayer::EraseFieldDictValueByKey | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const TfToken & | keyPath | ||
| ) |
Remove the field at path and fieldName and keyPath, if one exists. The keyPath is a ':'-separated path addressing an element in sub-dictionaries.
| SDF_API bool SdfLayer::Export | ( | const std::string & | filename, |
| const std::string & | comment = std::string(), |
||
| const FileFormatArguments & | args = FileFormatArguments() |
||
| ) | const |
Exports this layer to a file. Returns true if successful, false if an error occurred.
If comment is not empty, the layer gets exported with the given comment. Additional arguments may be supplied via the args parameter. These arguments may control behavior specific to the exported layer's file format.
Note that the file name or comment of the original layer is not updated. This only saves a copy of the layer to the given filename. Subsequent calls to Save() will still save the layer to it's previously remembered file name.
| SDF_API bool SdfLayer::ExportToString | ( | std::string * | result | ) | const |
Writes this layer to the given string.
Returns true if successful and sets result, otherwise returns false.
|
static |
Return an existing layer with the given identifier and args. If the layer can't be found, an error is posted and a null layer is returned.
Arguments in args will override any arguments specified in identifier.
|
static |
Return an existing layer with the given identifier and args, or else load it. If the layer can't be found or loaded, an error is posted and a null layer is returned.
Arguments in args will override any arguments specified in identifier.
|
static |
Return an existing layer with the given identifier and args, or else load it. The given identifier will be resolved relative to the anchor layer. If the layer can't be found or loaded, an error is posted and a null layer is returned.
If the anchor layer is invalid, issues a coding error and returns a null handle.
Arguments in args will override any arguments specified in identifier.
|
static |
Return an existing layer with the given identifier and args. The given identifier will be resolved relative to the anchor layer. If the layer can't be found, an error is posted and a null layer is returned.
If the anchor layer is invalid, a coding error is raised, and a null handle is returned.
Arguments in args will override any arguments specified in identifier.
Returns resolve information from the last time the layer identifier was resolved.
| SDF_API const std::string& SdfLayer::GetAssetName | ( | ) | const |
Returns the asset name associated with this layer.
Returns an attribute at the given path.
Returns NULL if there is no attribute at path. This is simply a more specifically typed version of GetObjectAtPath().
| SDF_API bool SdfLayer::GetBracketingTimeSamples | ( | double | time, |
| double * | tLower, | ||
| double * | tUpper | ||
| ) |
| SDF_API bool SdfLayer::GetBracketingTimeSamplesForPath | ( | const SdfPath & | path, |
| double | time, | ||
| double * | tLower, | ||
| double * | tUpper | ||
| ) |
| SDF_API SdfAssetPath SdfLayer::GetColorConfiguration | ( | ) | const |
Returns the color configuration asset-path for this layer.
The default value is an empty asset-path.
Returns the color management system used to interpret the color configuration asset-path authored in this layer.
The default value is an empty token, which implies that the clients will have to determine the color management system from the color configuration asset path (i.e. from its file extension), if it's specified.
| SDF_API std::string SdfLayer::GetComment | ( | ) | const |
Returns the comment string for this layer.
The default value for comment is "".
| SDF_API std::set<std::string> SdfLayer::GetCompositionAssetDependencies | ( | ) | const |
Return paths of all assets this layer depends on due to composition fields.
This includes the paths of all layers referred to by reference, payload, and sublayer fields in this layer. This function only returns direct composition dependencies of this layer, i.e. it does not recurse to find composition dependencies from its dependent layer assets.
| SDF_API VtDictionary SdfLayer::GetCustomLayerData | ( | ) | const |
Returns the CustomLayerData dictionary associated with this layer.
This is a dictionary is custom metadata that is associated with this layer. It allows users to encode any set of information for human or program consumption.
Return the defaultPrim metadata for this layer. This field indicates the name of which root prim should be targeted by a reference or payload to this layer that doesn't specify a prim path.
The default value is the empty token.
|
static |
Returns the current rules for the detached layer set.
| SDF_API std::string SdfLayer::GetDisplayName | ( | ) | const |
Returns the layer's display name.
The display name is the base filename of the identifier.
|
static |
Returns the display name for the given identifier, using the same rules as GetDisplayName.
| SDF_API std::string SdfLayer::GetDocumentation | ( | ) | const |
Returns the documentation string for this layer.
The default value for documentation is "".
| SDF_API double SdfLayer::GetEndTimeCode | ( | ) | const |
Returns the layer's end timeCode. The start and end timeCode of a layer represent a suggested playback range. However, time-varying content is not limited to the timeCode range of the layer.
The default value for endTimeCode is 0.
| SDF_API VtDictionary SdfLayer::GetExpressionVariables | ( | ) | const |
Returns the expression variables dictionary authored on this layer. See Sdf_Page_VariableExpressions for more details.
| SDF_API std::set<std::string> SdfLayer::GetExternalAssetDependencies | ( | ) | const |
Returns a set of resolved paths to all external asset dependencies the layer needs to generate its contents. These are additional asset dependencies that are determined by the layer's file format and will be consulted during Reload() when determining if the layer needs to be reloaded. This specifically does not include dependencies related to composition, i.e. this will not include assets from references, payloads, and sublayers.
| SDF_API std::set<std::string> SdfLayer::GetExternalReferences | ( | ) | const |
Return the value for the given path and fieldName. Returns an empty value if none is set.
| SDF_API VtValue SdfLayer::GetFieldDictValueByKey | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const TfToken & | keyPath | ||
| ) | const |
Return the value for the given path and fieldName at keyPath. Returns an empty value if none is set. The keyPath is a ':'-separated path addressing an element in sub-dictionaries.
| SDF_API std::string SdfLayer::GetFileExtension | ( | ) | const |
Returns the file extension to use for this layer. If this layer was loaded from disk, it should match the extension of the file format it was loaded as; if this is an anonymous in-memory layer it will be the default extension.
| SDF_API const SdfFileFormatConstPtr& SdfLayer::GetFileFormat | ( | ) | const |
Returns the file format used by this layer.
| SDF_API const FileFormatArguments& SdfLayer::GetFileFormatArguments | ( | ) | const |
Returns the file format-specific arguments used during the construction of this layer.
| SDF_API double SdfLayer::GetFramesPerSecond | ( | ) | const |
Returns the layer's frames per second.
This makes an advisory statement about how the contained data can be most usefully consumed and presented. It's primarily an indication of the expected playback rate for the data, but a timeline editing tool might also want to use this to decide how to scale and label its timeline.
The default value for framesPerSecond is 24.
| SDF_API bool SdfLayer::GetHasOwnedSubLayers | ( | ) | const |
Returns true if the layer's sublayers are expected to have owners.
| SDF_API SdfLayerHints SdfLayer::GetHints | ( | ) | const |
Return hints about the layer's current contents. Any operation that dirties the layer will invalidate all hints.
| SDF_API const std::string& SdfLayer::GetIdentifier | ( | ) | const |
Returns the layer identifier.
|
static |
Returns handles for all layers currently held by the layer registry.
| SDF_API SdfDataRefPtr SdfLayer::GetMetadata | ( | ) | const |
Returns the data from the absolute root path of this layer.
|
static |
Returns the set of muted layer paths.
| SDF_API size_t SdfLayer::GetNumSubLayerPaths | ( | ) | const |
Returns the number of sublayer paths (and offsets).
Returns the object at the given path.
There is no distinction between an absolute and relative path at the SdLayer level.
Returns NULL if there is no object at path.
| SDF_API std::string SdfLayer::GetOwner | ( | ) | const |
Returns the layer's owner.
Returns the prim at the given path.
Returns NULL if there is no prim at path. This is simply a more specifically typed version of GetObjectAtPath().
Returns a property at the given path.
Returns NULL if there is no property at path. This is simply a more specifically typed version of GetObjectAtPath().
| SDF_API SdfPrimSpecHandle SdfLayer::GetPseudoRoot | ( | ) | const |
Returns the layer's pseudo-root prim.
The layer's root prims are namespace children of the pseudo-root. The pseudo-root exists to make the namespace hierarchy a tree instead of a forest. This simplifies the implementation of some algorithms.
A layer always has a pseudo-root prim.
| SDF_API const std::string& SdfLayer::GetRealPath | ( | ) | const |
Returns the resolved path for this layer. This is equivalent to GetResolvedPath().GetPathString().
Returns a relationship at the given path.
Returns NULL if there is no relationship at path. This is simply a more specifically typed version of GetObjectAtPath().
| SDF_API const std::string& SdfLayer::GetRepositoryPath | ( | ) | const |
Returns the layer identifier in asset path form. In the presence of a properly configured path resolver, the asset path is a double-slash prefixed depot path. If the path resolver is not configured, the asset path of a layer is empty.
| SDF_API const ArResolvedPath& SdfLayer::GetResolvedPath | ( | ) | const |
Returns the resolved path for this layer. This is the path where this layer exists or may exist after a call to Save().
| SDF_API SdfNameOrderProxy SdfLayer::GetRootPrimOrder | ( | ) | const |
Returns the list of prim names for this layer's reorder rootPrims statement.
See SetRootPrimOrder() for more info.
| SDF_API RootPrimsView SdfLayer::GetRootPrims | ( | ) | const |
Returns a vector of the layer's root prims.
| SDF_API const SdfSchemaBase& SdfLayer::GetSchema | ( | ) | const |
Returns the schema this layer adheres to. This schema provides details about the scene description that may be authored in this layer.
| SDF_API std::string SdfLayer::GetSessionOwner | ( | ) | const |
Returns the layer's session owner. Note: This should only be used by session layers.
| SDF_API SdfSpecType SdfLayer::GetSpecType | ( | const SdfPath & | path | ) | const |
Return the spec type for path. This returns SdfSpecTypeUnknown if no spec exists at path.
| SDF_API double SdfLayer::GetStartTimeCode | ( | ) | const |
Returns the layer's start timeCode.
The start and end timeCodes of a layer represent the suggested playback range. However, time-varying content is not limited to the timeCode range of the layer.
The default value for startTimeCode is 0.
| SDF_API SdfLayerStateDelegateBasePtr SdfLayer::GetStateDelegate | ( | ) | const |
Returns the state delegate used to manage this layer's authoring state.
| SDF_API SdfLayerOffset SdfLayer::GetSubLayerOffset | ( | int | index | ) | const |
Returns the layer offset for the subLayer path at the given index.
| SDF_API SdfLayerOffsetVector SdfLayer::GetSubLayerOffsets | ( | ) | const |
Returns the layer offsets for all the subLayer paths.
| SDF_API SdfSubLayerProxy SdfLayer::GetSubLayerPaths | ( | ) | const |
Returns a proxy for this layer's sublayers.
Sub-layers are the weaker layers directly included by this layer. They're in order from strongest to weakest and they're all weaker than this layer.
Edits through the proxy changes the sublayers. If this layer does not have any sublayers the proxy is empty.
Sub-layer paths are asset paths, and thus must contain valid asset path characters (UTF-8 without C0 and C1 controls). See SdfAssetPath for more details.
| SDF_API double SdfLayer::GetTimeCodesPerSecond | ( | ) | const |
Returns the layer's timeCodes per second.
Scales the time ordinate for samples contained in the file to seconds. If timeCodesPerSecond is 24, then a sample at time ordinate 24 should be viewed exactly one second after the sample at time ordinate 0.
If this layer doesn't have an authored value for timeCodesPerSecond, but it does have an authored value for framesPerSecond, this method will return the value of framesPerSecond. This "dynamic fallback" allows layers to lock framesPerSecond and timeCodesPerSecond to the same value by specifying only framesPerSecond.
The default value of timeCodesPerSecond, used only if there is no authored value for either timeCodesPerSecond or framesPerSecond, is 24.
| SDF_API const std::string& SdfLayer::GetVersion | ( | ) | const |
Returns the asset system version of this layer. If a layer is loaded from a location that is not version managed, or a configured asset system is not present when the layer is loaded or created, the version is empty. By default, asset version tracking is disabled; this method returns empty unless asset version tracking is enabled.
| SDF_API bool SdfLayer::HasColorConfiguration | ( | ) | const |
Returns true if color configuration metadata is set in this layer.
| SDF_API bool SdfLayer::HasColorManagementSystem | ( | ) | const |
Returns true if colorManagementSystem metadata is set in this layer.
| SDF_API bool SdfLayer::HasCustomLayerData | ( | ) | const |
Returns true if CustomLayerData is authored on the layer.
| SDF_API bool SdfLayer::HasDefaultPrim | ( | ) |
Return true if the default prim metadata is set in this layer. See GetDefaultPrim() and SetDefaultPrim().
| SDF_API bool SdfLayer::HasEndTimeCode | ( | ) | const |
Returns true if the layer has an endTimeCode opinion.
| SDF_API bool SdfLayer::HasExpressionVariables | ( | ) | const |
Returns true if expression variables are authored on this layer.
| SDF_API bool SdfLayer::HasField | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| VtValue * | value = NULL |
||
| ) | const |
Return whether a value exists for the given path and fieldName. Optionally returns the value if it exists.
| SDF_API bool SdfLayer::HasField | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| SdfAbstractDataValue * | value | ||
| ) | const |
Return the spec type for path. This returns SdfSpecTypeUnknown if no spec exists at path.
| SDF_API bool SdfLayer::HasFieldDictKey | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const TfToken & | keyPath, | ||
| VtValue * | value = NULL |
||
| ) | const |
Return whether a value exists for the given path and fieldName and keyPath. The keyPath is a ':'-separated path addressing an element in sub-dictionaries. Optionally returns the value if it exists.
| SDF_API bool SdfLayer::HasFieldDictKey | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const TfToken & | keyPath, | ||
| SdfAbstractDataValue * | value | ||
| ) | const |
Return the spec type for path. This returns SdfSpecTypeUnknown if no spec exists at path.
| SDF_API bool SdfLayer::HasFramePrecision | ( | ) | const |
Returns true if the layer has a frames precision opinion.
| SDF_API bool SdfLayer::HasFramesPerSecond | ( | ) | const |
Returns true if the layer has a frames per second opinion.
| SDF_API bool SdfLayer::HasOwner | ( | ) | const |
Returns true if the layer has an owner opinion.
| SDF_API bool SdfLayer::HasSessionOwner | ( | ) | const |
Returns true if the layer has a session owner opinion.
| SDF_API bool SdfLayer::HasStartTimeCode | ( | ) | const |
Returns true if the layer has a startTimeCode opinion.
| SDF_API bool SdfLayer::HasTimeCodesPerSecond | ( | ) | const |
Returns true if the layer has a timeCodesPerSecond opinion.
| SDF_API bool SdfLayer::Import | ( | const std::string & | layerPath | ) |
Imports the content of the given layer path, replacing the content of the current layer. Note: If the layer path is the same as the current layer's real path, no action is taken (and a warning occurs). For this case use Reload().
| SDF_API bool SdfLayer::ImportFromString | ( | const std::string & | string | ) |
Reads this layer from the given string.
Returns true if successful, otherwise returns false.
Adds a new root prim name in the root prim order. If the index is -1, the name is inserted at the end.
Adds a new root prim at the given index. If the index is -1, the prim is inserted at the end. The layer will take ownership of the prim, via a TfRefPtr. Returns true if successful, false if failed (for example, due to a duplicate name).
| SDF_API void SdfLayer::InsertSubLayerPath | ( | const std::string & | path, |
| int | index = -1 |
||
| ) |
Inserts new sublayer path at the given index.
The default index of -1 means to insert at the end.
| SDF_API bool SdfLayer::IsAnonymous | ( | ) | const |
Returns true if this layer is an anonymous layer.
|
static |
Returns true if the identifier is an anonymous layer unique identifier.
| SDF_API bool SdfLayer::IsDetached | ( | ) | const |
Returns true if this layer is detached from its serialized data store, false otherwise.
Detached layers are isolated from external changes to their serialized data.
| SDF_API bool SdfLayer::IsDirty | ( | ) | const |
Returns true if the layer is dirty, i.e. has changed from its persistent representation.
| SDF_API bool SdfLayer::IsEmpty | ( | ) | const |
Returns whether this layer has no significant data.
|
static |
Returns whether the given layer identifier is included in the current rules for the detached layer set. This is equivalent to GetDetachedLayerRules().IsIncluded(identifier).
| SDF_API bool SdfLayer::IsMuted | ( | ) | const |
Returns true if the current layer is muted.
|
static |
Returns true if the specified layer path is muted.
| SDF_API std::set<double> SdfLayer::ListAllTimeSamples | ( | ) | const |
Return the names of all the fields that are set at path.
|
static |
Creates a new empty layer with the given identifier for a given file format class.
The new layer will not be dirty and will not be saved.
Additional arguments may be supplied via the args parameter. These arguments may control behavior specific to the layer's file format.
|
static |
Load the given layer from disk as a new anonymous layer. If the layer can't be found or loaded, an error is posted and a null layer is returned.
The anonymous layer does not retain any knowledge of the backing file on the filesystem.
metadataOnly is a flag that asks for only the layer metadata to be read in, which can be much faster if that is all that is required. Note that this is just a hint: some FileFormat readers may disregard this flag and still fully populate the layer contents.
An optional tag may be specified. See CreateAnonymous for details.
| SDF_API bool SdfLayer::PermissionToEdit | ( | ) | const |
Returns true if the caller is allowed to modify the layer and false otherwise. A layer may have to perform some action to acquire permission to be edited.
| SDF_API bool SdfLayer::PermissionToSave | ( | ) | const |
Returns true if the caller is allowed to save the layer to its existing fileName and false otherwise.
| SDF_API bool SdfLayer::QueryTimeSample | ( | const SdfPath & | path, |
| double | time, | ||
| VtValue * | value = NULL |
||
| ) | const |
| SDF_API bool SdfLayer::QueryTimeSample | ( | const SdfPath & | path, |
| double | time, | ||
| SdfAbstractDataValue * | value | ||
| ) | const |
| SDF_API bool SdfLayer::Reload | ( | bool | force = false | ) |
Reloads the layer from its persistent representation.
This restores the layer to a state as if it had just been created with FindOrOpen(). This operation is Undo-able.
The fileName and whether journaling is enabled are not affected by this method.
When called with force = false (the default), Reload attempts to avoid reloading layers that have not changed on disk. It does so by comparing the file's modification time (mtime) to when the file was loaded. If the layer has unsaved modifications, this mechanism is not used, and the layer is reloaded from disk. If the layer has any external asset dependencies their modification state will also be consulted when determining if the layer needs to be reloaded.
Passing true to the force parameter overrides this behavior, forcing the layer to be reloaded from disk regardless of whether it has changed.
|
static |
Reloads the specified layers.
Returns false if one or more layers failed to reload.
See Reload() for a description of the force flag.
|
static |
Remove the specified path from the muted layers set.
Removes a root prim name from the root prim order.
Removes a root prim name from the root prim order by index.
Removes all scene description in this layer that does not affect the scene.
This method walks the layer namespace hierarchy and removes any prims and that are not contributing any opinions.
Removes scene description that does not affect the scene in the layer namespace beginning with prim.
Calling this method on a prim will only clean up prims with specifier 'over' that are not contributing any opinions. The prim will only be removed if all of its nameChildren are also inert. The hierarchy prim is defined in will be pruned up to the layer root for each successive inert parent that has specifier 'over'.
note: PrimSpecs that contain any PropertySpecs, even PropertySpecs with required fields only (see PropertySpec::HasRequiredFieldsOnly) are not considered inert, and thus the prim won't be removed.
Removes prop if it has only required fields (i.e. is not contributing any opinions to the scene other than property instantiation).
The hierarchy prop is defined in will then be pruned up to the layer root for each successive inert parent.
| SDF_API bool SdfLayer::Save | ( | bool | force = false | ) | const |
Returns true if successful, false if an error occurred. Returns false if the layer has no remembered file name or the layer type cannot be saved. The layer will not be overwritten if the file exists and the layer is not dirty unless force is true.
Cause spec to be removed if it no longer affects the scene when the last change block is closed, or now if there are no change blocks.
| SDF_API void SdfLayer::SetColorConfiguration | ( | const SdfAssetPath & | colorConfiguration | ) |
Sets the color configuration asset-path for this layer.
Sets the color management system used to interpret the color configuration asset-path authored this layer.
| SDF_API void SdfLayer::SetComment | ( | const std::string & | comment | ) |
Sets the comment string for this layer.
| SDF_API void SdfLayer::SetCustomLayerData | ( | const VtDictionary & | value | ) |
Sets the CustomLayerData dictionary associated with this layer.
Set the default prim metadata for this layer. The root prim with this name will be targeted by a reference or a payload to this layer that doesn't specify a prim path. Note that this must be a root prim name not a path. E.g. "rootPrim" rather than "/rootPrim". See GetDefaultPrim().
|
static |
Sets the rules specifying detached layers.
Newly-created or opened layers whose identifiers are included in rules will be opened as detached layers. Existing layers that are now included or no longer included will be reloaded. Any unsaved modifications to those layers will be lost.
This function is not thread-safe. It may not be run concurrently with any other functions that open, close, or read from any layers.
The detached layer rules are initially set to exclude all layers. This may be overridden by setting the environment variables SDF_LAYER_INCLUDE_DETACHED and SDF_LAYER_EXCLUDE_DETACHED to specify the initial set of include and exclude patterns in the rules. These variables can be set to a comma-delimited list of patterns. SDF_LAYER_INCLUDE_DETACHED may also be set to "*" to include all layers. Note that these environment variables only set the initial state of the detached layer rules; these values may be overwritten by subsequent calls to this function.
See SdfLayer::DetachedLayerRules::IsIncluded for details on how the rules are applied to layer identifiers.
| SDF_API void SdfLayer::SetDocumentation | ( | const std::string & | documentation | ) |
Sets the documentation string for this layer.
| SDF_API void SdfLayer::SetExpressionVariables | ( | const VtDictionary & | expressionVars | ) |
Sets the expression variables dictionary for this layer.
| SDF_API void SdfLayer::SetField | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const VtValue & | value | ||
| ) |
Set the value of the given path and fieldName.
| SDF_API void SdfLayer::SetField | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const SdfAbstractDataConstValue & | value | ||
| ) |
Return the spec type for path. This returns SdfSpecTypeUnknown if no spec exists at path.
| SDF_API void SdfLayer::SetFieldDictValueByKey | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const TfToken & | keyPath, | ||
| const VtValue & | value | ||
| ) |
Set the value of the given path and fieldName. The keyPath is a ':'-separated path addressing an element in sub-dictionaries.
| SDF_API void SdfLayer::SetFieldDictValueByKey | ( | const SdfPath & | path, |
| const TfToken & | fieldName, | ||
| const TfToken & | keyPath, | ||
| const SdfAbstractDataConstValue & | value | ||
| ) |
Return the spec type for path. This returns SdfSpecTypeUnknown if no spec exists at path.
Sets the layer's frames per second.
Sets whether the layer's sublayers are expected to have owners.
| SDF_API void SdfLayer::SetIdentifier | ( | const std::string & | identifier | ) |
Sets the layer identifier. Note that the new identifier must have the same arguments (if any) as the old identifier.
Mutes the current layer if muted is true, and unmutes it otherwise.
| SDF_API void SdfLayer::SetOwner | ( | const std::string & | owner | ) |
Sets the layer's owner.
Given a list of (possible sparse) prim names, authors a reorder rootPrims statement for this prim.
This reorder statement can modify the order of root prims that have already been explicitly ordered with InsertRootPrim() or SetRootPrims(); but only during composition. Therefore, GetRootPrims(), InsertRootPrim(), SetRootPrims(), etc. do not read, author, or pay any attention to this statement.
Sets a new vector of root prims. You can re-order, insert and remove prims but cannot rename them this way. If any of the listed prims have an existing owner, they will be reparented.
| SDF_API void SdfLayer::SetSessionOwner | ( | const std::string & | owner | ) |
Sets the layer's session owner. Note: This should only be used by session layers.
Sets the state delegate used to manage this layer's authoring state. The 'dirty' state of this layer will be transferred to the new delegate.
| SDF_API void SdfLayer::SetSubLayerOffset | ( | const SdfLayerOffset & | offset, |
| int | index | ||
| ) |
Sets the layer offset for the subLayer path at the given index.
| SDF_API void SdfLayer::SetSubLayerPaths | ( | const std::vector< std::string > & | newPaths | ) |
Sets the paths of the layer's sublayers.
Sets the layer's timeCodes per second.
| SDF_API void SdfLayer::SetTimeSample | ( | const SdfPath & | path, |
| double | time, | ||
| const SdfAbstractDataConstValue & | value | ||
| ) |
|
static |
Splits the given layer identifier into its constituent layer path and arguments.
| SDF_API bool SdfLayer::StreamsData | ( | ) | const |
Returns true if this layer streams data from its serialized data store on demand, false otherwise.
Layers with streaming data are treated differently to avoid pulling in data unnecessarily. For example, reloading a streaming layer will not perform fine-grained change notification, since doing so would require the full contents of the layer to be loaded.
Copies the content of the given layer into this layer. Source layer is unmodified.
| SDF_API void SdfLayer::Traverse | ( | const SdfPath & | path, |
| const TraversalFunction & | func | ||
| ) |
Callback function for Traverse. This callback will be invoked with the path of each spec that is visited.
Update layer asset information. Calling this method re-resolves the layer identifier, which updates asset information such as the layer's resolved path and other asset info. This may be used to update the layer after external changes to the underlying asset system.
| SDF_API bool SdfLayer::UpdateCompositionAssetDependency | ( | const std::string & | oldAssetPath, |
| const std::string & | newAssetPath = std::string() |
||
| ) |
Updates the asset path of a composation dependency in this layer.
If newAssetPath is supplied, the update works as "rename", updating any occurrence of oldAssetPath to newAssetPath in all reference, payload, and sublayer fields.
If newAssetPath is not given, this update behaves as a "delete", removing all occurrences of oldAssetPath from all reference, payload, and sublayer fields.
| SDF_API bool SdfLayer::UpdateExternalReference | ( | const std::string & | oldAssetPath, |
| const std::string & | newAssetPath = std::string() |
||
| ) |
| SDF_API bool SdfLayer::WriteDataFile | ( | const std::string & | filename | ) |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
1.8.6 
