newton.usd.get_gprim_axis#

newton.usd.get_gprim_axis(prim, name='axis', default='Z')[source]#

Get an axis attribute from a USD prim and convert it to an Axis enum.

Parameters:
  • prim (Prim) – The USD prim to query.

  • name (str) – The name of the axis attribute to retrieve.

  • default (Axis | Literal['X', 'Y', 'Z'] | ~typing.Literal[0, 1, 2] | int | str) – The default axis string to use if the attribute is not found.

Returns:

An Axis enum value converted from the attribute string.

Return type:

Axis