USDKit · IOS API REFERENCE

USDStage.Object.MetadataCollection

protocol · iOS 27.0+ · SDK 27.1

protocol MetadataCollection

A scene graph object that possesses metadata. Prims, attributes, and relationships may have associated metadata. Metadata on an object is accessed by its name, which is a ``USDToken``. > Important: Don’t declare new conformances to MetadataCollection. Only the types provided by the USDStageKit framework are valid conforming types.

Members (43)

get · iOS 27.0+

allAuthoredMetadata

Swift declaration

var allAuthoredMetadata: Dictionary<USDToken, USDValue> { get }

Every authored metadata value on this object.

method · iOS 27.0+

hasAuthoredMetadata

Swift declaration

func hasAuthoredMetadata(_ key: USDToken, keyPath: USDToken) -> Bool

Returns a Boolean value that indicates whether the dictionary-valued metadata for the given key has an authored value at `keyPath`.

method · iOS 27.0+

hasAuthoredMetadata

Swift declaration

func hasAuthoredMetadata(_ key: USDToken) -> Bool

Returns a Boolean value that indicates whether metadata for the given key has an authored value.

get · iOS 27.0+

allMetadata

Swift declaration

var allMetadata: Dictionary<USDToken, USDValue> { get }

Every metadata value on this object, including fallbacks.

method · iOS 27.0+

hasMetadata

Swift declaration

func hasMetadata(_ key: USDToken, keyPath: USDToken) -> Bool

Returns a Boolean value that indicates whether the dictionary-valued metadata for the given key has a value at `keyPath`.

method · iOS 27.0+

hasMetadata

Swift declaration

func hasMetadata(_ key: USDToken) -> Bool

Returns a Boolean value that indicates whether metadata for the given key has a value, including its fallback.

method · iOS 27.0+

setMetadata

Swift declaration

func setMetadata(_ key: USDToken, value: Int) throws

method · iOS 27.0+

setMetadata

Swift declaration

func setMetadata(_ key: USDToken, value: UInt) throws

method · iOS 27.0+

setMetadata

Swift declaration

func setMetadata<T>(_ key: USDToken, value: T) throws where T : USDStage.Object.MetadataValue

Sets the metadata value for the given key.

method · iOS 27.0+

setMetadata

Swift declaration

func setMetadata(_ key: USDToken, keyPath: USDToken, value: Int) throws

method · iOS 27.0+

setMetadata

Swift declaration

func setMetadata(_ key: USDToken, keyPath: USDToken, value: UInt) throws

method · iOS 27.0+

setMetadata

Swift declaration

func setMetadata<T>(_ key: USDToken, keyPath: USDToken, value: T) throws where T : USDStage.Object.MetadataValue

Sets the value at `keyPath` within the dictionary-valued metadata for the given key.

method · iOS 27.0+

clearMetadata

Swift declaration

func clearMetadata(_ key: USDToken, keyPath: USDToken) throws

Removes the authored value at `keyPath` within the dictionary-valued metadata for the given key.

method · iOS 27.0+

clearMetadata

Swift declaration

func clearMetadata(_ key: USDToken) throws

Removes the authored metadata value for the given key.

get · iOS 27.0+

customData

Swift declaration

var customData: Dictionary<String, USDValue> { get set }

A dictionary of custom data authored on this object.

method · iOS 27.0+

clearHidden

Swift declaration

func clearHidden()

Removes the authored `isHidden` opinion on this object.

get · iOS 27.0+

displayName

Swift declaration

var displayName: String { get set }

A non-unique display name authored on this object.

get · iOS 27.0+

hasAssetInfo

Swift declaration

var hasAssetInfo: Bool { get }

A Boolean value that indicates whether this object has asset information.

get · iOS 27.0+

documentation

Swift declaration

var documentation: String { get set }

A human-readable description authored on this object.

get · iOS 27.0+

hasCustomData

Swift declaration

var hasCustomData: Bool { get }

A Boolean value that indicates whether this object has custom data.

method · iOS 27.0+

assetInfoByKey

Swift declaration

func assetInfoByKey(_ keyPath: USDToken) -> USDValue?

Returns the asset information value at the given key path.

method · iOS 27.0+

clearAssetInfo

Swift declaration

func clearAssetInfo()

Removes all authored asset information on this object.

method · iOS 27.0+

clearCustomData

Swift declaration

