Parameters

class omni.converter.dgn.Parameters

Bases: pybind11_object

DGN Converter Options Class.

Methods

__init__(self)
parseArgs(self[, args])	Parse SdfLayer::FileFormatArguments to populate the Parameters
toArgs(self)	Create file format arguments that could be used to recreate these conversion parameters.

Attributes

applyGlobalOrigin	Whether the global origin of Models are applied as an XformOp
attributes	Attributes to import where key = attribute name and value=custom attribute name to use in USD
betweenKnots	Distance between knots.
convertElementId	Whether to convert the element ID attribute
convertHidden	If true then hidden data is imported, it will be hidden in the USD Stage until activated/unhidden.
creator	Creator version string
curveConversionStyle	eNone (skip), eAttributes (metadata only), eRenderable (full geometry).
curveSamplePoints	Number of sample points to use when approximating curve shapes.
fallbackCurveWidth	sets a fallback width for curve segments that do not have an explicit width set.
geometryAttributeStyle	The style in how the DGN geometry attributes get authored to USD
gridAspectRatio	Grid aspect ratio.
hiddenLevels	List of level names to hide
instancingStyle	Style of instancing to use in USD when handling Shared Cell References
levelExcludeHidden	Whether to exclude hidden levels from conversion
levelExcludes	List of level names to exclude during filtering
levelFilterStyle	Styles to used to handle filtered levels.
levelIncludes	List of level names to include during filtering
materialType	eNone (displayColor and displayOpacity primvars with a default material), ePreviewSurface (compatible with USD-enabled DCCs), ePreviewSurface_OmniPBR (optimized for RTX rendering and USD DCCs), ePreviewSurface_MaterialX (OpenPBR MaterialX plus USD Preview Surface).
maxFacetEdgeLength	Maximum facet edge length.
maxNumGridLines	Maximum number of grid lines.
mergeCurves	If true then curve segments are merged if they have the same 'width' and visibility.
mergeMeshes	If true then meshes that share the same level, color, and visibility are merged for optimization.
mergedAttributeStyle	The style in which the values of attributes that differ between merged elements are stored
meshConversionStyle	eNone (skip), eAttributes (metadata only), eRenderable (full geometry).
modelNamePatterns	List of model names patterns for resolving DGN models to convert; model names can include wildcard characters ("*") to complete the rest of the model name during conversion wildcard characters can be placed at the beginning ("ault"), ending ("Def"), or both ("fau"); if the user provides patterns that do not match any models in the DGN file, then the file is not converted
normalTolerance	NormalTolerance allows to specify the tessellation quality of circular surfaces (such as Cone, Torus, Sphere or Cylinder).It is measured in degrees.
pointsPerEdge	Points quantity per edge.
progressLogging	If true then conversion progress will be reported
surfaceTolerance	Distance tolerance for coincident faces.
surfaceToleranceUnit	The unit used to define surface tolerance, expressed in meters per unit.
text3dConversionStyle	eNone (don't convert), eAttributes (attributes only), eRenderable (curves and attributes).
text3dWidth	Width for OdDgText3d and OdDgTextNode3d objects when they have zero width.
triangulate	Whether to triangulate Meshes
verboseLogging	If true then detailed information will be logged during conversion

__init__(

self: omni.converter.dgn._omni_converter_dgn.Parameters,

) → None

parseArgs(

self: omni.converter.dgn._omni_converter_dgn.Parameters,

args: Dict[str, str] = {},

) → bool

Parse SdfLayer::FileFormatArguments to populate the Parameters

Parameters:

str – JSON formatted string

toArgs(

self: omni.converter.dgn._omni_converter_dgn.Parameters,

) → Dict[str, str]

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

property applyGlobalOrigin

Whether the global origin of Models are applied as an XformOp

Type:

(bool)

property attributes

Attributes to import where key = attribute name and value=custom attribute name to use in USD

Type:

(dict)

property betweenKnots

Distance between knots. This parameter contains the number of additional points between knots; for NURB surfaces it contains number of additional isolines between knots.

Type:

(int)

property convertElementId

Whether to convert the element ID attribute

Type:

(bool)

property convertHidden

If true then hidden data is imported, it will be hidden in the USD Stage until activated/unhidden. If false, then we skip and do not Import the hidden data to USD.

Type:

(bool)

property creator

Creator version string

Type:

(str)

property curveConversionStyle

eNone (skip), eAttributes (metadata only), eRenderable (full geometry).

Type:

(enum)

Type:

Style for converting non-text curve elements

property curveSamplePoints

Number of sample points to use when approximating curve shapes. Default is 8.

Type:

(int)

property fallbackCurveWidth

sets a fallback width for curve segments that do not have an explicit width set. If the fallback width is not set or <= 0 or omitted, no widths primvar is authored and the renderer’s default is used.

Type:

(float)

property geometryAttributeStyle

The style in how the DGN geometry attributes get authored to USD

Type:

(enum)

property gridAspectRatio

Grid aspect ratio.

Type:

(double)

property hiddenLevels

List of level names to hide

Type:

(str[])

property instancingStyle

Style of instancing to use in USD when handling Shared Cell References

Type:

(enum)

property levelExcludeHidden

Whether to exclude hidden levels from conversion

Type:

(bool)

property levelExcludes

List of level names to exclude during filtering

property levelFilterStyle

Styles to used to handle filtered levels. Note that levelIncludes, levelExcludes, and levelExcludeHidden will be ignored if levelFilterStyle is set to FilterStyle::eNone

property levelIncludes

List of level names to include during filtering

property materialType

eNone (displayColor and displayOpacity primvars with a default material), ePreviewSurface (compatible with USD-enabled DCCs), ePreviewSurface_OmniPBR (optimized for RTX rendering and USD DCCs), ePreviewSurface_MaterialX (OpenPBR MaterialX plus USD Preview Surface).

Type:

(enum)

Type:

Material type

property maxFacetEdgeLength

Maximum facet edge length.

Type:

(double)

property maxNumGridLines

Maximum number of grid lines.

Type:

(int)

property mergeCurves

If true then curve segments are merged if they have the same ‘width’ and visibility. If false then curve merging is skipped

Type:

(bool)

property mergeMeshes

If true then meshes that share the same level, color, and visibility are merged for optimization. If false then mesh merging is skipped

Type:

(bool)

property mergedAttributeStyle

The style in which the values of attributes that differ between merged elements are stored

Type:

(enum)

property meshConversionStyle

eNone (skip), eAttributes (metadata only), eRenderable (full geometry).

Type:

(enum)

Type:

Style for converting mesh elements

property modelNamePatterns

List of model names patterns for resolving DGN models to convert; model names can include wildcard characters (“*”) to complete the rest of the model name during conversion wildcard characters can be placed at the beginning (”ault”), ending (“Def”), or both (”fau”); if the user provides patterns that do not match any models in the DGN file, then the file is not converted

Type:

(str[])

property normalTolerance

NormalTolerance allows to specify the tessellation quality of circular surfaces (such as Cone, Torus, Sphere or Cylinder).It is measured in degrees. The value of this parameter determines the quantity of mesh cells (triangles) used to represent a circular surface (360/NormalTolerance).Default value is 15. It means, for an example, that surface will be tessellated with 24 mesh cells (triangles) in circular direction.

Type:

(double)

property pointsPerEdge

Points quantity per edge.

Type:

(int)

property progressLogging

If true then conversion progress will be reported

Type:

(bool)

property surfaceTolerance

Distance tolerance for coincident faces. If zero or negative, the tolerance will be calculated as a percent of extents diagonal.

Type:

(double)

property surfaceToleranceUnit

The unit used to define surface tolerance, expressed in meters per unit. For example, use 0.001 when surface tolerance is specified in millimeters. Use 0.0 to treat surface tolerance as already expressed in scene units and pass it through unchanged. Negative values are treated as 0.0. Default is 0.0.

Type:

(double)

property text3dConversionStyle

eNone (don’t convert), eAttributes (attributes only), eRenderable (curves and attributes).

Type:

(enum)

Type:

Style for converting 3D text elements

property text3dWidth

Width for OdDgText3d and OdDgTextNode3d objects when they have zero width. Default is 0.05.

Type:

(float)

property triangulate

Whether to triangulate Meshes

Type:

(bool)

property verboseLogging

If true then detailed information will be logged during conversion

Type:

(bool)