A structure used to transfer options that control the AlUniverse::retrieve() method.
An AlRetrieveOptions structure is used to 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().
For example:
// No error checking is done here for brevity in the example. AlRetrieveOptions options; AlUniverse::retrieveOptions( options ); options.dxf.units = k_millimeters; options.dxf.in_create_shaders = True; AlUniverse::setRetrieveOptions( options );
See File->Retrieve in the Alias manuals for a more detailed description of these options.
Determines whether or not all retrieved geometry is displayed in quick-wire mode. Only relevant for OpenAlias plug-ins.
Determines if all retrieved geometry is put in the current stage, or 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> (for example, model.iges -> modeliges) and this stage will be made current.
If set to TRUE, the modeling window layout contained in wire files will be retrieved, and if set to FALSE, the window layout will not be retrieved.
If set to TRUE, the cameras contained in wire files will be retrieved, and if set to FALSE, the cameras will not be retrieved.
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.
If set to TRUE, the background contained in wire files will be retrieved, and if set to FALSE, the background will not be retrieved.
If set to TRUE, linear units, angular units, and construction tolerances contained in the wire will be retrieved and set. If set to FALSE, the units and tolerances in the wire file are ignored. Only relevant for OpenAlias plug-ins.
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 relevant for OpenAlias plug-ins.
If set to TRUE, the layer information stored in a wire file will be retrieved and the layers re-created. If set to FALSE, layer information will be ignored and all objects will be placed into the default layer. Only relevant for OpenAlias plug-ins.
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 DXF geometry will be grouped under a node called "DXF_FILE". If set to FALSE, this group node will not be created. The default is FALSE.
If set to TRUE, multiple knots will be removed based on continuity in IGES Parametric Curve and Surface geometry, and all VDAFS curve and surface geometry. The default is FALSE.
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.
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.
This controls the mapping of the IGES/VDAIS/JAMIAS Level. The options are
kLayer, maps level to layer, this is the default
kSet, maps level to set
kLayerAndSet, maps level to layer and set
kNoLayerOrSet, there is no mapping level is ignored.
This option does not apply to VDAFS or C4
This controls the type of curves that will be used in trimming a surface.
The options are
kParameter, use the parameter (2D) space curves, this is the default.
kWorld, use the world (3D) space curves
kUseFlag, use the preference in the IGES/VDAIS/JAMAIS/C4 file
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 import.
Determines whether or not shaders are to be loaded from the "shader" sub-directory of the current project. If set to TRUE, and if there is a shader on disk whose name matches a DXF layer name, then this shader will be loaded (if not already in memory) and assigned to all objects on that layer. If set to FALSE, this process is skipped, and at best, only simple color shaders will be created from the DXF colour information. The default is TRUE.
Determines whether "anonymous" DXF BLOCK entities are processed (TRUE) or ignored (FALSE). The default is FALSE, since mostly, these BLOCK entities contain pattern hatching lines.
Sets the units of the DXF coordinate data, if known, so that the data is properly scaled. This option is necessary since the units of the 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.
