Prim Name / Display Name for Non-ASCII

Rules for USD Prim name

The following rules apply to USD Prim names.

  • ASCII alphanumeric characters and ’_’ are allowed as prim names.

  • The first character of the Prim name cannot be a number.

For example, the following Prim names can be used.

  • Sphere

  • _Sphere

  • Sphere_1

The following cannot be used as Prim names.

  • Object : -10

  • 球

  • 2_sphere

Prim name conversion in USD export

The USD export uses the GameObject name as the Prim name.
If the string cannot be used as a Prim name, it will be replaced.

For non-ASCII strings

For non-ASCII strings, such as UTF-8 strings, the string will be replaced with something like “GameObject_1”.
The numbers at the end are sequential numbers.

The GameObject name “球” is replaced with “GameObject_1” because it is UTF-8.

For ASCII strings

If the GameObject name is an ASCII string and there are characters that do not match the USD Prim name rules, they will be replaced with ’_’.

For example: “Object : -10” is replaced by “Object____10”.

Since “2_sphere” starts with a number, a ’_’ is inserted as the first character.
The conversion is “_2_sphere”.

Display Name

In USD, a DisplayName can be specified separately for Prim.
The DisplayName can also be UTF-8, and it does not matter if it overlaps with other DisplayName.

In the Omniverse Unity Connector’s USD export, if the GameObject name is not allowed as the USD Prim name, the original GameObject name is stored in the DisplayName.

In USD Composer, select “Show Display Names” from the options menu in the upper right corner of the Stage window. This will show the Display Name, if one exists.
Show Display Names.

If you are using a UTF-8 DisplayName, you must specify the font for that language at the startup of USD Composer.

Display UTF-8 prim name.