vrdAtfSettings

class vrdAtfSettings

(Inherits vrdData)

Encapsulates the configuration properties for a particular vrCADFileTypes.FileType. Some of the properties only have an effect on certain file formats. Please have a look at the import dialog that changes its content with respect to the vrCADFileTypes.FileType of the imported files.

class SourceReferenceBehavior
CreateNoReference
CreateSourceReference
class SmartReferenceBehavior
KeepSmartReference
RemoveSmartReference
class ImporterVersion
Lightweight
Legacy
class ModelState
Primary
LastActive

Summary

Functions:

Functions

vrdAtfSettings.getChordDeviation()

Get maximum deviation of tessellated mesh to the NURBS surface in mm.

Returns:Maximum chord deviation in mm.
Return type:float
vrdAtfSettings.getCreateLayerGroups()

Query if creating group nodes from layer information is enabled..

Returns:True if creating group nodes from layer information is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getFixSurfaceOrientation()

Query if orienting surface normals is enabled.

Returns:True if fixing of surface orientation is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getFlushTransformations()

Query if transformations should be flushed into the vertex coordinates.

Returns:True if flushing of transformations is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportAnimations()

Query if import of animations for USD is enabled.

Returns:True if import of animations is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportAsSmartReference()

Query if smart references should be created for imported vpb files.

Returns:True if smart references should be created for vpb files otherwise False.
Return type:bool
vrdAtfSettings.getImportAssociativeMeshes()

Query if import of associative meshes is enabled.

Returns:True if import of associative meshes is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportCameras()

Query if import of cameras is enabled.

Returns:True if import of cameras is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportColors()

Query if import of colors for 3MF data is enabled.

Returns:True if import of colors is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportCoordSystems()

Query if import of coordinate system nodes is enabled.

Returns:True if import of coordinate systems is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportCurves()

Query if import of curves and poly lines is enabled.

Returns:True if import of curves and poly lines is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportEmptyLayers()

Query if import of empty layers is enabled.

Returns:True if import of empty layers is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImporterVersion()

Query which importer is used. Currently only available for Catia V5 and Jt.

Returns:Enum specifying which importer version to use. Currently only affects Catia V5 and Jt import. Lightweight selects optimized geometry and topology translation. Legacy should only be selected if issues like corrupted geometry should arise.
Return type:ImporterVersion
vrdAtfSettings.getImportGroupMaterials()

Query if import of materials applied to group nodes like part, assembly or instance is enabled.

Returns:True if import of materials applied to group nodes is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportInvisibleCurves()

Query if import of curves and poly lines, that are invisible in CAD data, is enabled.

Note: Only has an effect if import of surfaces is enabled.

Returns:True if import of invisible curves and poly lines is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportInvisibleInstances()

Query if import of invisible instance nodes is enabled.

Returns:True if import of invisible instance nodes is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportInvisibleMeshes()

Query if import of polygon meshes, that are invisible in the CAD file, is enabled.

Note: Only has an effect if import of surfaces is enabled.

Returns:True if import of invisible polygon meshes is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportInvisibleSurfaces()

Query if import of surfaces, that are invisible in the CAD file, is enabled.

Note: Only has an effect if import of surfaces is enabled.

Returns:True if import of invisible surfaces is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportLayerFolders()

Query if import of layer hierarchies is enabled.

Returns:True if import of layer folders is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportLights()

Query if import of light sources is enabled.

Returns:True if import of lights is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportMeshes()

Query if import of polygon meshes is enabled.

Returns:True if import of polygon meshes is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportMeshLODs()

Query which mesh LODs should be imported.

0 - Import all mesh LODs

1 - Import only mesh with lowest LOD

2 - Import only mesh with highest LOD

Returns:The selected LOD option
Return type:integer
vrdAtfSettings.getImportMetadata()

Query if import of metadata is enabled.

Returns:True if import of metadata is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportReferencedFiles()

Query if import of part files referenced by an assembly is enabled.

Returns:True if import of part files is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportSurfaces()

Query if import of surfaces is enabled.

Returns:True if import of surfaces is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportSwitchMaterials()

Query if import of switch shaders for Alias is enabled.

Returns:True if import of switch shaders from Alias files is enabled, False otherwise. If disabled only the active choice of switch shaders is imported.
Return type:bool
vrdAtfSettings.getImportTemplateGeometries()

