< Home

< Table of Contents

REFERENCE MANUAL

Exchange::ImportOptionsKit Class Reference

#include <sprk_exchange.h>

Inheritance diagram for Exchange::ImportOptionsKit:
Sprocket Object

Public Member Functions

bool Empty () const
 
bool Equals (ImportOptionsKit const &in_kit) const
 
 ImportOptionsKit ()
 
 ImportOptionsKit (ImportOptionsKit const &in_kit)
 
 ImportOptionsKit (ImportOptionsKit &&in_that)
 
Type ObjectType () const
 
bool operator!= (ImportOptionsKit const &in_kit) const
 
ImportOptionsKitoperator= (ImportOptionsKit &&in_that)
 
ImportOptionsKitoperator= (ImportOptionsKit const &in_kit)
 
bool operator== (ImportOptionsKit const &in_kit) const
 
void Set (ImportOptionsKit const &in_kit)
 
ImportOptionsKitSetActiveFilter (bool in_state)
 
ImportOptionsKitSetAttributes (bool in_state)
 
ImportOptionsKitSetBRepData (bool in_state)
 
ImportOptionsKitSetBRepMode (BRepMode in_mode)
 
ImportOptionsKitSetCatiaV4LogicalNameForRootDirectory (char const *in_name)
 
ImportOptionsKitSetCatiaV4LogicalNameSearching (bool in_state)
 
ImportOptionsKitSetCatiaV5Cache (bool in_active, char const *in_path)
 
ImportOptionsKitSetConfiguration (char const *in_configuration)
 
ImportOptionsKitSetConfiguration (size_t in_count, UTF8 const in_configuration[])
 
ImportOptionsKitSetConfiguration (UTF8Array const &in_configuration)
 
ImportOptionsKitSetConstructionAndReferences (bool in_state)
 
ImportOptionsKitSetDefaultUnits (Units in_units)
 
ImportOptionsKitSetHiddenObjects (bool in_state)
 
ImportOptionsKitSetIFCAttributeXMLFile (char const *in_filename)
 
ImportOptionsKitSetIFCCodePageName (char const *in_name)
 
ImportOptionsKitSetIFCEdges (bool in_state)
 
ImportOptionsKitSetIFCFaceOptimization (bool in_state)
 
ImportOptionsKitSetIFCMetadata (bool in_state)
 
ImportOptionsKitSetIFCOwnerHistoryOptimization (bool in_state)
 
ImportOptionsKitSetJTTessellationLevel (JT::TessellationLevel in_jt_tessellation_level)
 
ImportOptionsKitSetPDF3DStreamIndex (size_t in_index)
 
ImportOptionsKitSetPMI (bool in_state)
 
ImportOptionsKitSetPMIDefaultColor (RGBColor const &in_color)
 
ImportOptionsKitSetPMIDefaultUnits (Units in_units)
 
ImportOptionsKitSetPMIPrecision (size_t in_precision)
 
ImportOptionsKitSetPMISubstitutionFont (char const *in_font_name, bool in_always_substitute=false)
 
ImportOptionsKitSetProECodePageName (char const *in_name)
 
ImportOptionsKitSetProEDimensionTolerance (bool in_state)
 
ImportOptionsKitSetProESessionColor (ProE::SessionColor in_type)
 
ImportOptionsKitSetProESubpartPMI (bool in_state)
 
ImportOptionsKitSetSearchDirectories (size_t in_count, UTF8 const in_directories[], bool const in_recurse_flags[])
 
ImportOptionsKitSetSearchDirectories (UTF8Array const &in_directories, BoolArray const &in_recurse_flags)
 
ImportOptionsKitSetSearchDirectories (size_t in_count, UTF8 const in_directories[], UTF8 const in_logical_names[], bool const in_recurse_flags[])
 
ImportOptionsKitSetSearchDirectories (UTF8Array const &in_directories, UTF8Array const &in_logical_names, BoolArray const &in_recurse_flags)
 
ImportOptionsKitSetSearchDirectoriesByFile (size_t in_count, UTF8 const in_file_names[])
 
ImportOptionsKitSetSearchDirectoriesByFile (UTF8Array const &in_file_names)
 
ImportOptionsKitSetSolids (bool in_state)
 
ImportOptionsKitSetSTEPCodePageName (char const *in_name)
 
ImportOptionsKitSetSTEPFirstColorPreference (bool in_state)
 
ImportOptionsKitSetSTEPNamePreference (STEP::Field in_field)
 
ImportOptionsKitSetSTEPOrientationHealing (bool in_state)
 
ImportOptionsKitSetSTEPShellBasedSurfaceModelSplitting (bool in_state)
 
ImportOptionsKitSetSurfaces (bool in_state)
 
ImportOptionsKitSetTessellationAccuracy (Tessellation::Accuracy in_type, bool in_accurate_normals=true)
 
ImportOptionsKitSetTessellationLevel (Tessellation::Level in_level)
 
ImportOptionsKitSetTessellationLevel (Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance)
 
ImportOptionsKitSetTessellationMaximumEdgeLength (double in_length)
 
ImportOptionsKitSetTessellationPreservesUVPoints (bool in_state)
 
ImportOptionsKitSetTextureDirectories (size_t in_count, UTF8 const in_directories[])
 
ImportOptionsKitSetTextureDirectories (UTF8Array const &in_directories)
 
ImportOptionsKitSetUnigraphicsFittedCamera (bool in_state)
 
ImportOptionsKitSetUnigraphicsPreferredReferenceSets (size_t in_count, UTF8 const in_reference_sets[], bool in_apply_to_all_levels)
 
