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.
convertCurves	If true then curve objects are imported as USD BasisCurves.
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
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
hideLevelsByList	Whether to hide defined levels based on the listed level names
importAttributesByList	Whether to import defined attributes
instancing	If true, enable instancing
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	ePreviewSurface (compatible with USD-enabled DCCs), ePreviewSurface_OmniPBR (optimized for RTX rendering and USD DCCs).
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'.
mergeMeshes	If true then meshes that share the same level and color are merged for optimization.
mergedAttributeStyle	The style in which the values of attributes that differ between merged elements are stored
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.
triangulate	Whether to triangulate Meshes
useMaterials	If true then use specified modes of materials.

__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 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 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 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 hideLevelsByList

Whether to hide defined levels based on the listed level names

Type:

(bool)

property importAttributesByList

Whether to import defined attributes

Type:

(bool)

property instancing

If true, enable instancing

Type:

(bool)

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

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

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’. If false then curve merging is skipped

Type:

(bool)

property mergeMeshes

If true then meshes that share the same level and color 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 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 triangulate

Whether to triangulate Meshes

Type:

(bool)

property useMaterials

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

Type:

(bool)