Parameters#

class omni.converter.hoops.Parameters#

Bases: pybind11_object

HOOPS Converter Parameters Class.

Methods

__init__(*args, **kwargs)

Overloaded function.

parseArgs(self[, args])

Parse SdfLayer::FileFormatArguments to populate this Parameters instance

toArgs(self)

Create file format arguments that could be used to recreate these conversion parameters.

Attributes

accurateSurfaceCurvatures

Consider surface curvature to control triangles elongation direction

accurateTessellation

If false, tessellate for visualization.

convertCurves

If true then curve objects are imported as USD BasisCurves.

convertHidden

convertHidden option is deprecated.

convertMetadata

If true then metadata, including PMI, are imported as USD Attributes.

creator

Creator version string

dedup

If true (default), weld mesh vertices by merging those with identical position and normal, then reindex faces to the reduced vertex list.

filterStyle

eNone (0 - convert all elements), eOmit (1 - skip hidden elements), eHide (2 - convert as invisible), eDeactivate (3 - convert and deactivate)

globalXforms

When instancing = false, this flag controls whether globalXforms are composited.

instancingStyle

Style of instancing to use in USD.

materialType

ePreviewSurface (compatible with USD-enabled DCCs), ePreviewSurface_OmniPBR (optimized for RTX rendering and USD DCCs).

omitHiddenOnLoad

If true, hidden elements that would be ommitted during conversion will be ommitted at load time.

reportProgress

If true then we report import/export progress

reportProgressFreq

Progress reporting frequency in Hz.

tessLOD

0=kA3DTessLODExtraLow, 1=kA3DTessLODLow,2=kA3DTessLODMedium, 3=kA3DTessLODHigh, 4=kA3DTessLODExtraHigh

upAxis

eFileDefault (set up axis based on known formats that embeds it), eYup (Set USD stage to Y up), eZup (Set USD stage to Z up)

useMaterials

If true then use specified modes of materials.

useNormals

If true then we pass normals to USD.
__init__(*args, **kwargs)#

Overloaded function.

  1. __init__(self: omni.converter.hoops._omni_converter_hoops.Parameters) -> None

  2. __init__(self: omni.converter.hoops._omni_converter_hoops.Parameters, args: Dict[str, str]) -> None

parseArgs(
self: omni.converter.hoops._omni_converter_hoops.Parameters,
args: Dict[str, str] = {},
) → None#

Parse SdfLayer::FileFormatArguments to populate this Parameters instance

Parameters:

pxr::SdfLayer::FileFormatArguments – FileFormatArguments which represent convert options.

toArgs(
self: omni.converter.hoops._omni_converter_hoops.Parameters,
) → Dict[str, str]#

Create file format arguments that could be used to recreate these conversion parameters.

property accurateSurfaceCurvatures#

Consider surface curvature to control triangles elongation direction

Type:

(bool)

property accurateTessellation#

If false, tessellate for visualization. If true, tessellate for analysis.

Type:

(bool)

property convertCurves#

If true then curve objects are imported as USD BasisCurves. If false, then we skip and do not Import any curve object to USD.

Type:

(bool)

property convertHidden#

convertHidden option is deprecated. Use filterStyle instead

property convertMetadata#

If true then metadata, including PMI, are imported as USD Attributes. If false, then we skip and do not Import any metadata to USD.

Type:

(bool)

property creator#

Creator version string

Type:

(str)

property dedup#

If true (default), weld mesh vertices by merging those with identical position and normal, then reindex faces to the reduced vertex list. If false, leave vertex and normal arrays unchanged.

Type:

(bool)

property filterStyle#

eNone (0 - convert all elements), eOmit (1 - skip hidden elements), eHide (2 - convert as invisible), eDeactivate (3 - convert and deactivate)

Type:

(enum)

Type:

Filter style for hidden elements

property globalXforms#

When instancing = false, this flag controls whether globalXforms are composited. If false local transforms are applied

Type:

(bool)

property instancingStyle#

Style of instancing to use in USD.

property materialType#

ePreviewSurface (compatible with USD-enabled DCCs), ePreviewSurface_OmniPBR (optimized for RTX rendering and USD DCCs).

Type:

(enum)

Type:

Material type

property omitHiddenOnLoad#

If true, hidden elements that would be ommitted during conversion will be ommitted at load time.

Type:

(bool)

property reportProgress#

If true then we report import/export progress

Type:

(bool)

property reportProgressFreq#

Progress reporting frequency in Hz.

Type:

(int)

property tessLOD#

0=kA3DTessLODExtraLow, 1=kA3DTessLODLow,2=kA3DTessLODMedium, 3=kA3DTessLODHigh, 4=kA3DTessLODExtraHigh

Type:

(int)

Type:

Tessellation Level of Detail (LOD) presets

property upAxis#

eFileDefault (set up axis based on known formats that embeds it), eYup (Set USD stage to Y up), eZup (Set USD stage to Z up)

Type:

(enum)

Type:

Up Axis

property useMaterials#

If true then use specified modes of materials. if false, then use only basic display colors

Type:

(bool)

property useNormals#

If true then we pass normals to USD. if false, then we do not.

Type:

(bool)