ImportOptionsKitSetUnigraphicsPreferredReferenceSets (UTF8Array const &in_reference_sets, bool in_apply_to_all_levels)
 
ImportOptionsKitSetWireframes (bool in_state)
 
void Show (ImportOptionsKit &out_kit) const
 
bool ShowActiveFilter (bool &out_state) const
 
bool ShowAttributes (bool &out_state) const
 
bool ShowBRepData (bool &out_state) const
 
bool ShowBRepMode (BRepMode &out_mode) const
 
bool ShowCatiaV4LogicalNameForRootDirectory (UTF8 &out_name) const
 
bool ShowCatiaV4LogicalNameSearching (bool &out_state) const
 
bool ShowCatiaV5Cache (bool &out_active, UTF8 &out_path) const
 
bool ShowConfiguration (UTF8Array &out_configuration) const
 
bool ShowConstructionAndReferences (bool &out_state) const
 
bool ShowDefaultUnits (Units &out_units) const
 
bool ShowHiddenObjects (bool &out_state) const
 
bool ShowIFCAttributeXMLFile (UTF8 &out_filename) const
 
bool ShowIFCCodePageName (UTF8 &out_name) const
 
bool ShowIFCEdges (bool &out_state) const
 
bool ShowIFCFaceOptimization (bool &out_state) const
 
bool ShowIFCMetadata (bool &out_state) const
 
bool ShowIFCOwnerHistoryOptimization (bool &out_state) const
 
bool ShowJTTessellationLevel (JT::TessellationLevel &out_tessellation_level) const
 
bool ShowPDF3DStreamIndex (size_t &out_index) const
 
bool ShowPMI (bool &out_state) const
 
bool ShowPMIDefaultColor (RGBColor &out_color) const
 
bool ShowPMIDefaultUnits (Units &out_units) const
 
bool ShowPMIPrecision (size_t &out_precision) const
 
bool ShowPMISubstitutionFont (UTF8 &out_font_name, bool &out_always_substitute) const
 
bool ShowProECodePageName (UTF8 &out_name) const
 
bool ShowProEDimensionTolerance (bool &out_state) const
 
bool ShowProESessionColor (ProE::SessionColor &out_type) const
 
bool ShowProESubpartPMI (bool &out_state) const
 
bool ShowSearchDirectories (UTF8Array &out_directories, UTF8Array &out_logical_names, BoolArray &out_recurse_flags) const
 
bool ShowSearchDirectoriesByFile (UTF8Array &out_file_names) const
 
bool ShowSolids (bool &out_state) const
 
bool ShowSTEPCodePageName (UTF8 &out_name) const
 
bool ShowSTEPFirstColorPreference (bool &out_state) const
 
bool ShowSTEPNamePreference (STEP::Field &out_field) const
 
bool ShowSTEPOrientationHealing (bool &out_state) const
 
bool ShowSTEPShellBasedSurfaceModelSplitting (bool &out_state) const
 
bool ShowSurfaces (bool &out_state) const
 
bool ShowTessellationAccuracy (Tessellation::Accuracy &out_type, bool &out_accurate_normals) const
 
bool ShowTessellationLevel (Tessellation::Type &out_type, Tessellation::Level &out_level, Tessellation::Chord::Limit &out_limit_type, double &out_limit, double &out_angle_tolerance) const
 
bool ShowTessellationMaximumEdgeLength (double &out_length) const
 
bool ShowTessellationPreservesUVPoints (bool &out_state) const
 
bool ShowTextureDirectories (UTF8Array &out_directories)
 
bool ShowUnigraphicsFittedCamera (bool &out_state) const
 
bool ShowUnigraphicsPreferredReferenceSets (UTF8Array &out_reference_sets, bool &out_apply_to_all_levels) const
 
bool ShowWireframes (bool &out_state) const
 
ImportOptionsKitUnsetActiveFilter ()
 
ImportOptionsKitUnsetAttributes ()
 
ImportOptionsKitUnsetBRepData ()
 
ImportOptionsKitUnsetBRepMode ()
 
ImportOptionsKitUnsetCatiaV4LogicalNameForRootDirectory ()
 
ImportOptionsKitUnsetCatiaV4LogicalNameSearching ()
 
ImportOptionsKitUnsetCatiaV5Cache ()
 
ImportOptionsKitUnsetConfiguration ()
 
ImportOptionsKitUnsetConstructionAndReferences ()
 
ImportOptionsKitUnsetDefaultUnits ()
 
ImportOptionsKitUnsetEverything ()
 
ImportOptionsKitUnsetHiddenObjects ()
 
ImportOptionsKitUnsetIFCAttributeXMLFile ()
 
ImportOptionsKitUnsetIFCCodePageName ()
 
ImportOptionsKitUnsetIFCEdges ()
 
ImportOptionsKitUnsetIFCFaceOptimization ()
 
ImportOptionsKitUnsetIFCMetadata ()
 
ImportOptionsKitUnsetIFCOwnerHistoryOptimization ()
 
ImportOptionsKitUnsetJTTessellationLevel ()
 
ImportOptionsKitUnsetPDF3DStreamIndex ()
 
ImportOptionsKitUnsetPMI ()
 
ImportOptionsKitUnsetPMIDefaultColor ()
 
ImportOptionsKitUnsetPMIDefaultUnits ()
 
ImportOptionsKitUnsetPMIPrecision ()
 
ImportOptionsKitUnsetPMISubstitutionFont ()
 
ImportOptionsKitUnsetProECodePageName ()
 
ImportOptionsKitUnsetProEDimensionTolerance ()
 
ImportOptionsKitUnsetProESessionColor ()
 
ImportOptionsKitUnsetProESubpartPMI ()
 
ImportOptionsKitUnsetSearchDirectories ()
 
