HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdUsdaFileFormat Class Reference

#include <usdaFileFormat.h>

+ Inheritance diagram for UsdUsdaFileFormat:

Friends

class UsdUsdFileFormat
 

Additional Inherited Members

- Public Types inherited from SdfFileFormat
typedef std::map< std::string,
std::string
FileFormatArguments
 
- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr )(TfRefBase const *, bool)
 
- Public Member Functions inherited from SdfTextFileFormat
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
 
virtual SDF_API bool WriteToFile (const SdfLayer &layer, const std::string &filePath, const std::string &comment=std::string(), const FileFormatArguments &args=FileFormatArguments()) const override
 
virtual SDF_API bool ReadFromString (SdfLayer *layer, const std::string &str) const override
 
virtual SDF_API bool WriteToString (const SdfLayer &layer, std::string *str, const std::string &comment=std::string()) const override
 
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...
 
- Public Member Functions inherited from SdfFileFormat
 SdfFileFormat (const SdfFileFormat &)=delete
 
SdfFileFormatoperator= (const SdfFileFormat &)=delete
 
SDF_API const SdfSchemaBaseGetSchema () const
 Returns the schema for this format. More...
 
SDF_API const TfTokenGetFormatId () const
 Returns the format identifier. More...
 
SDF_API const TfTokenGetTarget () const
 Returns the target for this file format. More...
 
SDF_API const std::stringGetFileCookie () const
 Returns the cookie to be used when writing files with this format. More...
 
SDF_API const TfTokenGetVersionString () const
 Returns the current version of this file format. More...
 
SDF_API bool IsPrimaryFormatForExtensions () const
 
SDF_API const std::vector
< std::string > & 
GetFileExtensions () const
 Returns a list of extensions that this format supports. More...
 
SDF_API const std::stringGetPrimaryFileExtension () const
 
SDF_API bool IsSupportedExtension (const std::string &extension) const
 
virtual SDF_API bool IsPackage () const
 
virtual SDF_API std::string GetPackageRootLayerPath (const std::string &resolvedPath) const
 
virtual SDF_API FileFormatArguments GetDefaultFileFormatArguments () const
 
virtual SDF_API
SdfAbstractDataRefPtr 
InitData (const FileFormatArguments &args) const
 
SDF_API SdfAbstractDataRefPtr InitDetachedData (const FileFormatArguments &args) const
 
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
 
SDF_API bool ShouldReadAnonymousLayers () const
 
SDF_API bool ReadDetached (SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) const
 
virtual SDF_API std::set
< std::string
GetExternalAssetDependencies (const SdfLayer &layer) const
 
SDF_API bool SupportsReading () const
 
SDF_API bool SupportsWriting () const
 
SDF_API bool SupportsEditing () const
 
- Public Member Functions inherited from TfRefBase
 TfRefBase ()
 
 TfRefBase (TfRefBase const &)
 
TfRefBaseoperator= (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 TfWeakBaseoperator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 
- Static Public Member Functions inherited from SdfFileFormat
static SDF_API std::string GetFileExtension (const std::string &s)
 
static SDF_API std::set
< std::string
FindAllFileFormatExtensions ()
 
static SDF_API std::set
< std::string
FindAllDerivedFileFormatExtensions (const TfType &baseType)
 
static SDF_API bool FormatSupportsReading (const std::string &extension, const std::string &target=std::string())
 
static SDF_API bool FormatSupportsWriting (const std::string &extension, const std::string &target=std::string())
 
static SDF_API bool FormatSupportsEditing (const std::string &extension, const std::string &target=std::string())
 
static SDF_API
SdfFileFormatConstPtr 
FindById (const TfToken &formatId)
 
static SDF_API
SdfFileFormatConstPtr 
FindByExtension (const std::string &path, const std::string &target=std::string())
 
static SDF_API
SdfFileFormatConstPtr 
FindByExtension (const std::string &path, const FileFormatArguments &args)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 
- Protected Member Functions inherited from SdfTextFileFormat
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())
 
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...
 
- 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 _ShouldReadAnonymousLayers () const
 
virtual SDF_API
SdfAbstractDataRefPtr 
_InitDetachedData (const FileFormatArguments &args) const
 
virtual SDF_API bool _ReadDetached (SdfLayer *layer, const std::string &resolvedPath, bool metadataOnly) 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
 
- Static Protected Member Functions inherited from SdfFileFormat
static SDF_API void _SetLayerData (SdfLayer *layer, SdfAbstractDataRefPtr &data)
 
static SDF_API void _SetLayerData (SdfLayer *layer, SdfAbstractDataRefPtr &data, SdfLayerHints hints)
 
static SDF_API
SdfAbstractDataConstPtr 
_GetLayerData (const SdfLayer &layer)
 Get the internal data for layer. More...
 
- Protected Attributes inherited from SdfTextFileFormat
 SDF_FILE_FORMAT_FACTORY_ACCESS
 

Detailed Description

File format used by textual USD files.

Definition at line 47 of file usdaFileFormat.h.

Friends And Related Function Documentation

friend class UsdUsdFileFormat
friend

Definition at line 55 of file usdaFileFormat.h.


The documentation for this class was generated from the following file: