PlaceholderAttribute

class omni.kit.property.usd.PlaceholderAttribute(name, prim=None, metadata=None)

Bases: object

This is a placeholder for Usd.Attribute object as those objects have to be attached to a Usd.Prim object. This conforms to enough of the Usd.Attribute API to be used by omni.kit.property.usd widgets.

The purpose of this is so custom Usd.Attributes can be created and displayed by widgets but don’t actually effect the Usd.Prim until user modifies a value, then the `CreateAttribute` function will be called and a real Usd.Attribute will be created using values from this class.

Methods

`CreateAttribute`()	Create the Usd.Attribute in the Usd.Prim
`Get`([time_code])	Mock Usd.Attribute function
`GetAllMetadata`()	Mock Usd.Attribute function
`GetMetadata`(token)	Mock Usd.Attribute function
`GetPath`()	Mock Usd.Attribute function
`GetPrim`()	Mock Usd.Attribute function
`HasAuthoredConnections`()	Mock Usd.Attribute function
`IsHidden`()	Mock Usd.Attribute function
`ValueMightBeTimeVarying`()	Mock Usd.Attribute function
`__init__`(name[, prim, metadata])	Initializes the PlaceholderAttribute.

__init__(name, prim=None, metadata=None)

Initializes the PlaceholderAttribute.

Parameters

name (str) – Name of the mock Usd.Prim.
prim – (Usd.Prim): Prim attribute is attached to.
metadata – (dict): metadata of mock attribute.

CreateAttribute(): Create the Usd.Attribute in the Usd.Prim

Get(time_code=0): Mock Usd.Attribute function

GetAllMetadata(): Mock Usd.Attribute function

GetMetadata(token): Mock Usd.Attribute function

GetPath(): Mock Usd.Attribute function

GetPrim(): Mock Usd.Attribute function

HasAuthoredConnections(): Mock Usd.Attribute function

IsHidden(): Mock Usd.Attribute function

ValueMightBeTimeVarying(): Mock Usd.Attribute function