HDK
|
#include <usdzFileFormat.h>
Public Types | |
typedef std::map< std::string, std::string > | FileFormatArguments |
Public Types inherited from SdfFileFormat | |
typedef std::map< std::string, std::string > | FileFormatArguments |
Public Types inherited from TfRefBase | |
typedef void(* | UniqueChangedFuncPtr )(TfRefBase const *, bool) |
Protected Member Functions | |
bool | _ReadDetached (SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const override |
Protected Member Functions inherited from SdfFileFormat | |
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) |
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) |
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 |
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 | _ShouldSkipAnonymousReload () const |
virtual SDF_API bool | _ShouldReadAnonymousLayers () const |
virtual SDF_API SdfAbstractDataRefPtr | _InitDetachedData (const FileFormatArguments &args) const |
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 |
Protected Attributes | |
SDF_FILE_FORMAT_FACTORY_ACCESS | |
File format for package .usdz files.
Definition at line 49 of file usdzFileFormat.h.
typedef std::map<std::string, std::string> SdfFileFormat::FileFormatArguments |
Type for specifying additional file format-specific arguments to the various API below.
Definition at line 119 of file fileFormat.h.
|
overrideprotectedvirtual |
Upon completion, layer
must have an SdfAbstractData object set that is detached, i.e. SdfAbstractData::IsDetached returns false.
The default implementation calls _ReadAndCopyLayerDataToMemory to read the specified layer and copy its data into an SdfData object if it is not detached. If data is copied, a warning will be issued since this may be an expensive operation. If the above behavior is desired, subclasses can just call _ReadAndCopyLayerDataToMemory to do the same thing but without the warning.
Reimplemented from SdfFileFormat.
|
overridevirtual |
Returns true if file
can be read by this format.
Implements SdfFileFormat.
|
overridevirtual |
Returns the path of the "root" layer contained in the package layer at resolvedPath
produced by this file format. If this file format is not a package, returns the empty string.
The package root layer is the layer in the package layer that is used when that package is opened via SdfLayer.
Reimplemented from SdfFileFormat.
|
overridevirtual |
This method allows the file format to bind to whatever data container is appropriate.
Returns a shared pointer to an SdfAbstractData implementation.
Reimplemented from SdfFileFormat.
|
overridevirtual |
Returns true if this file format is a package containing other assets.
Reimplemented from SdfFileFormat.
|
overridevirtual |
Reads scene description from the asset specified by resolvedPath
into the layer layer
.
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.
Returns true if the asset is successfully read into layer
, false otherwise.
Implements SdfFileFormat.
|
overridevirtual |
Reads data in the string str
into the layer layer
. If the file is successfully read, this method returns true. Otherwise, false is returned and errors are posted.
Reimplemented from SdfFileFormat.
|
overridevirtual |
Writes the content in layer
into the file at filePath
. If the content is successfully written, this method returns true. Otherwise, false is returned and errors are posted. The default implementation returns false.
Reimplemented from SdfFileFormat.
|
overridevirtual |
Write the provided spec
to out
indented indent
levels.
Reimplemented from SdfFileFormat.
|
overridevirtual |
Writes the content in layer
to the string str
. This function should write a textual representation of layer
to the stream that can be read back in via ReadFromString.
Reimplemented from SdfFileFormat.
|
protected |
Definition at line 99 of file usdzFileFormat.h.