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

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

+ 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)
 Specific validation functions for various fields. More...
 
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
 Returns the field definition for the given field. More...
 
SDF_API const SpecDefinitionGetSpecDefinition (SdfSpecType type) const
 Returns the spec definition for the given spec type. More...
 
SDF_API bool IsRegistered (const TfToken &fieldKey, VtValue *fallback=NULL) const
 Convenience functions for accessing specific field information. More...
 
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. More...
 
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. More...
 
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
 Return the metadata field display group for metadata metadataField on specType. More...
 
SDF_API TfTokenVector GetRequiredFields (SdfSpecType specType) const
 Returns all required fields registered for the given spec type. More...
 
bool IsRequiredFieldName (const TfToken &fieldName) const
 Return true if fieldName is a required field name for at least one spec type, return false otherwise. More...
 
SDF_API SdfAllowed IsValidValue (const VtValue &value) const
 Scene description value types. More...
 
std::vector< SdfValueTypeNameGetAllTypes () const
 Returns all registered type names. More...
 
SDF_API SdfValueTypeName FindType (const std::string &typeName) const
 Return the type name object for the given type name string. More...
 
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 std::string &typeName) const
 Return the type name object for the given type name string if it exists otherwise create a temporary type name object. More...
 
- 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. More...
 
- 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. More...
 
_SpecDefiner _Define (SdfSpecType type)
 Registers the given spec type with this schema and return a _SpecDefiner for specifying additional fields. More...
 
_SpecDefiner _ExtendSpecDefinition (SdfSpecType specType)
 Returns a _SpecDefiner for the previously-defined spec type for specifying additional fields. More...
 
void _RegisterStandardFields ()
 Registers the standard fields. More...
 
void _RegisterPluginFields ()
 Registers plugin fields and sets up handling so that fields will be added when additional plugins are registered. More...
 
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())
 Registers all metadata fields specified in the given plugins under the given metadata tag. More...
 
- 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 532 of file schema.h.


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