USDKit · IOS API REFERENCE

USDPrim.Property.Spec

struct · iOS 27.0+ · SDK 27.1

struct Spec

A handle to a property definition (attribute or relationship) stored in a layer. `USDPrim.Property.Spec` is the untyped base for `USDPrim.Attribute.Spec` and `USDPrim.Relationship.Spec`. It acts as a handle into data owned by a ``USDLayer`` and mutations write through to the layer.

Members (19)

get · iOS 27.0+

customData

TypeScript

get customData(): Record<string, USDValue>

Swift declaration

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

The custom data dictionary authored on this property.

get · iOS 27.0+

permission

TypeScript

get permission(): USDLayer_Permission

Swift declaration

var permission: USDLayer.Permission { get nonmutating set }

The property's permission level (public, restricted, private).

set · iOS 27.0+

permission

TypeScript

set permission(value: USDLayer_Permission)

Swift declaration

var permission: USDLayer.Permission { get nonmutating set }

The property's permission level (public, restricted, private).

static · iOS 27.0+

isValidName

TypeScript

static isValidName(name: USDToken): boolean

Swift declaration

static func isValidName(_ name: USDToken) -> Bool

Returns a Boolean value that indicates whether `name` is a valid property name. - Parameter name: The candidate name. - Returns: `true` if `name` is a valid property name; otherwise, `false`.

method · iOS 27.0+

setAssetInfo

TypeScript

setAssetInfo(key: string, value: USDValue): void

Swift declaration

func setAssetInfo(_ key: String, to value: USDValue)

Sets `key` in the asset info dictionary to `value`. Read the full dictionary via `field("assetInfo")` from FieldCollection. - Parameters: - key: The dictionary key. - value: The new value.

get · iOS 27.0+

documentation

TypeScript

get documentation(): (string) | null

Swift declaration

var documentation: String? { get nonmutating set }

The authored documentation, or `nil` if not authored.

set · iOS 27.0+

documentation

TypeScript

set documentation(value: (string) | null)

Swift declaration

var documentation: String? { get nonmutating set }

The authored documentation, or `nil` if not authored.

method · iOS 27.0+

setCustomData

TypeScript

setCustomData(key: string, value: USDValue): void

Swift declaration

func setCustomData(_ key: String, to value: USDValue)

Sets `key` in the custom data dictionary to `value`. - Parameters: - key: The dictionary key. - value: The new value.

method · iOS 27.0+

clearAssetInfo

TypeScript

clearAssetInfo(key: string): void

Swift declaration

func clearAssetInfo(_ key: String)

Removes `key` from the asset info dictionary. - Parameter key: The dictionary key to clear.

method · iOS 27.0+

clearCustomData

TypeScript

clearCustomData(key: string): void

Swift declaration

func clearCustomData(_ key: String)

Removes `key` from the custom data dictionary. - Parameter key: The dictionary key to clear.

get · iOS 27.0+

name

TypeScript

get name(): USDToken

Swift declaration

var name: USDToken { get }

The property's local name.

get · iOS 27.0+

owner

TypeScript

get owner(): (USDLayer_Spec) | null

Swift declaration

var owner: USDLayer.Spec? { get }

The spec that contains this property — typically a prim spec or variant spec.

method · iOS 27.0+

rename

TypeScript

rename(name: USDToken): void

Swift declaration

func rename(to name: USDToken) throws

Sets the property's name. - Parameter name: The new name to assign. - Throws: An error if the new name is invalid or already used by a sibling.

get · iOS 27.0+

comment

TypeScript

get comment(): (string) | null

Swift declaration

var comment: String? { get nonmutating set }

The authored user comment, or `nil` if not authored.

set · iOS 27.0+

comment

TypeScript

set comment(value: (string) | null)

Swift declaration

var comment: String? { get nonmutating set }

The authored user comment, or `nil` if not authored.

get · iOS 27.0+

isCustom

TypeScript

get isCustom(): boolean

Swift declaration

var isCustom: Bool { get nonmutating set }

Whether this property was authored as `custom`.

set · iOS 27.0+

isCustom

TypeScript

set isCustom(value: boolean)

Swift declaration

var isCustom: Bool { get nonmutating set }

Whether this property was authored as `custom`.

init · iOS 27.0+

init

TypeScript

static init(): USDPrim_Property_Spec

Swift declaration

init()

Creates an empty (invalid) property spec handle.

init · iOS 27.0+

init

TypeScript

static init6968(spec: USDLayer_Spec): (USDPrim_Property_Spec) | null

Swift declaration

init?(_ spec: USDLayer.Spec)

Narrows an untyped ``USDLayer/Spec`` to a property spec. - Parameter spec: The spec to narrow. - Returns: A property spec, or `nil` if `spec` is not an attribute or relationship spec.

Skipped declarations

No declarations were skipped in this snapshot.

All USDKit types →