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

#include <schema.h>

Public Types
typedef std::vector< std::pair< TfToken, JsValue > >	InfoVec

Public Member Functions
	FieldDefinition (const SdfSchemaBase &schema, const TfToken &name, const VtValue &fallbackValue)

SDF_API const TfToken &	GetName () const

SDF_API const VtValue &	GetFallbackValue () const

SDF_API const InfoVec &	GetInfo () const

SDF_API bool	IsPlugin () const

SDF_API bool	IsReadOnly () const

SDF_API bool	HoldsChildren () const


SDF_API SdfAllowed	IsValidValue (const VtValueRef &value) const
	Validation functions that return true if a given value passes the registered validator or if no validator has been set.

SDF_API SdfAllowed	IsValidListValue (const VtValueRef &value) const

SDF_API SdfAllowed	IsValidMapKey (const VtValueRef &value) const

SDF_API SdfAllowed	IsValidMapValue (const VtValueRef &value) const

using	Validator

FieldDefinition &	FallbackValue (const VtValue &v)
	Functions for setting field attributes during registration.

FieldDefinition &	Plugin ()

FieldDefinition &	Children ()

FieldDefinition &	ReadOnly ()

FieldDefinition &	AddInfo (const TfToken &tok, const JsValue &val)

FieldDefinition &	ValueValidator (Validator v)

FieldDefinition &	ListValueValidator (Validator v)

FieldDefinition &	MapKeyValidator (Validator v)

FieldDefinition &	MapValueValidator (Validator v)

Detailed Description

Class defining various attributes for a field.

Definition at line 57 of file schema.h.

Member Typedef Documentation

std::vector< std::pair<TfToken, JsValue> > InfoVec

Definition at line 64 of file schema.h.

using Validator

Initial value:

SdfAllowed (*) (const SdfSchemaBase&, const VtValueRef&)

Indicates if an operation is allowed and, if not, why not.

Definition allowed.h:29

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

Definition schema.h:46

A non-owning type-erased view of a value, interoperating with VtValue.

Definition valueRef.h:65

Definition at line 95 of file schema.h.

FieldDefinition & FallbackValue ( const VtValue & v )

Functions for setting field attributes during registration.

SDF_API SdfAllowed IsValidValue ( const VtValueRef & value ) const

Validation functions that return true if a given value passes the registered validator or if no validator has been set.

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