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

#include <schema.h>

+ Inheritance diagram for SdfSchema:

Static Public Member Functions

static SDF_API const SdfSchemaGetInstance ()
 
- Static Public Member Functions inherited from SdfSchemaBase
static SdfAllowed IsValidAttributeConnectionPath (const SdfPath &path)
 
static SdfAllowed IsValidIdentifier (const std::string &name)
 
static SdfAllowed IsValidNamespacedIdentifier (const std::string &name)
 
static SdfAllowed IsValidInheritPath (const SdfPath &path)
 
static SdfAllowed IsValidPayload (const SdfPayload &payload)
 
static SdfAllowed IsValidReference (const SdfReference &ref)
 
static SdfAllowed IsValidRelationshipTargetPath (const SdfPath &path)
 
static SdfAllowed IsValidRelocatesPath (const SdfPath &path)
 
static SdfAllowed IsValidSpecializesPath (const SdfPath &path)
 
static SdfAllowed IsValidSubLayer (const std::string &sublayer)
 
static SdfAllowed IsValidVariantIdentifier (const std::string &name)
 

Friends

class TfSingleton< SdfSchema >
 

Additional Inherited Members

- Public Member Functions inherited from SdfSchemaBase
SDF_API const FieldDefinitionGetFieldDefinition (const TfToken &fieldKey) const
 
const SpecDefinitionGetSpecDefinition (SdfSpecType specType) const
 
SDF_API bool IsRegistered (const TfToken &fieldKey, VtValue *fallback=NULL) const
 
SDF_API bool HoldsChildren (const TfToken &fieldKey) const
 
SDF_API const VtValueGetFallback (const TfToken &fieldKey) const
 
SDF_API VtValue CastToTypeOf (const TfToken &fieldKey, const VtValue &value) const
 Coerce value to the correct type for the specified field. More...
 
SDF_API bool IsValidFieldForSpec (const TfToken &fieldKey, SdfSpecType specType) const
 Return whether the given field is valid for the given spec type. More...
 
SDF_API TfTokenVector GetFields (SdfSpecType specType) const
 Returns all fields registered for the given spec type. More...
 
SDF_API TfTokenVector GetMetadataFields (SdfSpecType specType) const
 Returns all metadata fields registered for the given spec type. More...
 
SDF_API TfToken GetMetadataFieldDisplayGroup (SdfSpecType specType, TfToken const &metadataField) const
 
SDF_API TfTokenVector GetRequiredFields (SdfSpecType specType) const
 Returns all required fields registered for the given spec type. More...
 
bool IsRequiredFieldName (const TfToken &fieldName) const
 
SDF_API SdfAllowed IsValidValue (const VtValue &value) const
 
std::vector< SdfValueTypeNameGetAllTypes () const
 Returns all registered type names. More...
 
SDF_API SdfValueTypeName FindType (const TfToken &typeName) const
 Return the type name object for the given type name token. More...
 
SDF_API SdfValueTypeName FindType (const char *typeName) const
 
SDF_API SdfValueTypeName FindType (std::string const &typeName) const
 
SDF_API SdfValueTypeName FindType (const TfType &type, const TfToken &role=TfToken()) const
 Return the type name object for the given type and optional role. More...
 
SDF_API SdfValueTypeName FindType (const VtValue &value, const TfToken &role=TfToken()) const
 Return the type name object for the value's type and optional role. More...
 
SDF_API SdfValueTypeName FindOrCreateType (const TfToken &typeName) const
 
- 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 Types inherited from SdfSchemaBase
typedef std::function< VtValue(const
std::string &, const JsValue &)> 
_DefaultValueFactoryFn
 
- Protected Member Functions inherited from SdfSchemaBase
 SdfSchemaBase ()
 
 SdfSchemaBase (EmptyTag)
 
virtual ~SdfSchemaBase ()
 
template<class T >
FieldDefinition_RegisterField (const TfToken &fieldKey, const T &fallback, bool plugin=false)
 
_SpecDefiner _Define (SdfSpecType type)
 
_SpecDefiner _ExtendSpecDefinition (SdfSpecType specType)
 
void _RegisterStandardFields ()
 Registers the standard fields. More...
 
void _RegisterPluginFields ()
 
void _RegisterStandardTypes ()
 Registers standard attribute value types. More...
 
void _RegisterLegacyTypes ()
 Registers legacy attribute value types. More...
 
_ValueTypeRegistrar _GetTypeRegistrar () const
 Returns a type registrar. More...
 
const std::vector< const
SdfSchemaBase::FieldDefinition * > 
_UpdateMetadataFromPlugins (const PlugPluginPtrVector &plugins, const std::string &metadataTag=std::string(), const _DefaultValueFactoryFn &defFactory=_DefaultValueFactoryFn())
 
- 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
 

Detailed Description

Class that provides information about the various scene description fields.

Definition at line 546 of file schema.h.

Member Function Documentation

static SDF_API const SdfSchema& SdfSchema::GetInstance ( )
inlinestatic

Definition at line 549 of file schema.h.

Friends And Related Function Documentation

friend class TfSingleton< SdfSchema >
friend

Definition at line 555 of file schema.h.


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