Query if import of template geometries is enabled.

Returns:True if import of template geometries is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportTextures()

Query if import of textures for 3MF data is enabled.

Returns:True if import of textures is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getImportVariants()

Query if import of variants is enabled.

Returns:True if import of variants is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getJtToolkit()

Query which Jt toolkit is used for import.

0 - Parasolid

1 - Jt Open

Returns:The selected Jt toolkit option
Return type:integer
vrdAtfSettings.getKeepNurbs()

Query if NURBS data should be kept alongside with tessellation result.

Returns:True if NURBS data should be kept, False otherwise.
Return type:bool
vrdAtfSettings.getMaxChordLength()

Get maximum length of a triangle edge in mm.

Returns:Maximum chord length in mm.
Return type:float
vrdAtfSettings.getMergeGeometries()

Query if tessellated meshes of adjacent NURBS surfaces with same material should be merged.

Returns:True if merging of surfaces is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getMergeSubReferenceMaterials()

Query if duplicate materials, referenced in different files, should be merged into one single material. Materials with same name and identical properties are regarded as duplicates.

Returns:True if duplicate referenced materials shouild be merged otherwise False.
Return type:bool
vrdAtfSettings.getModelState()

Query which Inventor model state should be imported.

Returns:Primary (Default) or Last Active model state.
Return type:ModelState
vrdAtfSettings.getNormalTolerance()

Get the normal tolerance of adjacent triangles in degrees.

Returns:Normal tolerance in degrees.
Return type:float
vrdAtfSettings.getReduceKeyframes()

Query if reducing the number of keyframes is enabled.

Returns:True if reducing the number of keyframes is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getRemoveEmptyGroups()

Query if groups without children should be removed.

Returns:True if removing empty groups is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getSmartReferenceBehavior()

Query how references to VRED native files are treated in import.

Returns:Enum specifying if smart references found in an imported file should be kept or removed.
Return type:SmartReferenceBehavior
vrdAtfSettings.getSourceReferenceBehavior()

Query how references to files of import file types are treated in import.

Returns:Enum specifying if source references should be created for file references found in the imported files or if no reference nodes at all should be created.
Return type:SourceReferenceBehavior
vrdAtfSettings.getStitchingTolerance()

Get the stitching tolerance of adjacent edges in mm.

Returns:Stitiching tolerance in mm
Return type:float
vrdAtfSettings.getUnshareNodes()

Query if shared node instances should be converted to independent nodes.

Returns:True if conversion of instances is enabled, False otherwise.
Return type:bool
vrdAtfSettings.getUseHealStitch()
Returns:
Return type:bool
vrdAtfSettings.getUseLegacyLoader()

Option has no effect anymore. All legacy loaders are retired.

Returns:Always returns false.
Return type:bool
vrdAtfSettings.getUseStitching()

Query if stitching is enabled.

Returns:True if stitching is enabled, False otherwise.
Return type:bool
vrdAtfSettings.setChordDeviation(chordDeviation)

Set maximum allowed distance from the NURBS surface to the tessellated surface in mm. Lower values result in more accurate polygon models but also increase the number of triangles.

Parameters:chordDeviation (float) – Maximum chord deviation in mm.
vrdAtfSettings.setCreateLayerGroups(create)

Enable / Disable creation of group nodes for objects organized in layers. In case the parents of the objects in one layer have different transformations this might cause an unexpected scenegraph structure since it is required to preserve the transformations.

Parameters:create (bool) – True if creation of layer groups should be enabled, False otherwise.
vrdAtfSettings.setFixSurfaceOrientation(fix)

Enable orienting the normals of all surfaces, so they point in the same general direction.

Parameters:fix (bool) – True if fixing of surface orientation should be enabled, False otherwise.
vrdAtfSettings.setFlushTransformations(flush)

Enable / Disable moving transformation data of the scene graph hierarchy to the vertices. This means, that every transformation node will contain only a unit matrix.

Parameters:flush (bool) – True if flushing of transformations should be enabled, False otherwise.
vrdAtfSettings.setImportAnimations(import)

Enable import of animations from USD data.

Parameters:import (bool) – True to enable import of animations, False to disable.
vrdAtfSettings.setImportAsSmartReference(create)

