AttributeConvention Prim Decorator

New in Katana 7.5

The AttributeConvention Prim Decorator allows for generic conversion of Katana attributes to USD attributes, which may not be covered by another prim decorator.

Attributes

Attributes are defined under the usd.conversion.attribute Group Attribute.

Type

Attribute

Description

string

usd.conversion.attribute.<id>.katanaAttrName

The absolute path to the Katana Attribute name. This is a required attribute when the usd.conversion.attribute.<id>.defaultValue attribute is not specified.

string

usd.conversion.attribute.<id>.usdAttrName

The USD attribute name. Required.

string

usd.conversion.attribute.<id>.usdAttrTypeName

The USD attribute type name. Required.

string

usd.conversion.attribute.<id>.usdAttrVariability

The USD attribute variability. Possible values are uniform or varying. This is uniform by default.

int

usd.conversion.attribute.<id>.isCustom

Determines if the USD attribute should be written as Custom. This is 0 (false) by default.

any

usd.conversion.attribute.<id>.defaultValue

If no Katana attribute is found at usd.conversion.attribute.<id>.katanaAttrName, this value will be used. This is a required attribute when usd.conversion.attribute.<id>.katanaAttrName is not specified.

group

usd.conversion.attribute.<id>.usdMetadata

A group holding attribute metadata names.

string

usd.conversion.attribute.<id>.usdMetadata.<metadata id>.name

The USD attribute metadata name. Required.

int

usd.conversion.attribute.<id>.usdMetadata.<metadata id>.isCustom

Determines if the metadata field should be set as customData metadata, or not. This is 0 (false) by default.

any

usd.conversion.attribute.<id>.usdMetadata.<metadata id>.value

The value of the USD attribute metadata. Required.

string

usd.conversion.attribute.<id>.usdMetadata.<metadata id>.usdMetadataTypeName

The USD metadata type name. Required.

Relationships

Relationships are defined under the usd.conversion.relationship Group Attribute.

Type

Attribute

Description

string

usd.conversion.relationship.<id>.katanaAttrName

The absolute path to the Katana Attribute. The value of this Katana Attribute must be one or more valid locations. Required.

string

usd.conversion.relationship.<id>.usdRelName

The USD relationship name. Required.

Schemas

Type

Attribute

Description

string

usd.conversion.usdConcreteType

The concrete type schema to apply to the Prim.

string[]

usd.conversion.usdAPISchemas

A list of USD Schema names to apply to the Prim.

Specifier

Type

Attribute

Description

string

usd.conversion.usdSpecifier

The prim specifier to create the prim with. Possible values are def, over or class. This is def by default.

Metadata

Metadata is defined under the usd.conversion.metadata Group Attribute.

Type

Attribute

Description

string

usd.conversion.metadata.<id>.katanaAttrName

The absolute path to the Katana Attribute name. Required.

any

usd.conversion.metadata.<id>.usdMetadataName

The name of the metadata item. Delimiting with a : character will place the metadata value within a dictionary. Required.

string

usd.conversion.metadata.<id>.usdMetadataTypeName

The type name of the USD metadata item. Required.

int

usd.conversion.metadata.<id>.isCustom

Determines if the USD attribute should be written as Custom. This is 0 (false) by default.

any

usd.conversion.metadata.<id>.defaultValue

If no Katana attribute is found at usd.conversion.metadata.<id>.katanaAttrName, this value will be used. This is a required attribute when usd.conversion.metadata.<id>.katanaAttrName is not specified.