alias_api.AlRetrieveOptions

class alias_api.AlRetrieveOptions

Bases: pybind11_object

A structure used to transfer options that control the retrieve() method.

An AlRetrieveOptions structure is used set or determine the options that the AlUniverse::retrieve() method uses to tailor the import of files. To avoid setting all of the fields of AlRetrieveOptions using AlUniverse::setRetrieveOptions(), it is recommended that the current values be acquired first using AlUniverse::retrieveOptions().

General Options:

new_stage:

Determines if all retrieved geometry is put in the current stage, or is put in a new stage named after the filename. If set to TRUE, then the retrieved geometry will be put in a new stage called <filename><ext> (e.g. model.iges -> modeliges) and this stage will be made current.

Wire File Options:

All wire file options default to TRUE.

keep_windows:

If set to TRUE, the modelling window layout contained in wire files will be retrieved, and if set to FALSE, the window layout will not be retrieved.

ckeep_cameras:

If set to TRUE, the cameras contained in wire files will be retrieved, and if set to FALSE, the cameras will not be retrieved.

keep_animation:

If set to TRUE, both the animation and the model contained in wire files will be retrieved, and if set to FALSE, only the model will be retrieved.

Note: If a window contains an animated camera and keep_animation is TRUE then this window will be retrieved also, even if keep_windows is FALSE.

keep_backgrounds:

If set to TRUE, the background contained in wire files will be retrieved, and if set to FALSE, the background will not be retrieved.

keep_unitsTolerances: If set to TRUE, linear units, angular units, and construction toleranced contained in the wire will be retrieved and set. If set to FALSE, the units and tolerances in the wire file are ignored. Only relevent for OpenAlias plugins.

keep_renderGlobals:

If set to TRUE, the render global information stored in a wire file will be retrieved and set. If set to FALSE, this information will be ignored. Only relevent for OpenAlias plugins.

IGES/VDAIS/C4X/JAMA-IS and VDAFS File Options:

group:

If set to TRUE, all geometry retrieved from the file will be grouped under a node named after the translator. For example, IGES geometry will be grouped under a node called “IGES_FILE”. and STEP geometry will be grouped under a node called “STEP_FILE”. If set to FALSE, this group node node will not be created. The default is FALSE.

coalesce:

If set to TRUE, multiple knots will be removed based on continutity in IGES Parametric Curve and Surface geometry, and all VDAFS curve and surface geometry. The default is FALSE.

annotation:

If set to TRUE, supported geometric entities that have been flagged for use as annotation will be retrieved. If set to FALSE, these entities will not be retrieved. This option does not apply to VDAFS.

trim_to_surf:

If set to TRUE, retrieved Trimmed or Bounded surfaces whose boundaries are the same as, or iso-parametric to, the natural boundaries of the untrimmed surface, will be converted to untrimmed surfaces by shrinking the surface to the trim boundaries. If set to FALSE, trimmed surfaces will be represented as such even if the trim boundary information is unnecessary. The default is TRUE. This option does not apply to VDAFS.

scale:

All retrieved geometry will be scaled by this factor. The default is 1.0.

layer_or_set:

This controls the mapping of the IGES/VDAIS/JAMIAS Level. The options are a) kLayer, maps level to layer, this is the default b) kSet, maps level to set c) kLayerAndSet, maps level to layer and set d) kNoLayerOrSet, there is no mapping level is ignored. This option does not apply to VDAFS or C4

default_trim:

This controls the type of curves that will be used in trimming a surface. The options are a) kParameter, use the parameter (2D) space curves, this is the default. b) kWorld, use the world (3D) space curves c) kUseFlag, use the preference in the IGES/VDAIS/JAMAIS/C4 file NOTE kUseFlag is invalid for VDAFS.

create_scan_data:

This control the conversion of “Scan Data” 106 Forms 1-3, 11-13 and 63. If on this entity is treated as Scan Data on IGES import. During VDAFS import, PSET and MDI entities are treated as Scan Data.

DWG/DXF File Options.

group:

See description above.

stitch:

Determines whether to stitch the surfaces of a solid into a shell (TRUE) or to group them instead (FALSE).

%canonymous_blocks Determines whether “anonymous” DWG/DXF BLOCK entities are processed (TRUE) or ignored (FALSE). The default is FALSE, since mostly, these BLOCK entities contain pattern hatching lines.

units:

If the units of the DWG/DXF coordinate data is known, it can be set using this option so that the data is properly scaled. This option is necessary since the units of the DWG/DXF coordinate data is not stored in the file. The default is inches (kInches), but it can be set to any of the following values: kMiles, kFeet, kInches, kMils, kMicroInches, kKilometers, kMeters, kCentimeters, kMillimeters, or kMicrons.

scale:

See above for description of this field.

property ai

property autocad

property c4

property catiav4_atf

property catiav5_atf

property edf

property fbx

property granite_atf

property iges

property iges_atf

property inventor_atf

property jamais

property jt_atf

property level_map

property new_stage

property nx_atf

property parasolid_atf

property sat

property solidworks_atf

property step_atf

property stl_atf

property trimming_map

property vdafs

property vdais

property wire