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

Class that provides information about the various scene description fields. More...

#include <schema.h>

+ Inheritance diagram for SdfSchema:

Static Public Member Functions

static SDF_API const SdfSchemaGetInstance ()
 
- Static Public Member Functions inherited from SdfSchemaBase
static SDF_API SdfAllowed IsValidAttributeConnectionPath (const SdfPath &path)
 Specific validation functions for various fields.
 
static SDF_API SdfAllowed IsValidIdentifier (const std::string &name)
 
static SDF_API SdfAllowed IsValidNamespacedIdentifier (const std::string &name)
 
static SDF_API SdfAllowed IsValidInheritPath (const SdfPath &path)
 
static SDF_API SdfAllowed IsValidPayload (const SdfPayload &payload)
 
static SDF_API SdfAllowed IsValidReference (const SdfReference &ref)
 
static SDF_API SdfAllowed IsValidRelationshipTargetPath (const SdfPath &path)
 
static SDF_API SdfAllowed IsValidRelocatesSourcePath (const SdfPath &path)
 
static SDF_API SdfAllowed IsValidRelocatesTargetPath (const SdfPath &path)
 
static SDF_API SdfAllowed IsValidRelocate (const SdfRelocate &relocate)
 
static SDF_API SdfAllowed IsValidSpecializesPath (const SdfPath &path)
 
static SDF_API SdfAllowed IsValidSubLayer (const std::string &sublayer)
 
static SDF_API SdfAllowed IsValidVariantIdentifier (const std::string &name)
 
static SDF_API SdfAllowed IsValidVariantSelection (const std::string &sel)
 

Friends

class TfSingleton< SdfSchema >
 

Additional Inherited Members

- Public Member Functions inherited from SdfSchemaBase
SDF_API const FieldDefinitionGetFieldDefinition (const TfToken &fieldKey) const
 Returns the field definition for the given field.
 
const SpecDefinitionGetSpecDefinition (SdfSpecType specType) const
 Returns the spec definition for the given spec type.
 
SDF_API bool IsRegistered (const TfToken &fieldKey, VtValue *fallback=NULL) const
 Convenience functions for accessing specific field information.
 
SDF_API bool HoldsChildren (const TfToken &fieldKey) const
 Returns whether the given field is a 'children' field – that is, it indexes certain children beneath the owning spec.
 
SDF_API const VtValueGetFallback (const TfToken &fieldKey) const
 Return the fallback value for the specified fieldKey or the empty value if fieldKey is not registered.
 
SDF_API VtValue CastToTypeOf (const TfToken &fieldKey, const VtValue &value) const
 Coerce value to the correct type for the specified field.
 
SDF_API bool IsValidFieldForSpec (const TfToken &fieldKey, SdfSpecType specType) const
 Return whether the given field is valid for the given spec type.
 
SDF_API TfTokenVector GetFields (SdfSpecType specType) const
 Returns all fields registered for the given spec type.
 
SDF_API TfTokenVector GetMetadataFields (SdfSpecType specType) const
 Returns all metadata fields registered for the given spec type.
 
SDF_API TfToken GetMetadataFieldDisplayGroup (SdfSpecType specType, TfToken const &metadataField) const
 Return the metadata field display group for metadata metadataField on specType.
 
SDF_API const TfTokenVectorGetRequiredFields (SdfSpecType specType) const
 Returns all required fields registered for the given spec type.
 
bool IsRequiredFieldName (const TfToken &fieldName) const
 Return true if fieldName is a required field name for at least one spec type, return false otherwise.
 
SDF_API SdfAllowed IsValidValue (const VtValue &value) const
 Scene description value types.
 
SDF_API std::vector< SdfValueTypeNameGetAllTypes () const
 Returns all registered type names.
 
SDF_API SdfValueTypeName FindType (const TfToken &typeName) const
 Return the type name object for the given type name token.
 
SDF_API SdfValueTypeName FindType (const char *typeName) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
SDF_API SdfValueTypeName FindType (std::string const &typeName) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
SDF_API SdfValueTypeName FindType (const TfType &type, const TfToken &role=TfToken()) const
 Return the type name object for the given type and optional role.
 
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.
 
SDF_API SdfValueTypeName FindOrCreateType (const TfToken &typeName) const
 Return the type name object for the given type name string if it exists otherwise create a temporary type name object.
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase__GetTfWeakBase__ () const
 
const TfWeakBaseoperator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 
- Protected Types inherited from SdfSchemaBase
typedef std::function< VtValue(const std::string &, const JsValue &)> _DefaultValueFactoryFn
 Factory function for creating a default value for a metadata field.
 
- Protected Member Functions inherited from SdfSchemaBase
 SdfSchemaBase (EmptyTag)
 
template<class T >
FieldDefinition_RegisterField (const TfToken &fieldKey, const T &fallback, bool plugin=false)
 Creates and registers a new field named fieldKey with the fallback value fallback.
 
_SpecDefiner _Define (SdfSpecType type)
 Registers the given spec type with this schema and return a _SpecDefiner for specifying additional fields.
 
_SpecDefiner _ExtendSpecDefinition (SdfSpecType specType)
 Returns a _SpecDefiner for the previously-defined spec type for specifying additional fields.
 
void _RegisterStandardFields ()
 Registers the standard fields.
 
void _RegisterPluginFields ()
 Registers plugin fields and sets up handling so that fields will be added when additional plugins are registered.
 
void _RegisterStandardTypes ()
 Registers standard attribute value types.
 
void _RegisterLegacyTypes ()
 Registers legacy attribute value types.
 
_ValueTypeRegistrar _GetTypeRegistrar () const
 Returns a type registrar.
 
const std::vector< const SdfSchemaBase::FieldDefinition * > _UpdateMetadataFromPlugins (const PlugPluginPtrVector &plugins, const std::string &metadataTag=std::string(), const _DefaultValueFactoryFn &defFactory=_DefaultValueFactoryFn())
 Registers all metadata fields specified in the given plugins under the given metadata tag.
 
- Protected Member Functions inherited from 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 566 of file schema.h.

Member Function Documentation

◆ GetInstance()

static SDF_API const SdfSchema & GetInstance ( )
inlinestatic

Definition at line 569 of file schema.h.

Friends And Related Function Documentation

◆ TfSingleton< SdfSchema >

friend class TfSingleton< SdfSchema >
friend

Definition at line 569 of file schema.h.


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