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

#include <usdcFileFormat.h>

+ Inheritance diagram for UsdUsdcFileFormat:

Public Types

using string = std::string
 
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)
 

Public Member Functions

virtual SdfAbstractDataRefPtr InitData (const FileFormatArguments &args) const override
 
virtual bool CanRead (const string &file) const override
 Returns true if file can be read by this format. More...
 
virtual bool Read (SdfLayer *layer, const string &resolvedPath, bool metadataOnly) const override
 
virtual bool WriteToFile (const SdfLayer &layer, const string &filePath, const string &comment=string(), const FileFormatArguments &args=FileFormatArguments()) const override
 
virtual bool ReadFromString (SdfLayer *layer, const string &str) const override
 
virtual bool WriteToString (const SdfLayer &layer, string *str, const string &comment=string()) const override
 
virtual 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
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
 
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 LayersAreFileBased () const
 
- Public Member Functions inherited from TfRefBase
 TfRefBase ()
 
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 TfRefCountGetRefCount () const
 
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 constGetUniqueIdentifier () const
 

Protected Member Functions

 UsdUsdcFileFormat ()
 
virtual ~UsdUsdcFileFormat ()
 
- 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...
 
- 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
 

Additional Inherited Members

- 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
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)
 
- Static Protected Member Functions inherited from SdfFileFormat
static SDF_API void _SetLayerData (SdfLayer *layer, SdfAbstractDataRefPtr &data)
 
static SDF_API
SdfAbstractDataConstPtr 
_GetLayerData (const SdfLayer &layer)
 Get the internal data for layer. More...
 

Detailed Description

File format for binary Usd files.

Definition at line 46 of file usdcFileFormat.h.

Member Typedef Documentation

Type for specifying additional file format-specific arguments to the various API below.

Definition at line 113 of file fileFormat.h.

using UsdUsdcFileFormat::string = std::string

Definition at line 50 of file usdcFileFormat.h.

Constructor & Destructor Documentation

UsdUsdcFileFormat::UsdUsdcFileFormat ( )
protected
virtual UsdUsdcFileFormat::~UsdUsdcFileFormat ( )
protectedvirtual

Member Function Documentation

virtual bool UsdUsdcFileFormat::CanRead ( const string file) const
overridevirtual

Returns true if file can be read by this format.

Implements SdfFileFormat.

virtual SdfAbstractDataRefPtr UsdUsdcFileFormat::InitData ( const FileFormatArguments args) const
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.

virtual bool UsdUsdcFileFormat::Read ( SdfLayer layer,
const string resolvedPath,
bool  metadataOnly 
) const
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.

virtual bool UsdUsdcFileFormat::ReadFromString ( SdfLayer layer,
const string str 
) const
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.

virtual bool UsdUsdcFileFormat::WriteToFile ( const SdfLayer layer,
const string filePath,
const string comment = string(),
const FileFormatArguments args = FileFormatArguments() 
) const
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.

virtual bool UsdUsdcFileFormat::WriteToStream ( const SdfSpecHandle &  spec,
std::ostream &  out,
size_t  indent 
) const
overridevirtual

Write the provided spec to out indented indent levels.

Reimplemented from SdfFileFormat.

virtual bool UsdUsdcFileFormat::WriteToString ( const SdfLayer layer,
string str,
const string comment = string() 
) const
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.

Member Data Documentation

UsdUsdcFileFormat::SDF_FILE_FORMAT_FACTORY_ACCESS
protected

Definition at line 80 of file usdcFileFormat.h.


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