ImportOptionsKitUnsetSearchDirectoriesByFile ()
 
ImportOptionsKitUnsetSolids ()
 
ImportOptionsKitUnsetSTEPCodePageName ()
 
ImportOptionsKitUnsetSTEPFirstColorPreference ()
 
ImportOptionsKitUnsetSTEPNamePreference ()
 
ImportOptionsKitUnsetSTEPOrientationHealing ()
 
ImportOptionsKitUnsetSTEPShellBasedSurfaceModelSplitting ()
 
ImportOptionsKitUnsetSurfaces ()
 
ImportOptionsKitUnsetTessellationAccuracy ()
 
ImportOptionsKitUnsetTessellationLevel ()
 
ImportOptionsKitUnsetTessellationMaximumEdgeLength ()
 
ImportOptionsKitUnsetTessellationPreservesUVPoints ()
 
ImportOptionsKitUnsetTextureDirectories ()
 
ImportOptionsKitUnsetUnigraphicsFittedCamera ()
 
ImportOptionsKitUnsetUnigraphicsPreferredReferenceSets ()
 
ImportOptionsKitUnsetWireframes ()
 
- Public Member Functions inherited from Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Static Public Member Functions

static ImportOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Additional Inherited Members

- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 

Detailed Description

The Exchange::ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via Exchange. Calling Exchange::ImportOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

Exchange::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

Exchange::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit const &  in_kit)

The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
Exchange::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit &&  in_that)

The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.

Member Function Documentation

bool Exchange::ImportOptionsKit::Empty ( ) const
virtual

Indicates whether this ImportOptionsKit has any values set on it.

Returns
true if no values are set on this ImportOptionsKit, false otherwise.

Reimplemented from Object.

bool Exchange::ImportOptionsKit::Equals ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
static ImportOptionsKit Exchange::ImportOptionsKit::GetDefault ( )
static

Creates an ImportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File::Import.

Returns
An ImportOptionsKit with the default settings.
Type Exchange::ImportOptionsKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from Object.

