|
virtual SDF_API bool | CanRead (const std::string &file) const override |
| Returns true if file can be read by this format. More...
|
|
virtual SDF_API bool | Read (SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const override |
| Reads scene description from the asset specified by resolvedPath into the layer layer . More...
|
|
virtual SDF_API bool | WriteToFile (const SdfLayer &layer, const std::string &filePath, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const override |
| Writes the content in layer into the file at filePath . More...
|
|
virtual SDF_API bool | ReadFromString (SdfLayer *layer, const std::string &str) const override |
| Reads data in the string str into the layer layer . More...
|
|
virtual SDF_API bool | WriteToString (const SdfLayer &layer, std::string *str, const std::string &comment=std::string()) const override |
| Writes the content in layer to the string str . More...
|
|
virtual SDF_API bool | WriteToStream (const SdfSpecHandle &spec, std::ostream &out, size_t indent) const override |
| Write the provided spec to out indented indent levels. More...
|
|
| SdfFileFormat (const SdfFileFormat &)=delete |
|
SdfFileFormat & | operator= (const SdfFileFormat &)=delete |
|
SDF_API const SdfSchemaBase & | GetSchema () const |
| Returns the schema for this format. More...
|
|
SDF_API const TfToken & | GetFormatId () const |
| Returns the format identifier. More...
|
|
SDF_API const TfToken & | GetTarget () const |
| Returns the target for this file format. More...
|
|
SDF_API const std::string & | GetFileCookie () const |
| Returns the cookie to be used when writing files with this format. More...
|
|
SDF_API const TfToken & | GetVersionString () const |
| Returns the current version of this file format. More...
|
|
SDF_API bool | IsPrimaryFormatForExtensions () const |
| Returns true if this file format is the primary format for the extensions it handles. More...
|
|
SDF_API const std::vector< std::string > & | GetFileExtensions () const |
| Returns a list of extensions that this format supports. More...
|
|
SDF_API const std::string & | GetPrimaryFileExtension () const |
| Returns the primary file extension for this format. More...
|
|
SDF_API bool | IsSupportedExtension (const std::string &extension) const |
| Returns true if extension matches one of the extensions returned by GetFileExtensions. More...
|
|
virtual SDF_API bool | IsPackage () const |
| Returns true if this file format is a package containing other assets. More...
|
|
virtual SDF_API std::string | GetPackageRootLayerPath (const std::string &resolvedPath) const |
| Returns the path of the "root" layer contained in the package layer at resolvedPath produced by this file format. More...
|
|
virtual SDF_API FileFormatArguments | GetDefaultFileFormatArguments () const |
| Returns the FileFormatArguments that correspond to the default behavior of this file format when no FileFormatArguments are passed to NewLayer or InitData. More...
|
|
virtual SDF_API SdfAbstractDataRefPtr | InitData (const FileFormatArguments &args) const |
| This method allows the file format to bind to whatever data container is appropriate. More...
|
|
SDF_API SdfAbstractDataRefPtr | InitDetachedData (const FileFormatArguments &args) const |
| Returns a new SdfAbstractData providing access to the layer's data. More...
|
|
SDF_API SdfLayerRefPtr | NewLayer (const SdfFileFormatConstPtr &fileFormat, const std::string &identifier, const std::string &realPath, const ArAssetInfo &assetInfo, const FileFormatArguments &args) const |
| Instantiate a layer. More...
|
|
SDF_API bool | ShouldSkipAnonymousReload () const |
| Return true if this file format prefers to skip reloading anonymous layers. More...
|
|
SDF_API bool | ShouldReadAnonymousLayers () const |
| Returns true if anonymous layer identifiers should be passed to Read when a layer is opened or reloaded. More...
|
|
SDF_API bool | ReadDetached (SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const |
| Reads scene description from the asset specified by resolvedPath into the detached layer layer . More...
|
|
virtual SDF_API std::set< std::string > | GetExternalAssetDependencies (const SdfLayer &layer) const |
| Returns the set of resolved paths to external asset file dependencies for the given layer . More...
|
|
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...
|
|
const TfRefCount & | GetRefCount () const |
|
void | SetShouldInvokeUniqueChangedListener (bool shouldCall) |
|
| TfWeakBase (const TfWeakBase &) |
|
const TfWeakBase & | __GetTfWeakBase__ () const |
|
const TfWeakBase & | operator= (const TfWeakBase &) |
|
void | EnableNotification2 () const |
|
TF_API void const * | GetUniqueIdentifier () const |
|
|
virtual SDF_API | ~SdfTextFileFormat () |
| Destructor. More...
|
|
SDF_API | SdfTextFileFormat () |
| Constructor. More...
|
|
SDF_API | SdfTextFileFormat (const TfToken &formatId, const TfToken &versionString=TfToken(), const TfToken &target=TfToken()) |
| Constructor. More...
|
|
SDF_API bool | _CanReadFromAsset (const std::string &resolvedPath, const std::shared_ptr< ArAsset > &asset) const |
| Return true if layer can be read from asset at resolvedPath . More...
|
|
SDF_API bool | _ReadFromAsset (SdfLayer *layer, const std::string &resolvedPath, const std::shared_ptr< ArAsset > &asset, bool metadataOnly) const |
| Read layer from asset at resolvedPath into layer . More...
|
|
SDF_API | SdfFileFormat (const TfToken &formatId, const TfToken &versionString, const TfToken &target, const std::string &extension) |
| Constructor. More...
|
|
SDF_API | SdfFileFormat (const TfToken &formatId, const TfToken &versionString, const TfToken &target, const std::string &extension, const SdfSchemaBase &schema) |
| Constructor. More...
|
|
| SdfFileFormat (const TfToken &formatId, const TfToken &versionString, const TfToken &target, const std::string &extension, const SdfSchemaBase &&schema)=delete |
| Disallow temporary SdfSchemaBase objects being passed to the c'tor. More...
|
|
SDF_API | SdfFileFormat (const TfToken &formatId, const TfToken &versionString, const TfToken &target, const std::vector< std::string > &extensions) |
| Constructor. More...
|
|
SDF_API | SdfFileFormat (const TfToken &formatId, const TfToken &versionString, const TfToken &target, const std::vector< std::string > &extensions, const SdfSchemaBase &schema) |
| Constructor. More...
|
|
| SdfFileFormat (const TfToken &formatId, const TfToken &versionString, const TfToken &target, const std::vector< std::string > &extensions, const SdfSchemaBase &&schema)=delete |
| Disallow temporary SdfSchemaBase objects being passed to the c'tor. More...
|
|
virtual SDF_API | ~SdfFileFormat () |
| Destructor. More...
|
|
SDF_API bool | _ReadAndCopyLayerDataToMemory (SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly, bool *didCopyData=nullptr) const |
| Helper function for _ReadDetached. More...
|
|
virtual SDF_API SdfLayer * | _InstantiateNewLayer (const SdfFileFormatConstPtr &fileFormat, const std::string &identifier, const std::string &realPath, const ArAssetInfo &assetInfo, const FileFormatArguments &args) const |
|
virtual SDF_API bool | _ShouldReadAnonymousLayers () const |
| File format subclasses may override this to specify whether Read should be called when creating, opening, or reloading an anonymous layer of this format. More...
|
|
virtual SDF_API SdfAbstractDataRefPtr | _InitDetachedData (const FileFormatArguments &args) const |
|
virtual SDF_API bool | _ReadDetached (SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const |
|
TfRefPtr< Tf_Remnant > | _Register () const |
|
template<class T > |
TfRefPtr< Tf_Remnant > | _Register (T *tempRmnt) const |
|
bool | _HasRemnant () const |
|
|
typedef std::map< std::string, std::string > | FileFormatArguments |
| Type for specifying additional file format-specific arguments to the various API below. More...
|
|
typedef void(* | UniqueChangedFuncPtr) (TfRefBase const *, bool) |
|
static SDF_API std::string | GetFileExtension (const std::string &s) |
| Returns the file extension for path or file name s , without the leading dot character. More...
|
|
static SDF_API std::set< std::string > | FindAllFileFormatExtensions () |
| Returns a set containing the extension(s) corresponding to all registered file formats. More...
|
|
static SDF_API SdfFileFormatConstPtr | FindById (const TfToken &formatId) |
| Returns the file format instance with the specified formatId identifier. More...
|
|
static SDF_API SdfFileFormatConstPtr | FindByExtension (const std::string &path, const std::string &target=std::string()) |
| Returns the file format instance that supports the extension for path . More...
|
|
static SDF_API SdfFileFormatConstPtr | FindByExtension (const std::string &path, const FileFormatArguments &args) |
| Returns a file format instance that supports the extension for path and whose target matches one of those specified by the given args . More...
|
|
static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
|
static SDF_API void | _SetLayerData (SdfLayer *layer, SdfAbstractDataRefPtr &data) |
| Set the internal data for layer to data , possibly transferring ownership of data . More...
|
|
static SDF_API void | _SetLayerData (SdfLayer *layer, SdfAbstractDataRefPtr &data, SdfLayerHints hints) |
| Set the internal data for layer to data , possibly transferring ownership of data . More...
|
|
static SDF_API SdfAbstractDataConstPtr | _GetLayerData (const SdfLayer &layer) |
| Get the internal data for layer . More...
|
|
Sdf text file format.
Definition at line 58 of file textFileFormat.h.