func clearCustomData()

Removes all authored custom data on this object.

method · iOS 27.0+

customDataByKey

Swift declaration

func customDataByKey(_ keyPath: USDToken) -> USDValue?

Returns the custom data value at the given key path.

method · iOS 27.0+

clearDisplayName

Swift declaration

func clearDisplayName()

Removes the authored display name on this object.

method · iOS 27.0+

hasAssetInfoByKey

Swift declaration

func hasAssetInfoByKey(_ keyPath: USDToken) -> Bool

Returns a Boolean value that indicates whether asset information exists at the given key path.

get · iOS 27.0+

hasAuthoredHidden

Swift declaration

var hasAuthoredHidden: Bool { get }

A Boolean value that indicates whether this object has an authored `isHidden` opinion.

method · iOS 27.0+

setAssetInfoByKey

Swift declaration

func setAssetInfoByKey(_ keyPath: USDToken, value: USDValue)

Sets the asset information value at the given key path.

method · iOS 27.0+

clearDocumentation

Swift declaration

func clearDocumentation()

Removes the authored documentation on this object.

method · iOS 27.0+

hasCustomDataByKey

Swift declaration

func hasCustomDataByKey(_ keyPath: USDToken) -> Bool

Returns a Boolean value that indicates whether custom data exists at the given key path.

method · iOS 27.0+

setCustomDataByKey

Swift declaration

func setCustomDataByKey(_ keyPath: USDToken, value: USDValue)

Modifies the custom data value at the given key path.

method · iOS 27.0+

clearAssetInfoByKey

Swift declaration

func clearAssetInfoByKey(_ keyPath: USDToken)

Removes the authored asset information value at the given key path.

method · iOS 27.0+

clearCustomDataByKey

Swift declaration

func clearCustomDataByKey(_ keyPath: USDToken)

Removes the authored custom data value at the given key path.

get · iOS 27.0+

hasAuthoredAssetInfo

Swift declaration

var hasAuthoredAssetInfo: Bool { get }

A Boolean value that indicates whether this object has authored asset information.

get · iOS 27.0+

hasAuthoredCustomData

Swift declaration

var hasAuthoredCustomData: Bool { get }

A Boolean value that indicates whether this object has authored custom data.

get · iOS 27.0+

hasAuthoredDisplayName

Swift declaration

var hasAuthoredDisplayName: Bool { get }

A Boolean value that indicates whether this object has an authored display name.

get · iOS 27.0+

hasAuthoredDocumentation

Swift declaration

var hasAuthoredDocumentation: Bool { get }

A Boolean value that indicates whether this object has authored documentation.

method · iOS 27.0+

hasAuthoredAssetInfoByKey

Swift declaration

func hasAuthoredAssetInfoByKey(_ keyPath: USDToken) -> Bool

Returns a Boolean value that indicates whether authored asset information exists at the given key path.

method · iOS 27.0+

hasAuthoredCustomDataByKey

Swift declaration

func hasAuthoredCustomDataByKey(_ keyPath: USDToken) -> Bool

Returns a Boolean value that indicates whether authored custom data exists at the given key path.

get · iOS 27.0+

isHidden

Swift declaration

var isHidden: Bool { get set }

A Boolean value that indicates whether this object is hidden from browsing UI.

method · iOS 27.0+

metadata

Swift declaration

func metadata<T>(_ key: USDToken, keyPath: USDToken) -> T? where T : USDStage.Object.MetadataValue

Returns the value at `keyPath` within the dictionary-valued metadata for the given key.

method · iOS 27.0+

metadata

Swift declaration

func metadata<T>(_ key: USDToken) -> T? where T : USDStage.Object.MetadataValue

Returns the metadata value for the given key.

get · iOS 27.0+

assetInfo

Swift declaration

var assetInfo: Dictionary<String, USDValue> { get set }

A dictionary of asset information authored on this object.

Skipped declarations

9 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

USDStage.Object.MetadataCollection.metadata(_:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata'

USDStage.Object.MetadataCollection.metadata(_:keyPath:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata(_:keyPath:)'

USDStage.Object.MetadataCollection.metadata(_:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata'

USDStage.Object.MetadataCollection.metadata(_:keyPath:)

The iOS SDK compiler rejected this binding: ambiguous use of 'metadata(_:keyPath:)'

USDStage.Object.MetadataCollection.isHidden