fileFormat.h File Reference

#include "pxr/pxr.h"
#include "pxr/usd/ar/ar.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/refBase.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"
#include "pxr/base/tf/weakBase.h"
#include <map>
#include <string>
#include <vector>

Include dependency graph for fileFormat.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	SdfFileFormat
class	Sdf_FileFormatFactoryBase
class	Sdf_FileFormatFactory< T >

Macros
#define	SDF_FILE_FORMAT_TOKENS   ((TargetArg, "target"))
#define	SDF_DEFINE_FILE_FORMAT(...)   SdfDefineFileFormat<__VA_ARGS__>()
#define	SDF_DEFINE_ABSTRACT_FILE_FORMAT(...)   SdfDefineAbstractFileFormat<__VA_ARGS__>()
#define	SDF_FILE_FORMAT_FACTORY_ACCESS   template<typename T> friend class Sdf_FileFormatFactory

Functions
	SDF_DECLARE_HANDLES (SdfLayer)
	SDF_DECLARE_HANDLES (SdfSpec)
	TF_DECLARE_WEAK_AND_REF_PTRS (SdfAbstractData)
	TF_DECLARE_WEAK_AND_REF_PTRS (SdfFileFormat)
	TF_DECLARE_PUBLIC_TOKENS (SdfFileFormatTokens, SDF_API, SDF_FILE_FORMAT_TOKENS)
template<class FileFormat , class... BaseFormats>
void	SdfDefineFileFormat ()
template<class FileFormat , class... BaseFormats>
void	SdfDefineAbstractFileFormat ()

Macro Definition Documentation

#define SDF_DEFINE_ABSTRACT_FILE_FORMAT

(

...

)

SdfDefineAbstractFileFormat<__VA_ARGS__>()

Performs registrations needed for the specified abstract file format class. This is used to register types that serve as base classes for other concrete file format classes used by Sdf.

The first argument is the name of the file format class being registered. Subsequent arguments list the base classes of the file format. Since all file formats must ultimately derive from SdfFileFormat, there should be at least one base class specified.

For example:

// in MyFileFormat.cpp
TF_REGISTRY_FUNCTION(TfType)
{
    SDF_DEFINE_ABSTRACT_FILE_FORMAT(MyFileFormat, SdfFileFormat);
}

Definition at line 589 of file fileFormat.h.

#define SDF_DEFINE_FILE_FORMAT

(

...

)

SdfDefineFileFormat<__VA_ARGS__>()

Performs registrations needed for the specified file format class to be discovered by Sdf. This typically would be invoked in a TF_REGISTRY_FUNCTION in the source file defining the file format.

The first argument is the name of the file format class being registered. Subsequent arguments list the base classes of the file format. Since all file formats must ultimately derive from SdfFileFormat, there should be at least one base class specified.

For example:

// in MyFileFormat.cpp
TF_REGISTRY_FUNCTION(TfType)
{
    SDF_DEFINE_FILE_FORMAT(MyFileFormat, SdfFileFormat);
}

Definition at line 555 of file fileFormat.h.

#define SDF_FILE_FORMAT_FACTORY_ACCESS   template<typename T> friend class Sdf_FileFormatFactory

Provides access to allow file format classes to be instantiated from Sdf. This should be specified in the class definition for concrete file format classes.

For example:

// in MyFileFormat.h
class MyFileFormat : public SdfFileFormat
{
    SDF_FILE_FORMAT_FACTORY_ACCESS;
    // ...
};

Definition at line 619 of file fileFormat.h.

#define SDF_FILE_FORMAT_TOKENS   ((TargetArg, "target"))

Definition at line 55 of file fileFormat.h.

Function Documentation

SDF_DECLARE_HANDLES

(

SdfLayer

)

SDF_DECLARE_HANDLES

(

SdfSpec

)

template<class FileFormat , class... BaseFormats>

void SdfDefineAbstractFileFormat

(

)

Definition at line 593 of file fileFormat.h.

template<class FileFormat , class... BaseFormats>

void SdfDefineFileFormat

(

)

Definition at line 558 of file fileFormat.h.

TF_DECLARE_PUBLIC_TOKENS	(	SdfFileFormatTokens	,
		SDF_API	,
		SDF_FILE_FORMAT_TOKENS
	)

TF_DECLARE_WEAK_AND_REF_PTRS

(

SdfAbstractData

)

TF_DECLARE_WEAK_AND_REF_PTRS

(

SdfFileFormat

)