Determine if smart references should be created for imported vpb files.

Parameters:create (bool) – True if smart references should be created for vpb files otherwise False.
vrdAtfSettings.setImportAssociativeMeshes(import)

Enable import of meshes associated with the surfaces.

Parameters:import (bool) – True to enable import of associative meshes, False to disable.
vrdAtfSettings.setImportCameras(import)

Enable import of cameras from CAD data. (Only Alias wire files)

Parameters:import (bool) – True to enable import of cameras, False to disable.
vrdAtfSettings.setImportColors(import)

Enable import of colors from 3MF data. Note: This might split the mesh into multiple parts.

Parameters:import (bool) – True to enable import of colors, False to disable.
vrdAtfSettings.setImportCoordSystems(import)

Enable import of coordinate system nodes from CAD data.

Parameters:import (bool) – True to enable import of coordinate systems, False to disable.
vrdAtfSettings.setImportCurves(import)

Enable import of curves and poly lines from CAD files.

Parameters:import (bool) – True to enable import of curves and poly lines, False to disable.
vrdAtfSettings.setImportEmptyLayers(import)

Enable import of empty layers. (Only Alias wire files)

Parameters:import (bool) – True to enable import of empty layers, False to disable.
vrdAtfSettings.setImporterVersion(version)

Select which importer to use. Currently only available for Catia V5 and Jt.

Parameters:version (ImporterVersion) – Enum specifying which importer version to use. Currently only affects Catia V5 and Jt import. Lightweight selects optimized geometry and topology translation. Legacy should only be selected if issues like corrupted geometry should arise.
vrdAtfSettings.setImportGroupMaterials(import)

Enable import of materials applied to group nodes like part, assembly or instance. If enabled, an additional MaterialGroup node is created for each of these materials. If disabled, simply discard these materials.

Parameters:import (bool) – True to enable import of materials applied to group nodes, False to disable.
vrdAtfSettings.setImportInvisibleCurves(import)

Enable import of curves and poly lines, that are invisible in the CAD data.

Note: Only has an effect if import of curves and poly lines is enabled.

Parameters:import (bool) – True to enable import of invisible curves and poly lines, False to disable.
vrdAtfSettings.setImportInvisibleInstances(import)

Enable import of invisible instance nodes instead of excluding them.

Parameters:import (bool) – True to enable import of invisible instance nodes, False to disable.
vrdAtfSettings.setImportInvisibleMeshes(import)

Enable import of polygon meshes, that are invisible in the CAD file.

Note: Only has an effect if import of polygon meshes is enabled.

Parameters:import (bool) – True to import invisible polygon meshes, False to disable.
vrdAtfSettings.setImportInvisibleSurfaces(import)

Enable import of NURBS surfaces, that are invisible in the CAD file.

Note: Only has an effect if import of surfaces is enabled.

Parameters:import (bool) – True to enable import of invisible surfaces, False to disable.
vrdAtfSettings.setImportLayerFolders(import)

Enable import of layer hierarchies. (Only Alias wire files)

Parameters:import (bool) – True to enable import of layer folders, False to disable.
vrdAtfSettings.setImportLights(import)

Enable import of light sources from CAD data. (Only Alias wire files)

Parameters:import (bool) – True to enable import of lights, False to disable.
vrdAtfSettings.setImportMeshes(import)

Enable import of polygon meshes.

Parameters:import (bool) – True to enable import of polygon meshes, False to disable.
vrdAtfSettings.setImportMeshLODs(lodOption)

Select which mesh LODs should be imported.

0 - Import all mesh LODs

1 - Import only mesh with lowest LOD

2 - Import only mesh with highest LOD

Parameters:lodOption (integer) –
vrdAtfSettings.setImportMetadata(import)

Enable import of metadata from CAD data.

Parameters:import (bool) – True to enable import of metadata, False to disable.
vrdAtfSettings.setImportReferencedFiles(import)

Enable import of part files referenced by an assembly. If option is disabled a file reference node is created that can be used to import the referenced part later.

Parameters:import (bool) – True to enable import of part files, False to only create file reference nodes.
vrdAtfSettings.setImportSurfaces(import)

Enable import of NURBS surfaces.