bool Exchange::ImportOptionsKit::operator!= ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.
ImportOptionsKit& Exchange::ImportOptionsKit::operator= ( ImportOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::operator= ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
Returns
A reference to this ImportOptionsKit.
bool Exchange::ImportOptionsKit::operator== ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
void Exchange::ImportOptionsKit::Set ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
ImportOptionsKit& Exchange::ImportOptionsKit::SetActiveFilter ( bool  in_state)

Sets whether to only import data from the active filter in the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadActiveFilter.

Parameters
in_stateWhether to only import data from the active filter in the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetAttributes ( bool  in_state)

Sets whether to import attributes (or metadata) from the CAD file. Even if attributes are not imported, some things like names and certain IDs will be available, though all other attributes will not be. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadAttributes.

Parameters
in_stateWhether to import attributes from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetBRepData ( bool  in_state)

Sets whether to import BRep data from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_eReadGeomTessMode.

Parameters
in_stateWhether to import BRep data from the CAD file.
Returns
A reference to this ImportOptionsKit.
Deprecated:
This function has been superseded by SetBRepMode.
ImportOptionsKit& Exchange::ImportOptionsKit::SetBRepMode ( BRepMode  in_mode)

Sets the import mode for BRep data in the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_eReadGeomTessMode.

Parameters
in_modeThe import mode for BRep data in the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetCatiaV4LogicalNameForRootDirectory ( char const *  in_name)

Sets the logical name for the root directory for a Catia V4 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV4Data::m_pcRootDirLogicalName.

Parameters
in_nameUTF8-encoded logical name for the root directory for a Catia V4 file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetCatiaV4LogicalNameSearching ( bool  in_state)

Sets the whether to allow searching in additional logical names for a Catia V4 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV4Data::m_bAllowSearchInOtherLogicalNames.

Parameters
in_stateWhether to allow searching in addtional logical names for a Catia V4 file.
Returns
A reference to this ImportOptionsKit.
See also
SetSearchDirectories
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetCatiaV5Cache ( bool  in_active,
char const *  in_path 
)

Sets whether to use the a cache for a Catia V5 file.

Parameters
in_activeWhether the cache should be activated for a Catia V5 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV5Data::m_bCacheActivation.
in_pathUTF8-encoded path to the folder to be used for the Catia V5 cache. This corresponds to the value that will be passed to and A3DRWParamsCatiaV5Data::m_pcCachePath.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetConfiguration ( char const *  in_configuration)

Sets the configuration to import from a CAD file. This is only applicable to Catia V4, Solidworks and I-deas file formats. If no configuration is specified, the default configuration will be loaded if possible. This corresponds to the value that will be passed to A3DRWParamsMultiEntriesData::m_ppcEntries.

Parameters
in_configurationUTF8-encoded configuration name to import from a CAD file.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetConfiguration ( size_t  in_count,
UTF8 const  in_configuration[] 
)

Sets a nested configuration to import from a CAD file. This is only applicable to Catia V4, Solidworks and I-deas file formats. If no configuration is specified, the default configuration will be loaded if possible. These correspond to the values that will be passed to A3DRWParamsMultiEntriesData::m_ppcEntries.

Parameters
in_countSize of the following array.
in_configurationList of nested configuration names to import from a CAD file.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetConfiguration ( UTF8Array const &  in_configuration)

Sets a nested configuration to import from a CAD file. This is only applicable to Catia V4, Solidworks and I-deas file formats. If no configuration is specified, the default configuration will be loaded if possible. These correspond to the values that will be passed to A3DRWParamsMultiEntriesData::m_ppcEntries.

Parameters
in_configurationList of nested configuration names to import from a CAD file.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetConstructionAndReferences ( bool  in_state)

Sets whether to import construction and references from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadConstructionAndReferences.

Parameters
in_stateWhether to import construction and references from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetDefaultUnits ( Units  in_units)

Sets the units to use for a CAD file if it is not well defined. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_eDefaultUnit.

Parameters
in_unitsThe units to use for the CAD file if it is not well defined.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetHiddenObjects ( bool  in_state)

Sets whether to import hidden objects from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadHiddenObjects.

Parameters
in_stateWhether to import hidden objects from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetIFCAttributeXMLFile ( char const *  in_filename)

Sets the file to write attribute data to in XML format for an IFC file. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_pcXMLFilePathForAttributes.

Parameters
in_filenameUTF8-encoded filename for attribute data.
Returns
A reference to this ImportOptionsKit.
See also
SetAttributes
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetIFCCodePageName ( char const *  in_name)

Sets the code page name for an IFC file. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_pcCodePageName.

Parameters
in_nameUTF8-encoded code page name for an IFC file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetIFCEdges ( bool  in_state)

Sets whether to import edges for IFC files When this is set to false the import time will decrease. It is still possible to achieve visual fidelity by turning on hard edge visibility.

Parameters
in_stateWhether to import edges for an IFC file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetIFCFaceOptimization ( bool  in_state)

Sets whether to optimize importing of faces. Setting this to true will reduce the number of polyhedra generated during the import. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bFACETED_BREPAsOnFace.

Parameters
in_stateWhether to optimize face import for an IFC file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetIFCMetadata ( bool  in_state)

Sets whether to import all IFC metadata or to import only each part's GloablID. . This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bAttributesOnlyGlobalId.

Parameters
in_stateWhether to import all IFC metadata or to import only each part's GlobalID
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetIFCOwnerHistoryOptimization ( bool  in_state)

Sets whether to optimize the setting of IFCOWNERHISTORY for an IFC file. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bIFCOWNERHISTORYOptimized.

Parameters
in_stateWhether to optimize the setting of IFCOWNERHISTORY for an IFC file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetJTTessellationLevel ( JT::TessellationLevel  in_jt_tessellation_level)

Sets the tessellation level to load for JT files.

Parameters
in_jt_tessellation_levelThe tessellation level to load.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetPDF3DStreamIndex ( size_t  in_index)

Sets the index into the list 3D streams contained in a PDF to load.

Parameters
in_indexThe index into the list of 3D stream contained in a PDF to load.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetPMI ( bool  in_state)

Sets whether to import PMI from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadPmis.

Parameters
in_stateWhether to import PMI from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetPMIDefaultColor ( RGBColor const &  in_color)

Sets the color to use for the PMI in the CAD file if none is specified. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_sDefaultColor.

Parameters
in_colorThe color to use for the PMI in the CAD file if none is specified.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetPMIDefaultUnits ( Units  in_units)

Sets the units to use for the PMI in the CAD file if it is not well defined. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_eDefaultUnit.

Parameters
in_unitsThe units to use for the PMI in the CAD file if it is not well defined.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetPMIPrecision ( size_t  in_precision)

Sets the precision to use for PMI which has no precision information in the CAD file. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_iNumberOfDigitsAfterDot.

Parameters
in_precisionThe precision to use for PMI which has no precision information in the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetPMISubstitutionFont ( char const *  in_font_name,
bool  in_always_substitute = false 
)

Sets the font to use to replace those referenced by the CAD file but which are not present on the system.

Parameters
in_font_nameUTF8-encoded name of the font to use to replaced those referenced by the CAD file but which are not present on the system. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_pcSubstitutionFont.
in_always_substituteWhether to always use this font even in place of those which are present on the system. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_bAlwaysSubstituteFont.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetProECodePageName ( char const *  in_name)

Sets the code page name for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_pcCodePageName.

Parameters
in_nameUTF8-encoded code page name for a Pro/E file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetProEDimensionTolerance ( bool  in_state)

Sets whether to import dimension tolerances for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bDisplayTolerance.

Parameters
in_stateWhether to import dimension tolerances for a Pro/E file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetProESessionColor ( ProE::SessionColor  in_type)

Sets the session color for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_eSessionColorType.

Parameters
in_typeThe session color for a Pro/E file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetProESubpartPMI ( bool  in_state)

Sets whether to import subpart PMI for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bDisplaySubpartAnnotations.

Parameters
in_stateWhether to import subpart PMI for a Pro/E file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetSearchDirectories ( size_t  in_count,
UTF8 const  in_directories[],
bool const  in_recurse_flags[] 
)

Sets the directories to search to find files referenced by a CAD assembly. If no search directories are set, the directory containing the CAD assembly will be searched recursively. These correspond to the values that will be passed to A3DRWParamsAssemblyData::m_ppcSearchDirectories.

Parameters
in_countSize of the following arrays.
in_directoriesThe directories to search for files references by a CAD assembly.
in_recurse_flagsWhether to search recursively in each of the corresponding directories.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetSearchDirectories ( UTF8Array const &  in_directories,
BoolArray const &  in_recurse_flags 
)

Sets the directories to search to find files referenced by a CAD assembly. If no search directories are set, the directory containing the CAD assembly will be searched recursively. If the size of the directory and flag arrays are different, the smaller size will be used. These correspond to the values that will be passed to A3DRWParamsAssemblyData::m_ppcSearchDirectories.

Parameters
in_directoriesThe directories to search for files references by a CAD assembly.
in_recurse_flagsWhether to search recursively in each of the corresponding directories.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetSearchDirectories ( size_t  in_count,
UTF8 const  in_directories[],
UTF8 const  in_logical_names[],
bool const  in_recurse_flags[] 
)

Sets the directories to search to find files referenced by a CAD assembly. This variant additionally allows the specification of logical names for each search directory for use by Catia V4 files. If no search directories are set, the directory containing the CAD assembly will be searched recursively. These correspond to the values that will be passed to A3DRWParamsAssemblyData::m_ppcSearchDirectories.

Parameters
in_countSize of the following arrays.
in_directoriesThe directories to search for files references by a CAD assembly.
in_logical_namesThe logical names for each corresponding directory. If there are no logical names for the directories, this value can be null.
in_recurse_flagsWhether to search recursively in each of the corresponding directories.
Returns
A reference to this ImportOptionsKit.
See also
SetCatiaV4LogicalNameSearching
ImportOptionsKit& Exchange::ImportOptionsKit::SetSearchDirectories ( UTF8Array const &  in_directories,
UTF8Array const &  in_logical_names,
BoolArray const &  in_recurse_flags 
)

Sets the directories to search to find files referenced by a CAD assembly. This variant additionally allows the specification of logical names for each search directory for use by Catia V4 files. If no search directories are set, the directory containing the CAD assembly will be searched recursively. If the size of the directory, (non-empty) logical name, or flag arrays are different, the smallest size will be used. These correspond to the values that will be passed to A3DRWParamsAssemblyData::m_ppcSearchDirectories.

Parameters
in_directoriesThe directories to search for files references by a CAD assembly.
in_logical_namesThe logical names for each corresponding directory. If there are no logical names for the directories, this array can be empty.
in_recurse_flagsWhether to search recursively in each of the corresponding directories.
Returns
A reference to this ImportOptionsKit.
See also
SetCatiaV4LogicalNameSearching
ImportOptionsKit& Exchange::ImportOptionsKit::SetSearchDirectoriesByFile ( size_t  in_count,
UTF8 const  in_file_names[] 
)

Sets the directories to search to find files referenced by a CAD assembly. This is an alternative manner to specify search directories by using text files which contain lists of directories to search. These correspond to the values will be passed to A3DRWParamsAssemblyData::m_ppcPathDefinitions.

Parameters
in_countSize of the following array.
in_file_namesThe names of text files containing the lists of directories to search to find files referenced by a CAD assembly.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetSearchDirectoriesByFile ( UTF8Array const &  in_file_names)

Sets the directories to search to find files referenced by a CAD assembly. This is an alternative manner to specify search directories by using text files which contain lists of directories to search. These correspond to the values will be passed to A3DRWParamsAssemblyData::m_ppcPathDefinitions.

Parameters
in_file_namesThe names of text files containing the lists of directories to search to find files referenced by a CAD assembly.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetSolids ( bool  in_state)

Sets whether to import solids from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadSolids.

Parameters
in_stateWhether to import solids from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetSTEPCodePageName ( char const *  in_name)

Sets the code page name for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_pcCodePageName

Parameters
UTF8-encodedcode page name for a STEP file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetSTEPFirstColorPreference ( bool  in_state)

Sets whether to prefer the first color if geometry has several colors for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_bPreferFirstColor.

Parameters
in_stateWhether to prefer the first color if geometry has several colors for a STEP file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetSTEPNamePreference ( STEP::Field  in_field)

Sets the field to get the occurrence name from for a STEP file. These correspond to the value that will be passed to A3DRWParamsStepData::m_bPreferProductName and A3DRWParamsStepData::m_eNameFromNAUO.

Parameters
in_fieldThe field to get the occurrence name from for a STEP file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetSTEPOrientationHealing ( bool  in_state)

Sets whether to heal orientations for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_bHealOrientations.

Parameters
in_stateWhether to heal orientations for a STEP file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetSTEPShellBasedSurfaceModelSplitting ( bool  in_state)

Sets whether to split SHELL_BASED_SURFACE_MODEL with several OPEN_SHELLs into several bodies for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_bSplitSHELL_BASED_SURFACE_MODEL.

Parameters
in_stateWhether to split SHELL_BASED_SURFACE_MODEL with several OPEN_SHELLs into several bodies for a STEP file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetSurfaces ( bool  in_state)

Sets whether to import surfaces from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadSurfaces.

Parameters
in_stateWhether to import surfaces from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetTessellationAccuracy ( Tessellation::Accuracy  in_type,
bool  in_accurate_normals = true 
)

Sets the accuracy of the tessellation that will be generated for BRep data.

Parameters
in_typeThe accuracy to use for tessellation generation.
in_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation::Accuracy::Accurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetTessellationLevel ( Tessellation::Level  in_level)

Sets the predefined quality of the tessellation that will be generated for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_eTessellationLevelOfDetail.

Parameters
in_levelThe predefined quality of the tessellation that will be generated for BRep data.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetTessellationLevel ( Tessellation::Chord::Limit  in_limit_type,
double  in_limit,
double  in_angle_tolerance 
)

Sets the user defined quality of the tessellation that will be generated for BRep data. This implicitly sets A3DRWParamsTessellationData::m_eTessellationLevel to kA3DTessLODUserDefined.

Parameters
in_limit_typeThe type of the chord limit to be specified.
in_limitEither the ratio of the tessellation chord height to the bounding box height which should be in the range [50, 10000], or the maximum distance between the surface definition and the tessellation approximation, depending on the preceding argument.
in_angle_toleranceThe maximum angle in degrees between two consecutive wire elements in the generated tessellation which should be in the range [10, 40]. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_dAngleToleranceDeg.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetTessellationMaximumEdgeLength ( double  in_length)

Sets the maximum length of triangle edges in the tessellation generated for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_dMaximalTriangleEdgeLength.

Parameters
in_lengthThe maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative, and if set to 0.0, the length will not be used when generating the tessellation.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetTessellationPreservesUVPoints ( bool  in_state)

Sets whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. This corresponds to the value that will be passed to A3DRWParamsTessellationData::m_bKeepUVPoints.

Parameters
in_stateWhether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetTextureDirectories ( size_t  in_count,
UTF8 const  in_directories[] 
)

Sets the directories to search to find textures referenced by a CAD assembly. If no search directories are set, the directory containing the CAD assembly will be searched recursively. These correspond to the values that will be passed to A3DRWParamsGeneralData::m_ppcSearchTextureDirectories.

Parameters
in_countSize of the following arrays.
in_directoriesThe directories to search for textures referenced by a CAD assembly.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetTextureDirectories ( UTF8Array const &  in_directories)

Sets the directories to search to find textures referenced by a CAD assembly. If no search directories are set, the directory containing the CAD assembly will be searched recursively. These correspond to the values that will be passed to A3DRWParamsGeneralData::m_ppcSearchTextureDirectories.

Parameters
in_directoriesThe directories to search for textures referenced by a CAD assembly.
Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::SetUnigraphicsFittedCamera ( bool  in_state)

Sets whether to make view cameras fitted for a Unigraphics file.

Parameters
in_stateWhether to make view cameras fit all visible geometry for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_bFitAllToUpdateViewCameras.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetUnigraphicsPreferredReferenceSets ( size_t  in_count,
UTF8 const  in_reference_sets[],
bool  in_apply_to_all_levels 
)

Sets the preferred reference sets for a Unigraphics file.

Parameters
in_countSize of the following array.
in_reference_setsList of preferred references sets for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_ppcPreferredReferenceSets.
in_apply_to_all_levelsWhether the reference sets will apply to subassemblies for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_bApplyToAllLevels.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetUnigraphicsPreferredReferenceSets ( UTF8Array const &  in_reference_sets,
bool  in_apply_to_all_levels 
)

Sets the preferred reference sets for a Unigraphics file.

Parameters
in_reference_setsList of preferred references sets for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_ppcPreferredReferenceSets.
in_apply_to_all_levelsWhether the reference sets will apply to subassemblies for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_bApplyToAllLevels.
Returns
A reference to this ImportOptionsKit.
See also
Default value
ImportOptionsKit& Exchange::ImportOptionsKit::SetWireframes ( bool  in_state)

Sets whether to import wireframes from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadWireframes.

Parameters
in_stateWhether to import wireframes from the CAD file.
Returns
A reference to this ImportOptionsKit.
See also
Default value
void Exchange::ImportOptionsKit::Show ( ImportOptionsKit out_kit) const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.
bool Exchange::ImportOptionsKit::ShowActiveFilter ( bool &  out_state) const

Shows the active filter import setting.

Parameters
out_stateWhether to only import data from the active filter in the CAD file.
Returns
true if an active filter import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowAttributes ( bool &  out_state) const

Shows the attribute import setting.

Parameters
out_stateWhether to import attributes from the CAD file.
Returns
true if an attribute import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowBRepData ( bool &  out_state) const

Shows the BRep data import setting.

Parameters
out_stateWhether to import BRep data from the CAD file.
Returns
true if a BRep data import setting was specified, false otherwise.
Deprecated:
This function has been superseded by ShowBRepMode.
bool Exchange::ImportOptionsKit::ShowBRepMode ( BRepMode out_mode) const

Shows the BRep mode import setting.

Parameters
out_modeThe import mode for BRep data in the CAD file.
Returns
true if a BRep mode import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowCatiaV4LogicalNameForRootDirectory ( UTF8 out_name) const

Shows the Catia V4 logical name for the root directory.

Parameters
out_nameThe Catia V4 logical name for the root directory.
Returns
true if a Catia V4 logical name for the root directory setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowCatiaV4LogicalNameSearching ( bool &  out_state) const

Shows the Catia V4 logical name searching setting.

Parameters
out_stateWhether to allow searching in addtional logical names for a Catia V4 file.
Returns
true if a Catia V4 logical name searching setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowCatiaV5Cache ( bool &  out_active,
UTF8 out_path 
) const

Shows the Catia V5 cache setting.

Parameters
out_activeWhether the cache should be activated for a Catia V5 file.
out_pathThe path to the folder to be used for the Catia V5 cache.
Returns
true if a Catia V5 cache setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowConfiguration ( UTF8Array &  out_configuration) const

Shows the configuration settting.

Parameters
out_configurationList of nested configuration names to import from a CAD file.
Returns
true if a configuation setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowConstructionAndReferences ( bool &  out_state) const

Shows the construction and references import setting.

Parameters
out_stateWhether to import construction and references from the CAD file.
Returns
true if a construction and references import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowDefaultUnits ( Units out_units) const

Shows the default units setting.

Parameters
out_unitsThe default units setting.
Returns
true if a default units setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowHiddenObjects ( bool &  out_state) const

Shows the hidden objects import setting.

Parameters
out_stateWhether to import hidden objects from the CAD file.
Returns
true if a hidden objects import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowIFCAttributeXMLFile ( UTF8 out_filename) const

Shows the IFC attribute XML file setting.

Parameters
out_filenameThe filename for attribute data for an IFC file.
Returns
true if an IFC attribute XML file setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowIFCCodePageName ( UTF8 out_name) const

Shows the IFC code page name setting.

Parameters
out_nameThe code page name for an IFC file.
Returns
true if an IFC code page name setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowIFCEdges ( bool &  out_state) const

Shows the IFC edges setting.

Parameters
out_stateWhether to import edges for an IFC file.
Returns
true if an IFC edge setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowIFCFaceOptimization ( bool &  out_state) const

Shows the IFC face optimization setting.

Parameters
out_stateWhether to optimize face import for an IFC file.
Returns
true if an IFC face optimization setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowIFCMetadata ( bool &  out_state) const

Shows the IFC metadata setting.

Parameters
out_stateWhether to import all IFC metadata or just each part's GloablID
Returns
true if an IFC metadata setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowIFCOwnerHistoryOptimization ( bool &  out_state) const

Shows the IFC owner history optimization setting.

Parameters
out_stateWhether to optimize the setting of IFCOWNERHISTORY for an IFC file.
Returns
true if an IFC owner history optimization setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowJTTessellationLevel ( JT::TessellationLevel out_tessellation_level) const

Shows the JT tessellation level setting.

Parameters
out_tessellation_levelThe tessellation level used when loading the JT file
Returns
true if a JT tessellation level setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowPDF3DStreamIndex ( size_t &  out_index) const

Shows the PDF 3D stream index setting.

Parameters
out_indexThe index into the list of 3D stream contained in a PDF to load.
Returns
true if a PDF 3D stream index setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowPMI ( bool &  out_state) const

Shows the PMI import setting.

Parameters
out_stateWhether to import PMI from the CAD file.
Returns
true if a PMI import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowPMIDefaultColor ( RGBColor out_color) const

Shows the PMI default color setting.

Parameters
out_colorThe PMI default color setting.
Returns
true if a PMI default color setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowPMIDefaultUnits ( Units out_units) const

Shows the PMI default units setting.

Parameters
out_unitsThe PMI default units setting.
Returns
true if a PMI default units setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowPMIPrecision ( size_t &  out_precision) const

Shows the PMI precision setting.

Parameters
out_precisionThe precision to use for PMI which has no precision information in the CAD file.
Returns
true if a PMI precision setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowPMISubstitutionFont ( UTF8 out_font_name,
bool &  out_always_substitute 
) const

Shows the PMI substitution font setting.

Parameters
out_font_nameUTF8-encoded name of the font to use to replaced those referenced by the CAD file but which are not present on the system.
out_always_substituteWhether to always use this font even in place of those which are present on the system.
Returns
true if a PMI substitution font setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowProECodePageName ( UTF8 out_name) const

Shows the Pro/E code page name setting.

Parameters
out_nameThe code page name for a Pro/E file.
Returns
true if a Pro/E code page name setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowProEDimensionTolerance ( bool &  out_state) const

Shows the Pro/E dimension tolerance setting.

Parameters
out_stateWhether to import dimension tolerances for a Pro/E file.
Returns
true if a Pro/E dimension tolerance setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowProESessionColor ( ProE::SessionColor out_type) const

Shows the Pro/E session color setting.

Parameters
out_typeThe session color for a Pro/E file.
Returns
true if a Pro/E session color setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowProESubpartPMI ( bool &  out_state) const

Shows the Pro/E subpart PMI setting.

Parameters
out_stateWhether to import subpart PMI for a Pro/E file.
Returns
true if a Pro/E subpart PMI setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSearchDirectories ( UTF8Array &  out_directories,
UTF8Array &  out_logical_names,
BoolArray &  out_recurse_flags 
) const

Shows the search directories setting.

Parameters
out_directoriesThe directories to search for files referenced by a CAD assembly.
out_logical_namesThe logical names for each corresponding directory. If there are no logical names for the directories, this array can be empty.
out_recurse_flagsWhether to search recursively in each of the corresponding directories.
Returns
true if a search directories setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSearchDirectoriesByFile ( UTF8Array &  out_file_names) const

Shows the search directories by file setting.

Parameters
out_file_namesThe names of text files containing the lists of directories to search to find files referenced by a CAD assembly.
Returns
true if a search directories by file setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSolids ( bool &  out_state) const

Shows the solid import setting.

Parameters
out_stateWhether to import solids from the CAD file.
Returns
true if a solid import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSTEPCodePageName ( UTF8 out_name) const

Shows the STEP code page name setting.

Parameters
out_nameThe code page name for a STEP file.
Returns
true if a STEP code page name setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSTEPFirstColorPreference ( bool &  out_state) const

Shows the STEP first color preference setting.

Parameters
out_stateWhether to prefer the first color if geometry has several colors for a STEP file.
Returns
true if a STEP first color preference setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSTEPNamePreference ( STEP::Field out_field) const

Shows the STEP name preference setting.

Parameters
out_fieldThe field to get the occurrence name from for a STEP file.
Returns
true if a STEP name preference setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSTEPOrientationHealing ( bool &  out_state) const

Shows the STEP orientation healing setting.

Parameters
out_stateThe orientation healing setting for a STEP file.
Returns
true if a STEP orientation healing setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSTEPShellBasedSurfaceModelSplitting ( bool &  out_state) const

Shows the STEP shell based surface model splitting setting.

Parameters
out_stateWhether to split SHELL_BASED_SURFACE_MODEL with several OPEN_SHELLs into several bodies for a STEP file.
Returns
true if a STEP shell based surface model splitting setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowSurfaces ( bool &  out_state) const

Shows the surface import setting.

Parameters
out_stateWhether to import surfaces from the CAD file.
Returns
true if a surface import setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowTessellationAccuracy ( Tessellation::Accuracy out_type,
bool &  out_accurate_normals 
) const

Shows the tessellation accuracy setting.

Parameters
out_typeThe type of the tessellation accuracy which was specified.
out_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if out_type is Tessellation::Accuracy::Accurate.
Returns
true if a tessellation accuracy setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowTessellationLevel ( Tessellation::Type out_type,
Tessellation::Level out_level,
Tessellation::Chord::Limit out_limit_type,
double &  out_limit,
double &  out_angle_tolerance 
) const

Shows the tessellation level setting.

Parameters
out_typeThe type of the tessellation level setting which was specified.
out_levelThe predefined quality of the tessellation that will be generated for BRep data. This is only valid if out_type is Tessellation::Type::Standard.
out_limit_typeThe type of chord limit which was specified. This is only valid if out_type is Tessellation::Type::Custom.
out_limitThe chord limit to use to generate tessellation for BRep data. Its interpretation depends on the preceding argument. This is only valid if out_type is Tessellation::Type::Custom.
out_angle_toleranceThe maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation::Type::Custom.
Returns
true if a tessellation level setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowTessellationMaximumEdgeLength ( double &  out_length) const

Shows the tessellation maximum edge length setting.

Parameters
out_lenthThe tessellation maximum edge length setting.
Returns
true if a tessellation maximum edge length setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowTessellationPreservesUVPoints ( bool &  out_state) const

Shows the tessellation UV preservation setting.

Parameters
out_stateWhether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
Returns
true if a tessellation UV preservation setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowTextureDirectories ( UTF8Array &  out_directories)

Shows the texture search directories setting.

Parameters
out_directoriesThe directories to search for textures referenced by a CAD assembly.
Returns
true if a texture search directories setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowUnigraphicsFittedCamera ( bool &  out_state) const

Shows the Unigraphics fitted camera setting.

Parameters
out_stateWhether to make view cameras fit all visible geometry for a Unigraphics file.
Returns
true if a Unigraphics fitted camera setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowUnigraphicsPreferredReferenceSets ( UTF8Array &  out_reference_sets,
bool &  out_apply_to_all_levels 
) const

Shows the Unigraphics preferred reference sets setting.

Parameters
out_reference_setsList of preferred references sets for a Unigraphics file.
out_apply_to_all_levelsWhether the reference sets will apply to subassemblies for a Unigraphics file.
Returns
true if a Unigraphics preferred reference sets setting was specified, false otherwise.
bool Exchange::ImportOptionsKit::ShowWireframes ( bool &  out_state) const

Shows the wireframe import setting.

Parameters
out_stateWhether to import wireframes from the CAD file.
Returns
true if a wireframe import setting was specified, false otherwise.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetActiveFilter ( )

Removes the active filter import state.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetAttributes ( )

Removes the attribute import state.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetBRepData ( )

Removes the BRep data import state.

Returns
A reference to this ImportOptionsKit.
Deprecated:
This function has been superseded by UnsetBRepMode.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetBRepMode ( )

Removes the BRep mode import setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetCatiaV4LogicalNameForRootDirectory ( )

Removes the Catia V4 logical name for the root directory setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetCatiaV4LogicalNameSearching ( )

Removes the Catia V4 logical name searching setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetCatiaV5Cache ( )

Removes the Catia V5 cache setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetConfiguration ( )

Removes the configuration setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetConstructionAndReferences ( )

Removes the construction and references import state.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetDefaultUnits ( )

Removes the default units setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetHiddenObjects ( )

Removes the hidden objects import state.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetIFCAttributeXMLFile ( )

Removes the IFC attribute XML file setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetIFCCodePageName ( )

Removes the IFC code page name setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetIFCEdges ( )

Removes the IFC edges setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetIFCFaceOptimization ( )

Removes the IFC face optimization setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetIFCMetadata ( )

Removes the IFC metadata setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetIFCOwnerHistoryOptimization ( )

Removes the IFC owner history optimization setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetJTTessellationLevel ( )

Removes the JT tessellation level setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetPDF3DStreamIndex ( )

Removes the PDF 3D stream index setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetPMI ( )

Removes the PMI import state.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetPMIDefaultColor ( )

Removes the PMI default color setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetPMIDefaultUnits ( )

Removes the PMI default units setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetPMIPrecision ( )

Removes the PMI precision setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetPMISubstitutionFont ( )

Removes the PMI substitution font setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetProECodePageName ( )

Removes the Pro/E code page name setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetProEDimensionTolerance ( )

Removes the Pro/E dimension tolerance setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetProESessionColor ( )

Removes the Pro/E session color setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetProESubpartPMI ( )

Removes the Pro/E subpart PMI setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSearchDirectories ( )

Removes the search directories setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSearchDirectoriesByFile ( )

Removes the search directories by file setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSolids ( )

Removes the solid import state.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSTEPCodePageName ( )

Removes the STEP code page name setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSTEPFirstColorPreference ( )

Removes the STEP first color preference setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSTEPNamePreference ( )

Removes the STEP name preference setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSTEPOrientationHealing ( )

Removes the STEP orientation healing setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSTEPShellBasedSurfaceModelSplitting ( )

Removes the STEP shell based surface model splitting setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetSurfaces ( )

Removes the surface import state.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetTessellationAccuracy ( )

Removes the tessellation accuracy setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetTessellationLevel ( )

Removes the tessellation level setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetTessellationMaximumEdgeLength ( )

Removes the tessellation maximum edge length setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetTessellationPreservesUVPoints ( )

Removes the tessellation UV preservation setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetTextureDirectories ( )

Removes the texture search directories setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetUnigraphicsFittedCamera ( )

Removes the Unigraphics fitted camera setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetUnigraphicsPreferredReferenceSets ( )

Removes the Unigraphics preferred reference sets setting.

Returns
A reference to this ImportOptionsKit.
ImportOptionsKit& Exchange::ImportOptionsKit::UnsetWireframes ( )

Removes the wireframe import state.

Returns
A reference to this ImportOptionsKit.

The documentation for this class was generated from the following file: