#include <sprk_exchange.h>
Static Public Member Functions | |
static ImportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The HPS::Exchange::ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via Exchange. Calling HPS::Exchange::ImportOptionsKit::GetDefault() will return an options kit with values found in here.
HPS::Exchange::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
HPS::Exchange::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
in_kit | The source ImportOptionsKit to copy. |
HPS::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.
in_that | An rvalue reference to an ImportOptionsKit to take the impl from. |
|
virtual |
Indicates whether this ImportOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Exchange::ImportOptionsKit::Equals | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
in_kit | The source ImportOptionsKit to compare to this ImportOptionsKit. |
|
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(const char*,const ImportOptionsKit&) or File::Translate.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::Exchange::ImportOptionsKit::operator!= | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.
in_kit | The source ImportOptionsKit to compare to this ImportOptionsKit. |
ImportOptionsKit& HPS::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.
in_that | An rvalue reference to an ImportOptionsKit to take the impl from. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::operator= | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
in_kit | The source ImportOptionsKit to copy. |
bool HPS::Exchange::ImportOptionsKit::operator== | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
in_kit | The source ImportOptionsKit to compare to this ImportOptionsKit. |
void HPS::Exchange::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
in_kit | The source ImportOptionsKit to copy. |
ImportOptionsKit& HPS::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.
in_state | Whether to only import data from the active filter in the CAD file. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::SetAnnotationCaptureFitting | ( | AnnotationCaptureFitting | in_fitting | ) |
Sets the type of data that should be used to generate the camera for annotation captures.
in_fitting | The type of fitting to use for annotation captures. |
ImportOptionsKit& HPS::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.
in_state | Whether to import attributes from the CAD file. |
ImportOptionsKit& HPS::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.
in_state | Whether to import BRep data from the CAD file. |
ImportOptionsKit& HPS::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.
in_mode | The import mode for BRep data in the CAD file. |
ImportOptionsKit& HPS::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.
in_name | UTF8-encoded logical name for the root directory for a Catia V4 file. |
ImportOptionsKit& HPS::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.
in_state | Whether to allow searching in addtional logical names for a Catia V4 file. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::SetCatiaV5Cache | ( | bool | in_active, |
char const * | in_path | ||
) |
Sets whether to use the a cache for a Catia V5 file.
in_active | Whether the cache should be activated for a Catia V5 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV5Data::m_bCacheActivation. |
in_path | UTF8-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. |
ImportOptionsKit& HPS::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.
in_configuration | UTF8-encoded configuration name to import from a CAD file. |
ImportOptionsKit& HPS::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.
in_count | Size of the following array. |
in_configuration | List of nested configuration names to import from a CAD file. |
ImportOptionsKit& HPS::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.
in_configuration | List of nested configuration names to import from a CAD file. |
ImportOptionsKit& HPS::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.
in_state | Whether to import construction and references from the CAD file. |
ImportOptionsKit& HPS::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.
in_units | The units to use for the CAD file if it is not well defined. |
ImportOptionsKit& HPS::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.
in_state | Whether to import hidden objects from the CAD file. |
ImportOptionsKit& HPS::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.
in_filename | UTF8-encoded filename for attribute data. |
ImportOptionsKit& HPS::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.
in_name | UTF8-encoded code page name for an IFC file. |
ImportOptionsKit& HPS::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.
in_state | Whether to import edges for an IFC file. |
ImportOptionsKit& HPS::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.
in_state | Whether to optimize face import for an IFC file. |
ImportOptionsKit& HPS::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.
in_state | Whether to import all IFC metadata or to import only each part's GlobalID |
ImportOptionsKit& HPS::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.
in_state | Whether to optimize the setting of IFCOWNERHISTORY for an IFC file. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::SetJTTessellationLevel | ( | JT::TessellationLevel | in_jt_tessellation_level | ) |
Sets the tessellation level to load for JT files. This corresponds to the value that will be passed to A3DRWParamsJTData::m_eReadTessellationLevelOfDetail.
in_jt_tessellation_level | The tessellation level to load. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::SetLocation | ( | ComponentPath const & | in_path, |
MatrixKit const & | in_transform = MatrixKit() |
||
) |
Sets where to insert the imported file in an existing Component hieararchy. If this option is not set, a new CADModel will be created for the imported file. If this option is specified, the underlying PRC data of the existing CADModel will be modified to include the imported file and the data will be imported into the specified location in the existing Component hierarchy and its corresponding scene graph.
in_path | The path describing the location to insert the imported file into. This path must either terminate at a CADModel or a Component corresponding to an A3DAsmProductOccurrence. Note that if the imported file is added along a component path with attributes specified in the PRC data, the components added to the existing PRC data will also inherit those attributes. Note also that if the path is just a CADModel, a new A3DAsmModelFile underyling the CADModel must be created to include both the existing product occurrences and the new product occurrences, and the existing A3DAsmModelFile will be deleted. |
in_transform | A transform to apply to the components being added to the existing CADModel. This transform will also be added to the underlying PRC data. Defaults to an identity transform. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::SetPDF3DStreamIndex | ( | size_t | in_index | ) |
Sets the index into the list 3D streams contained in a PDF to load.
in_index | The index into the list of 3D stream contained in a PDF to load. |
ImportOptionsKit& HPS::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.
in_state | Whether to import PMI from the CAD file. |
ImportOptionsKit& HPS::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.
in_color | The color to use for the PMI in the CAD file if none is specified. |
ImportOptionsKit& HPS::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.
in_units | The units to use for the PMI in the CAD file if it is not well defined. |
ImportOptionsKit& HPS::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.
in_precision | The precision to use for PMI which has no precision information in the CAD file. |
ImportOptionsKit& HPS::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.
in_font_name | UTF8-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_substitute | Whether 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. |
ImportOptionsKit& HPS::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.
in_name | UTF8-encoded code page name for a Pro/E file. |
ImportOptionsKit& HPS::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.
in_state | Whether to import dimension tolerances for a Pro/E file. |
ImportOptionsKit& HPS::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.
in_type | The session color for a Pro/E file. |
ImportOptionsKit& HPS::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.
in_state | Whether to import subpart PMI for a Pro/E file. |
ImportOptionsKit& HPS::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.
in_count | Size of the following arrays. |
in_directories | The directories to search for files references by a CAD assembly. |
in_recurse_flags | Whether to search recursively in each of the corresponding directories. |
ImportOptionsKit& HPS::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.
in_directories | The directories to search for files references by a CAD assembly. |
in_recurse_flags | Whether to search recursively in each of the corresponding directories. |
ImportOptionsKit& HPS::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.
in_count | Size of the following arrays. |
in_directories | The directories to search for files references by a CAD assembly. |
in_logical_names | The logical names for each corresponding directory. If there are no logical names for the directories, this value can be null. |
in_recurse_flags | Whether to search recursively in each of the corresponding directories. |
ImportOptionsKit& HPS::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.
in_directories | The directories to search for files references by a CAD assembly. |
in_logical_names | The logical names for each corresponding directory. If there are no logical names for the directories, this array can be empty. |
in_recurse_flags | Whether to search recursively in each of the corresponding directories. |
ImportOptionsKit& HPS::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.
in_count | Size of the following array. |
in_file_names | The names of text files containing the lists of directories to search to find files referenced by a CAD assembly. |
ImportOptionsKit& HPS::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.
in_file_names | The names of text files containing the lists of directories to search to find files referenced by a CAD assembly. |
ImportOptionsKit& HPS::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.
in_state | Whether to import solids from the CAD file. |
ImportOptionsKit& HPS::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
UTF8-encoded | code page name for a STEP file. |
ImportOptionsKit& HPS::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.
in_state | Whether to prefer the first color if geometry has several colors for a STEP file. |
ImportOptionsKit& HPS::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.
in_field | The field to get the occurrence name from for a STEP file. |
ImportOptionsKit& HPS::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.
in_state | Whether to heal orientations for a STEP file. |
ImportOptionsKit& HPS::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.
in_state | Whether to split SHELL_BASED_SURFACE_MODEL with several OPEN_SHELLs into several bodies for a STEP file. |
ImportOptionsKit& HPS::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.
in_state | Whether to import surfaces from the CAD file. |
ImportOptionsKit& HPS::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.
in_type | The accuracy to use for tessellation generation. |
in_accurate_normals | Whether 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. |
ImportOptionsKit& HPS::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.
in_level | The predefined quality of the tessellation that will be generated for BRep data. |
ImportOptionsKit& HPS::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.
in_limit_type | The type of the chord limit to be specified. |
in_limit | Either 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_tolerance | The 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. |
ImportOptionsKit& HPS::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.
in_length | The 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. |
ImportOptionsKit& HPS::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.
in_state | Whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. |
ImportOptionsKit& HPS::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.
in_count | Size of the following arrays. |
in_directories | The directories to search for textures referenced by a CAD assembly. |
ImportOptionsKit& HPS::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.
in_directories | The directories to search for textures referenced by a CAD assembly. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::SetUnigraphicsFittedCamera | ( | bool | in_state | ) |
Sets whether to make view cameras fitted for a Unigraphics file.
in_state | Whether 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. |
ImportOptionsKit& HPS::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.
in_count | Size of the following array. |
in_reference_sets | List 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_levels | Whether the reference sets will apply to subassemblies for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_bApplyToAllLevels. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::SetUnigraphicsPreferredReferenceSets | ( | UTF8Array const & | in_reference_sets, |
bool | in_apply_to_all_levels | ||
) |
Sets the preferred reference sets for a Unigraphics file.
in_reference_sets | List 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_levels | Whether the reference sets will apply to subassemblies for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_bApplyToAllLevels. |
ImportOptionsKit& HPS::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.
in_state | Whether to import wireframes from the CAD file. |
void HPS::Exchange::ImportOptionsKit::Show | ( | ImportOptionsKit & | out_kit | ) | const |
Copies this ImportOptionsKit into the given ImportOptionsKit.
out_kit | The ImportOptionsKit to populate with the contents of this ImportOptionsKit. |
bool HPS::Exchange::ImportOptionsKit::ShowActiveFilter | ( | bool & | out_state | ) | const |
Shows the active filter import setting.
out_state | Whether to only import data from the active filter in the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowAnnotationCaptureFitting | ( | AnnotationCaptureFitting & | out_fitting | ) | const |
Shows the annotation capture fitting setting.
out_fitting | The type of fitting to use for annotation captures. |
bool HPS::Exchange::ImportOptionsKit::ShowAttributes | ( | bool & | out_state | ) | const |
Shows the attribute import setting.
out_state | Whether to import attributes from the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowBRepData | ( | bool & | out_state | ) | const |
Shows the BRep data import setting.
out_state | Whether to import BRep data from the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowBRepMode | ( | BRepMode & | out_mode | ) | const |
Shows the BRep mode import setting.
out_mode | The import mode for BRep data in the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowCatiaV4LogicalNameForRootDirectory | ( | UTF8 & | out_name | ) | const |
Shows the Catia V4 logical name for the root directory.
out_name | The Catia V4 logical name for the root directory. |
bool HPS::Exchange::ImportOptionsKit::ShowCatiaV4LogicalNameSearching | ( | bool & | out_state | ) | const |
Shows the Catia V4 logical name searching setting.
out_state | Whether to allow searching in addtional logical names for a Catia V4 file. |
bool HPS::Exchange::ImportOptionsKit::ShowCatiaV5Cache | ( | bool & | out_active, |
UTF8 & | out_path | ||
) | const |
Shows the Catia V5 cache setting.
out_active | Whether the cache should be activated for a Catia V5 file. |
out_path | The path to the folder to be used for the Catia V5 cache. |
bool HPS::Exchange::ImportOptionsKit::ShowConfiguration | ( | UTF8Array & | out_configuration | ) | const |
Shows the configuration settting.
out_configuration | List of nested configuration names to import from a CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowConstructionAndReferences | ( | bool & | out_state | ) | const |
Shows the construction and references import setting.
out_state | Whether to import construction and references from the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowDefaultUnits | ( | Units & | out_units | ) | const |
Shows the default units setting.
out_units | The default units setting. |
bool HPS::Exchange::ImportOptionsKit::ShowHiddenObjects | ( | bool & | out_state | ) | const |
Shows the hidden objects import setting.
out_state | Whether to import hidden objects from the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowIFCAttributeXMLFile | ( | UTF8 & | out_filename | ) | const |
Shows the IFC attribute XML file setting.
out_filename | The filename for attribute data for an IFC file. |
bool HPS::Exchange::ImportOptionsKit::ShowIFCCodePageName | ( | UTF8 & | out_name | ) | const |
Shows the IFC code page name setting.
out_name | The code page name for an IFC file. |
bool HPS::Exchange::ImportOptionsKit::ShowIFCEdges | ( | bool & | out_state | ) | const |
Shows the IFC edges setting.
out_state | Whether to import edges for an IFC file. |
bool HPS::Exchange::ImportOptionsKit::ShowIFCFaceOptimization | ( | bool & | out_state | ) | const |
Shows the IFC face optimization setting.
out_state | Whether to optimize face import for an IFC file. |
bool HPS::Exchange::ImportOptionsKit::ShowIFCMetadata | ( | bool & | out_state | ) | const |
Shows the IFC metadata setting.
out_state | Whether to import all IFC metadata or just each part's GloablID |
bool HPS::Exchange::ImportOptionsKit::ShowIFCOwnerHistoryOptimization | ( | bool & | out_state | ) | const |
Shows the IFC owner history optimization setting.
out_state | Whether to optimize the setting of IFCOWNERHISTORY for an IFC file. |
bool HPS::Exchange::ImportOptionsKit::ShowJTTessellationLevel | ( | JT::TessellationLevel & | out_tessellation_level | ) | const |
bool HPS::Exchange::ImportOptionsKit::ShowLocation | ( | ComponentPath & | out_path, |
MatrixKit & | out_transform | ||
) | const |
Shows the location setting.
out_path | The path describing the location to insert the imported file into. |
out_transform | The transform to apply to the components being added to the existing CADModel. |
bool HPS::Exchange::ImportOptionsKit::ShowPDF3DStreamIndex | ( | size_t & | out_index | ) | const |
Shows the PDF 3D stream index setting.
out_index | The index into the list of 3D stream contained in a PDF to load. |
bool HPS::Exchange::ImportOptionsKit::ShowPMI | ( | bool & | out_state | ) | const |
Shows the PMI import setting.
out_state | Whether to import PMI from the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowPMIDefaultColor | ( | RGBColor & | out_color | ) | const |
Shows the PMI default color setting.
out_color | The PMI default color setting. |
bool HPS::Exchange::ImportOptionsKit::ShowPMIDefaultUnits | ( | Units & | out_units | ) | const |
Shows the PMI default units setting.
out_units | The PMI default units setting. |
bool HPS::Exchange::ImportOptionsKit::ShowPMIPrecision | ( | size_t & | out_precision | ) | const |
Shows the PMI precision setting.
out_precision | The precision to use for PMI which has no precision information in the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowPMISubstitutionFont | ( | UTF8 & | out_font_name, |
bool & | out_always_substitute | ||
) | const |
Shows the PMI substitution font setting.
out_font_name | UTF8-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_substitute | Whether to always use this font even in place of those which are present on the system. |
bool HPS::Exchange::ImportOptionsKit::ShowProECodePageName | ( | UTF8 & | out_name | ) | const |
Shows the Pro/E code page name setting.
out_name | The code page name for a Pro/E file. |
bool HPS::Exchange::ImportOptionsKit::ShowProEDimensionTolerance | ( | bool & | out_state | ) | const |
Shows the Pro/E dimension tolerance setting.
out_state | Whether to import dimension tolerances for a Pro/E file. |
bool HPS::Exchange::ImportOptionsKit::ShowProESessionColor | ( | ProE::SessionColor & | out_type | ) | const |
Shows the Pro/E session color setting.
out_type | The session color for a Pro/E file. |
bool HPS::Exchange::ImportOptionsKit::ShowProESubpartPMI | ( | bool & | out_state | ) | const |
Shows the Pro/E subpart PMI setting.
out_state | Whether to import subpart PMI for a Pro/E file. |
bool HPS::Exchange::ImportOptionsKit::ShowSearchDirectories | ( | UTF8Array & | out_directories, |
UTF8Array & | out_logical_names, | ||
BoolArray & | out_recurse_flags | ||
) | const |
Shows the search directories setting.
out_directories | The directories to search for files referenced by a CAD assembly. |
out_logical_names | The logical names for each corresponding directory. If there are no logical names for the directories, this array can be empty. |
out_recurse_flags | Whether to search recursively in each of the corresponding directories. |
bool HPS::Exchange::ImportOptionsKit::ShowSearchDirectoriesByFile | ( | UTF8Array & | out_file_names | ) | const |
Shows the search directories by file setting.
out_file_names | The names of text files containing the lists of directories to search to find files referenced by a CAD assembly. |
bool HPS::Exchange::ImportOptionsKit::ShowSolids | ( | bool & | out_state | ) | const |
Shows the solid import setting.
out_state | Whether to import solids from the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowSTEPCodePageName | ( | UTF8 & | out_name | ) | const |
bool HPS::Exchange::ImportOptionsKit::ShowSTEPFirstColorPreference | ( | bool & | out_state | ) | const |
bool HPS::Exchange::ImportOptionsKit::ShowSTEPNamePreference | ( | STEP::Field & | out_field | ) | const |
bool HPS::Exchange::ImportOptionsKit::ShowSTEPOrientationHealing | ( | bool & | out_state | ) | const |
bool HPS::Exchange::ImportOptionsKit::ShowSTEPShellBasedSurfaceModelSplitting | ( | bool & | out_state | ) | const |
bool HPS::Exchange::ImportOptionsKit::ShowSurfaces | ( | bool & | out_state | ) | const |
Shows the surface import setting.
out_state | Whether to import surfaces from the CAD file. |
bool HPS::Exchange::ImportOptionsKit::ShowTessellationAccuracy | ( | Tessellation::Accuracy & | out_type, |
bool & | out_accurate_normals | ||
) | const |
Shows the tessellation accuracy setting.
out_type | The type of the tessellation accuracy which was specified. |
out_accurate_normals | Whether to compute surface normals when performing accurate tessellation. This only applies if out_type is Tessellation::Accuracy::Accurate. |
bool HPS::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.
out_type | The type of the tessellation level setting which was specified. |
out_level | The 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_type | The type of chord limit which was specified. This is only valid if out_type is Tessellation::Type::Custom. |
out_limit | The 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_tolerance | The maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation::Type::Custom. |
bool HPS::Exchange::ImportOptionsKit::ShowTessellationMaximumEdgeLength | ( | double & | out_length | ) | const |
Shows the tessellation maximum edge length setting.
out_lenth | The tessellation maximum edge length setting. |
bool HPS::Exchange::ImportOptionsKit::ShowTessellationPreservesUVPoints | ( | bool & | out_state | ) | const |
Shows the tessellation UV preservation setting.
out_state | Whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. |
bool HPS::Exchange::ImportOptionsKit::ShowTextureDirectories | ( | UTF8Array & | out_directories | ) |
Shows the texture search directories setting.
out_directories | The directories to search for textures referenced by a CAD assembly. |
bool HPS::Exchange::ImportOptionsKit::ShowUnigraphicsFittedCamera | ( | bool & | out_state | ) | const |
Shows the Unigraphics fitted camera setting.
out_state | Whether to make view cameras fit all visible geometry for a Unigraphics file. |
bool HPS::Exchange::ImportOptionsKit::ShowUnigraphicsPreferredReferenceSets | ( | UTF8Array & | out_reference_sets, |
bool & | out_apply_to_all_levels | ||
) | const |
Shows the Unigraphics preferred reference sets setting.
out_reference_sets | List of preferred references sets for a Unigraphics file. |
out_apply_to_all_levels | Whether the reference sets will apply to subassemblies for a Unigraphics file. |
bool HPS::Exchange::ImportOptionsKit::ShowWireframes | ( | bool & | out_state | ) | const |
Shows the wireframe import setting.
out_state | Whether to import wireframes from the CAD file. |
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetActiveFilter | ( | ) |
Removes the active filter import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetAnnotationCaptureFitting | ( | ) |
Removes the annotation capture fitting setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetAttributes | ( | ) |
Removes the attribute import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetBRepData | ( | ) |
Removes the BRep data import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetBRepMode | ( | ) |
Removes the BRep mode import setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetCatiaV4LogicalNameForRootDirectory | ( | ) |
Removes the Catia V4 logical name for the root directory setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetCatiaV4LogicalNameSearching | ( | ) |
Removes the Catia V4 logical name searching setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetCatiaV5Cache | ( | ) |
Removes the Catia V5 cache setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetConfiguration | ( | ) |
Removes the configuration setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetConstructionAndReferences | ( | ) |
Removes the construction and references import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetDefaultUnits | ( | ) |
Removes the default units setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetHiddenObjects | ( | ) |
Removes the hidden objects import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetIFCAttributeXMLFile | ( | ) |
Removes the IFC attribute XML file setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetIFCCodePageName | ( | ) |
Removes the IFC code page name setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetIFCEdges | ( | ) |
Removes the IFC edges setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetIFCFaceOptimization | ( | ) |
Removes the IFC face optimization setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetIFCMetadata | ( | ) |
Removes the IFC metadata setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetIFCOwnerHistoryOptimization | ( | ) |
Removes the IFC owner history optimization setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetJTTessellationLevel | ( | ) |
Removes the JT tessellation level setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetLocation | ( | ) |
Removes the location setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetPDF3DStreamIndex | ( | ) |
Removes the PDF 3D stream index setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetPMI | ( | ) |
Removes the PMI import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetPMIDefaultColor | ( | ) |
Removes the PMI default color setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetPMIDefaultUnits | ( | ) |
Removes the PMI default units setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetPMIPrecision | ( | ) |
Removes the PMI precision setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetPMISubstitutionFont | ( | ) |
Removes the PMI substitution font setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetProECodePageName | ( | ) |
Removes the Pro/E code page name setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetProEDimensionTolerance | ( | ) |
Removes the Pro/E dimension tolerance setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetProESessionColor | ( | ) |
Removes the Pro/E session color setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetProESubpartPMI | ( | ) |
Removes the Pro/E subpart PMI setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSearchDirectories | ( | ) |
Removes the search directories setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSearchDirectoriesByFile | ( | ) |
Removes the search directories by file setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSolids | ( | ) |
Removes the solid import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSTEPCodePageName | ( | ) |
Removes the STEP code page name setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSTEPFirstColorPreference | ( | ) |
Removes the STEP first color preference setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSTEPNamePreference | ( | ) |
Removes the STEP name preference setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSTEPOrientationHealing | ( | ) |
Removes the STEP orientation healing setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSTEPShellBasedSurfaceModelSplitting | ( | ) |
Removes the STEP shell based surface model splitting setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetSurfaces | ( | ) |
Removes the surface import state.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetTessellationAccuracy | ( | ) |
Removes the tessellation accuracy setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetTessellationLevel | ( | ) |
Removes the tessellation level setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetTessellationMaximumEdgeLength | ( | ) |
Removes the tessellation maximum edge length setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetTessellationPreservesUVPoints | ( | ) |
Removes the tessellation UV preservation setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetTextureDirectories | ( | ) |
Removes the texture search directories setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetUnigraphicsFittedCamera | ( | ) |
Removes the Unigraphics fitted camera setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetUnigraphicsPreferredReferenceSets | ( | ) |
Removes the Unigraphics preferred reference sets setting.
ImportOptionsKit& HPS::Exchange::ImportOptionsKit::UnsetWireframes | ( | ) |
Removes the wireframe import state.