A3DRWParamsMultiEntriesData Struct Reference

Structure to define which configurations or sub-models should be loaded when the CAD file has multiple entries. More...

Data Fields

A3DBool m_bLoadDefault
 
A3DUTF8Char ** m_ppcEntries
 
A3DUns32 m_uiEntriesSize
 

Detailed Description

Structure to define which configurations or sub-models should be loaded when the CAD file has multiple entries.

Some CAD formats may create CAD files with multiple entries. For these files, the A3DRWParamsMultiEntriesData structure must be used to specify to the load function which entry should be loaded. The entry can be specified by its name, or it can be the default entry if the CAD file contains one.
The A3DRWParamsMultiEntriesData structure is implemented for following CAD formats:

  • CATIA V4: Multiple entries are for sub-models. CATIA V4 files never contain default entries.
    • m_bLoadDefault is not implemented.
    • m_ppcEntries should contain a single name, the name of the root product occurrence to load.
    • The load function loads the selected entry, other entries are not loaded, in any way.
    • Entries names can be retrieved from a first call to the load function, and a parsing of the returned model file and the product occurrences structure. Here, note that only the root product occurrences should be parsed.
  • SolidWorks: Multiple entries are for configurations. SolidWorks files always contain a default entry.
    • m_bLoadDefault is implemented.
    • m_ppcEntries should contain a single name, the name of the configuration to load.
    • The load function loads the selected entry, other entries are loaded in a 'structure only' mode (only the Product Occurrences structure is loaded, not the geometric content; all these Product Occurrences have a status which is not Loaded).
    • Entries names can be retrieved from a first call to the load function, and a parsing of the returned model file and the product occurrences structure. Here, note that only the product occurrences of type 'Configuration', sons of the root 'Container' product should be parsed (see A3DAsmProductOccurrenceData::m_uiProductFlags and Bit field flag definitions for product occurrences).

The load function behaves as follows:

  • If no MultiEntries parameter is specified and the file contains multiple entries, the load function loads the product structure only, and returns an error A3D_LOAD_MULTI_MODELS_CADFILE. The user can use the returned model file to get the Entry names which will be useful to a second call of the load function with the selected entry.
  • If no MultiEntries parameter is specified and the file contains only one entry, the load function automatically loads the model.
  • If the file contains a default entry and m_bLoadDefault is TRUE, the load function automatically loads the default entry.
  • if m_ppcEntries defines an entry as described above and the file contains multiple entries, the selected entry is loaded.
Version
3.0

Field Documentation

◆ m_bLoadDefault

A3DBool A3DRWParamsMultiEntriesData::m_bLoadDefault

A value of TRUE is to load the default entry on a multi-entry file. Nothing changes for non multi-entry files.

◆ m_uiEntriesSize

A3DUns32 A3DRWParamsMultiEntriesData::m_uiEntriesSize

The size of m_ppcEntries.

◆ m_ppcEntries

A3DUTF8Char** A3DRWParamsMultiEntriesData::m_ppcEntries

Strings defining the entry to load in case of a multi-entry file. See description paragraph above.