USDKit · IOS API REFERENCE

USDLayer.Spec.FieldCollection

protocol · iOS 27.0+ · SDK 27.1

protocol FieldCollection

Low-level read/write access to spec fields. Fields are the raw data backing both metadata and structural information on a spec.

Members (7)

method · iOS 27.0+

setField

Swift declaration

@discardableResult func setField(_ name: USDToken, to value: USDValue) -> Bool

Sets the field `name` to `value`. - Parameters: - name: The field name. - value: The new value. - Returns: `true` on success.

method · iOS 27.0+

setField

Swift declaration

@discardableResult func setField<T>(_ name: USDToken, to value: T) -> Bool where T : USDValueProtocol

Typed field setter. - Parameters: - name: The field name to author. - value: The typed value to store. - Returns: `true` on success.

method · iOS 27.0+

clearField

Swift declaration

@discardableResult func clearField(_ name: USDToken) -> Bool

Clears the authored value for `name`. - Parameter name: The field name to clear. - Returns: `true` if the field had been authored.

method · iOS 27.0+

field

Swift declaration

func field<T>(_ name: USDToken, as type: T.Type) -> T? where T : USDValueProtocol

Typed field accessor. - Parameters: - name: The field name to look up. - type: The expected value type. - Returns: The field's value as `T`, or `nil` if the field is unauthored or holds a different type.

method · iOS 27.0+

field

Swift declaration

func field(_ name: USDToken) -> USDValue?

Returns the value of `name`, or `nil` if the field is unauthored. - Parameter name: The field name to look up. - Returns: The field's value, or `nil` if unauthored.

get · iOS 27.0+

fields

Swift declaration

var fields: [USDToken] { get }

All authored field names on this spec.

method · iOS 27.0+

isInert

Swift declaration

func isInert(ignoringChildren: Bool = false) -> Bool

Returns a Boolean value that indicates whether the spec contains no authored data. - Parameter ignoringChildren: Pass `true` to skip child specifier lists when evaluating inertness. - Returns: `true` if the spec has no authored data.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →