Generic class that provides information about scene description fields but doesn't actually provide any fields. More...

Inheritance diagram for SdfSchemaBase:

Classes
class	_SpecDefiner
	Class that defines fields for a spec type. More...

class	_ValueTypeRegistrar
	A helper for registering value types. More...

class	EmptyTag
	Construct an SdfSchemaBase but does not populate it with standard fields and types. More...

class	FieldDefinition
	Class defining various attributes for a field. More...

class	SpecDefinition
	Class representing fields and other information for a spec type. More...

Public Member Functions
SDF_API const FieldDefinition *	GetFieldDefinition (const TfToken &fieldKey) const
	Returns the field definition for the given field. More...

const SpecDefinition *	GetSpecDefinition (SdfSpecType specType) 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 VtValue &	GetFallback (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 const 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< SdfValueTypeName >	GetAllTypes () 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
	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 TfWeakBase &	operator= (const TfWeakBase &)

void	EnableNotification2 () const

TF_API void const *	GetUniqueIdentifier () const

Static Public Member Functions

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)

Protected Types
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
	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

Friends
class	_SpecDefiner

Detailed Description

Generic class that provides information about scene description fields but doesn't actually provide any fields.

Definition at line 62 of file schema.h.

Class Documentation

class SdfSchemaBase::EmptyTag

Construct an SdfSchemaBase but does not populate it with standard fields and types.

Definition at line 444 of file schema.h.

Member Typedef Documentation

typedef std::function<VtValue(const std::string&, const JsValue&)> _DefaultValueFactoryFn

protected

Factory function for creating a default value for a metadata field.

The parameters are the value type name and default value (if any) specified in the defining plugin.

Definition at line 495 of file schema.h.

Member Function Documentation

_SpecDefiner _Define ( SdfSpecType type )

inlineprotected

Registers the given spec type with this schema and return a _SpecDefiner for specifying additional fields.

Definition at line 465 of file schema.h.

_SpecDefiner _ExtendSpecDefinition ( SdfSpecType specType )

protected

Returns a _SpecDefiner for the previously-defined spec type for specifying additional fields.

_ValueTypeRegistrar _GetTypeRegistrar ( ) const

protected

Returns a type registrar.

FieldDefinition& _RegisterField	(	const TfToken &	fieldKey,
		const T &	fallback,
		bool	plugin = `false`
	)

inlineprotected

Creates and registers a new field named fieldKey with the fallback value fallback.

If plugin is specified, it indicates that this field is not a built-in field from this schema, but rather a field that was externally registered.

It is a fatal error to call this function with a key that has already been used for another field.

Definition at line 457 of file schema.h.

void _RegisterLegacyTypes ( )

protected

Registers legacy attribute value types.

void _RegisterPluginFields ( )

protected

Registers plugin fields and sets up handling so that fields will be added when additional plugins are registered.

void _RegisterStandardFields ( )

protected

Registers the standard fields.

void _RegisterStandardTypes ( )

protected

Registers standard attribute value types.

const std::vector<const SdfSchemaBase::FieldDefinition *> _UpdateMetadataFromPlugins	(	const PlugPluginPtrVector &	plugins,
		const std::string &	metadataTag = `std::string()`,
		const _DefaultValueFactoryFn &	defFactory = `_DefaultValueFactoryFn()`
	)

protected

Registers all metadata fields specified in the given plugins under the given metadata tag.

SDF_API VtValue CastToTypeOf	(	const TfToken &	fieldKey,
		const VtValue &	value
	)		const

Coerce value to the correct type for the specified field.

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.

Clients should not normally need to call this.

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.

std::vector<SdfValueTypeName> GetAllTypes ( ) const

Returns all registered type names.

SDF_API const VtValue& GetFallback ( const TfToken & fieldKey ) const

Return the fallback value for the specified fieldKey or the empty value if fieldKey is not registered.

SDF_API const FieldDefinition* GetFieldDefinition ( const TfToken & fieldKey ) const

Returns the field definition for the given field.

Returns NULL if no definition exists for given field.

SDF_API TfTokenVector GetFields ( SdfSpecType specType ) const

Returns all 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.

Return the empty token if metadataField is not a metadata field, or if it has no display group.

SDF_API TfTokenVector GetMetadataFields ( SdfSpecType specType ) const

Returns all metadata fields registered for the given spec type.

SDF_API const TfTokenVector& GetRequiredFields ( SdfSpecType specType ) const

Returns all required fields registered for the given spec type.

const SpecDefinition* GetSpecDefinition ( SdfSpecType specType ) const

inline

Returns the spec definition for the given spec type.

Returns NULL if no definition exists for the given spec type.

Definition at line 227 of file schema.h.

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 bool IsRegistered	(	const TfToken &	fieldKey,
		VtValue *	fallback = `NULL`
	)		const

Convenience functions for accessing specific field information.

Return whether the specified field has been registered. Also optionally return the fallback value.

bool IsRequiredFieldName ( const TfToken & fieldName ) const

inline

Return true if fieldName is a required field name for at least one spec type, return false otherwise.

The main use of this function is to quickly rule out field names that aren't required (and thus don't need special handling).

Definition at line 278 of file schema.h.

static SdfAllowed IsValidAttributeConnectionPath ( const SdfPath & path )

static

Specific validation functions for various fields.

These are internally registered as validators for the associated field, but can also be used directly.

SDF_API bool IsValidFieldForSpec	(	const TfToken &	fieldKey,
		SdfSpecType	specType
	)		const

Return whether the given field is valid for the given spec type.

SDF_API SdfAllowed IsValidValue ( const VtValue & value ) const

Scene description value types.

Given a value, check if it is a valid value type. This function only checks that the type of the value is valid for this schema. It does not imply that the value is valid for a particular field – the field's validation function must be used for that.

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

pxr/usd/sdf/schema.h

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Friends

Detailed Description

Class Documentation

Member Typedef Documentation

Member Function Documentation