Parameters:import (bool) – True to enable import of surfaces, False to disable.
vrdAtfSettings.setImportSwitchMaterials(import)

Enable import of switch shaders from Alias data.

Parameters:import (bool) – True to enable import of switch shaders from Alias files, False to disable. If disabled only the active choice of switch shaders is imported.
vrdAtfSettings.setImportTemplateGeometries(import)

Enable import of template geometries instead of excluding them. (Only Alias wire files)

Parameters:import (bool) – True to enable import of template geometries, False to disable.
vrdAtfSettings.setImportTextures(import)

Enable import of textures from 3MF data.

Parameters:import (bool) – True to enable import of textures, False to disable.
vrdAtfSettings.setImportVariants(import)

Enable import of variants from CAD data. (Only Alias wire files)

Parameters:import (bool) – True to enable import of variants, False to disable.
vrdAtfSettings.setJtToolkit(toolkit)

Select which Jt toolkit should be used for import.

0 - Parasolid

1 - Jt Open

Parameters:toolkit (integer) –
vrdAtfSettings.setKeepNurbs(keep)

Enable / disable keeping NURBS data instead of deleting it. This option will increase memory usage.

Parameters:keep (bool) – True if empty groups should be removed.
vrdAtfSettings.setMaxChordLength(chordLength)

Set maximum length of a triangle edge in mm. Lower values result in more accurate polygon models but also increase the number of triangles.

Parameters:chordLength (float) – Maximum chord length in mm.
vrdAtfSettings.setMergeGeometries(merge)

Enable / disable merging adjacent surfaces with same material into shells.

Parameters:merge (bool) – True if surfaces should be merged.
vrdAtfSettings.setMergeSubReferenceMaterials(optimize)

Determine if duplicate materials, referenced in different files, should be merged into one single material. Materials with same name and identical properties are regarded as duplicates.

Parameters:optimize (bool) – True if duplicate referenced materials shouild be merged otherwise False.
vrdAtfSettings.setModelState(state)

Select which Inventor model state should be imported.

Parameters:state (ModelState) – Primary (Default) or Last Active model state.
vrdAtfSettings.setNormalTolerance(tolerance)

Set the normal tolerance of adjacent triangles in degrees. Lower values result in more accurate polygon models but also increase the number of triangles.

Parameters:tolerance (float) – Stitiching tolerance in mm.
vrdAtfSettings.setReduceKeyframes(reduce)

Enable reducing the number of keyframes by removing adjacent keyframes with identical value.

Parameters:reduce (bool) – True if number of keyframes should be reduced, False otherwise.
vrdAtfSettings.setRemoveEmptyGroups(remove)

Enable / disable removing of groups without children.

Parameters:remove (bool) – True if empty groups should be removed.
vrdAtfSettings.setSmartReferenceBehavior(behavior)

Determine how references to VRED native files are treated in import.

Parameters:behavior (SmartReferenceBehavior) – Enum specifying if smart references found in imported file should be kept or removed
vrdAtfSettings.setSourceReferenceBehavior(behavior)

Determine how references to files of import file types are treated in import.

Parameters:behavior (SourceReferenceBehavior) – Enum specifying if source references should be created for file references found in the imported files or if no reference nodes at all should be created.
vrdAtfSettings.setStitchingTolerance(tolerance)

Set tolerance in mm where two adjacent edges are considered to be touching and where they should be stitched together.

Parameters:tolerance (float) – Stitiching tolerance in mm.
vrdAtfSettings.setUnshareNodes(unshare)

Enable / Disable conversion of shared node instances to independent nodes.

Parameters:unshare (bool) – True if unsharing nodes should be enabled, False otherwise.
vrdAtfSettings.setUseHealStitch(value)
Parameters:value (bool) –
vrdAtfSettings.setUseLegacyLoader(useLegacy)

Option has no effect anymore. All legacy loaders are retired.

Parameters:useLegacy (bool) – Option has no effect anymore.
vrdAtfSettings.setUseStitching(stitch)

Enable / disable stitching of adjacent edges.

Parameters:stitch (bool) – True to enable stitching, False to disable.
vrdAtfSettings.vrdAtfSettings()

Default constructor.

vrdAtfSettings.vrdAtfSettings(other)
Parameters:other (vrdAtfSettings) –