Loads the model file with information from the input CAD file. More...
Data Structures | |
struct | A3DRWParamsAssemblyData |
Structure to define parameters to manage CAD assemblies reading. More... | |
struct | A3DRWParamsCatiaV4Data |
Reading parameters specific to CATIA V4 CAD files. More... | |
struct | A3DRWParamsCatiaV5Data |
Reading parameters specific to CATIA V5 CAD files. More... | |
struct | A3DRWParamsGeneralData |
Reading options to filter the types of information that are read when CAD files are loaded. More... | |
struct | A3DRWParamsIFCData |
Reading parameters specific to IFC files. More... | |
struct | A3DRWParamsIGESData |
Reading parameters specific to IGES files. More... | |
struct | A3DRWParamsIncrementalLoadData |
Structure to specify reading parameters to load some specific parts of an assembly. More... | |
struct | A3DRWParamsInventorData |
A structure that specifies parameters used to read the model file to Inventor format. More... | |
struct | A3DRWParamsJTData |
A structure that specifies parameters used to read the model file to JT format. More... | |
struct | A3DRWParamsLoadData |
A set of options for loading a new model file with A3DAsmModelFileLoadFromFile . More... | |
struct | A3DRWParamsMultiEntriesData |
Structure to define which configurations or sub-models should be loaded when the CAD file has multiple entries. More... | |
struct | A3DRWParamsParasolidData |
A structure that specifies parameters used to read the model file to Parasolid format. More... | |
struct | A3DRWParamsPmiData |
Structure to specify the PMI reading parameters. More... | |
struct | A3DRWParamsProEData |
Reading parameters specific to Pro/ENGINEER CAD files. More... | |
struct | A3DRWParamsRevitData |
A structure that specifies parameters used to read the model file to Revit format. More... | |
struct | A3DRWParamsRhinoData |
A structure that specifies parameters used to read the model file to Rhino format. More... | |
struct | A3DRWParamsSearchDirData |
Structure to define additional directories that the load function will search in addition to the root directory. More... | |
struct | A3DRWParamsSolidworksData |
A structure that specifies parameters used to read the model file to Solidworks format. More... | |
struct | A3DRWParamsSpecificLoadData |
Structure to specify reading parameters specific to some CAD formats. More... | |
struct | A3DRWParamsStepData |
Reading parameters specific to STEP files. More... | |
struct | A3DRWParamsTessellationData |
Structure to set the tessellation parameters. More... | |
struct | A3DRWParamsUnigraphicsData |
Reading parameters specific to Unigraphics CAD files. More... | |
struct | A3DRWValidationPropertiesThresholdData |
Threshold values used for checking validation properties in Step. More... | |
struct | A3DStream3DPDFData |
Binary stream for a 3D model stored in a PDF file. The data format is PRC or U3D. More... | |
Functions | |
A3DStatus | A3DAsmModelFileLoadFromFile (const A3DUTF8Char *pcFileName, const A3DRWParamsLoadData *pLoadParametersData, A3DAsmModelFile **ppModelFile) |
Loads an A3DAsmModelFile from a physical file, returning a handle to the new model file. More... | |
A3DStatus | A3DAsmModelFileLoadFromPrcFile (const A3DUTF8Char *pcFileName, A3DRWParamsPrcReadHelper **ppPrcReadHelper, A3DAsmModelFile **ppModelFile) |
Loads an A3DAsmModelFile from a PRC physical file. More... | |
A3DStatus | A3DAsmModelFileLoadFromPrcStream (const A3DUTF8Char *pcBufferStream, unsigned int uBufferLength, A3DRWParamsPrcReadHelper **ppPrcReadHelper, A3DAsmModelFile **ppModelFile) |
Loads an A3DAsmModelFile from a PRC Buffer. More... | |
A3DStatus | A3DGet3DPDFStreams (const A3DUTF8Char *pcFileName, A3DStream3DPDFData **ppStreamData, A3DInt32 *piNumStreams) |
Function to retrieve all 3D streams embedded in a PDF document. More... | |
A3DStatus | A3DPDFGetStreams (const A3DUTF8Char *pcFileName, A3DUns32 iFlags, A3DStream3DPDFData **ppStreamData, A3DInt32 *piNumStreams) |
Function to retrieve all 3D streams embedded in a PDF document, this function export native and PDF views (defined using Acrobat and not in the origin native CAD file). It also manages secured PDF. More... | |
A3DVoid | A3DRWParamsPrcReadHelperFree (A3DRWParamsPrcReadHelper *pA3DRWParamsPrcReadHelper) |
Free PRC read helper. More... | |
Detailed Description
Loads the model file with information from the input CAD file.
Enumeration Type Documentation
◆ A3DEReadGeomTessMode
enum A3DEReadGeomTessMode |
A3DSDKReadWrite.
ReadingMode of the model file. Set which kind of content should be read.
- Version
- 3.0
◆ A3DEUnits
enum A3DEUnits |
Unit used in the model file.
- Version
- 3.0
◆ A3DETessellationLevelOfDetail
Structure to specify the level of detail of the tessellation.
See A3DRWParamsTessellationData parameters. When a level is given, the Chord Height Ratio (A3DRWParamsTessellationData::m_dChordHeightRatio) and Wireframe Chord Angle (A3DRWParamsTessellationData::m_dAngleToleranceDeg) change to preset values for the selected level.
- Version
- 3.0
Enumerator | |
---|---|
kA3DTessLODExtraLow | Extra Low level: when selected, these members are automatically defined with the following values: |
kA3DTessLODLow | Low level: when selected, these members are automatically defined with the following values: |
kA3DTessLODMedium | Medium level: when selected, these members are automatically defined with the following values: |
kA3DTessLODHigh | High level: when selected, these members are automatically defined with the following values: |
kA3DTessLODExtraHigh | Extra High level: when selected, these members are automatically defined with the following values: |
kA3DTessLODUserDefined | User Defined level: when selected, these members should be defined:
|
kA3DTessLODControlledPrecision | Controlled Precision level: when selected, these members should be defined: |
◆ A3DProESessionColorType
Used to control the default PMI color: If you load a Wildfire file and set kA3DFileVersionSessionColor to:
- kA3DFileVersionSessionColor, the PMI with no color will be displayed in yellow;
- kA3DLastCreoVersionSessionColor, the PMI with no color will be displayed in blue as in Creo 2 (for HOOPS Exchange 6.0);
- kA3DHExchangeSessionColor, the PMI with no color will be displayed with the color you chose.
- Version
- 6.1
Enumerator | |
---|---|
kA3DLastCreoVersionSessionColor | Sets the default session color corresponding to the last version of Creo that HOOPS Exchange supports. |
kA3DHExchangeSessionColor | Uses HOOPS Exchange default color. |
kA3DFileVersionSessionColor | Lets the user define the color by using graphics parameters options ( A3DRWParamsPmiData::m_sDefaultColor). |
◆ A3DProEReadConstructEntities
◆ A3DProEFamilyTables
enum A3DProEFamilyTables |
Used to select how to read family tables.
- Version
- 9.0
◆ A3DEStepNameFromNAUO
enum A3DEStepNameFromNAUO |
Used to select which name to use from NEXT_ASSEMBLY_USAGE_OCCURRENCE as occurrence name.
- Version
- 4.2
◆ A3DEJTReadTessellationLevelOfDetail
JT LOD to retrieve from file.
- Version
- 8.0
◆ EA3DRevitPhysicalProperties
◆ EA3DRevitLinks
enum EA3DRevitLinks |
They are set in A3DRWParamsRevitData::m_uiLinkFlags.
- Version
- 22.0.0
Function Documentation
◆ A3DAsmModelFileLoadFromFile()
A3DStatus A3DAsmModelFileLoadFromFile | ( | const A3DUTF8Char * | pcFileName, |
const A3DRWParamsLoadData * | pLoadParametersData, | ||
A3DAsmModelFile ** | ppModelFile | ||
) |
Loads an A3DAsmModelFile
from a physical file, returning a handle to the new model file.
Successfully calling this function will always create a new model file, even if the call is made several times with the same input path. Once loaded, a handle to the new model file is stored in ppModelFile
and you can query its content with A3DAsmModelFileGet
.
- Parameters
-
[in] pcFileName The system path to the input file. Must be a valid UTF-8 string. [in] pLoadParametersData A set of options used to customize the behaviour of the loading. [out] ppModelFile A pointer to the handle of the new model file, in case of success.
- Returns
A3D_SUCCESS
or an error code in case of failure.
- Return values
-
A3D_SUCCESS in case of success. A3D_INITIALIZE_NOT_CALLED if pLoadParametersData
is not initialized.A3D_INVALID_DATA_STRUCT_NULL if pLoadParametersData
is null.A3D_INVALID_DATA_STRUCT_SIZE if pLoadParametersData
is not initialized by an incompatible version of the API.A3D_INVALID_ENTITY_NULL if ppModelFile
is null.A3D_LOAD_CANNOT_ACCESS_CADFILE if the input path cannot be opened by the running process for reading. A3D_LOAD_CANNOT_LOAD_MODEL if an error occured while reading the file. A3D_LOAD_CANNOT_LOAD_MULTIENTRY [I don't know about this one] A3D_LOAD_EMPTY_MULTI_MODEL [I don't know about this one] A3D_LOAD_FILE_TOO_OLD if the reader support this format but the version is older than the minimum supported. A3D_LOAD_FILE_TOO_RECENT if the reader support this format but the version is more recent than the maximum supported. A3D_LOAD_INVALID_FILE_FORMAT if the format is not supported A3D_LOAD_MISSING_COMPONENTS if the load partially completed A3D_LOAD_MULTI_MODELS_CADFILE if the file contains multiple entries (see A3DRWParamsMultiEntriesData). A3D_LOAD_READER_NOT_IMPLEMENTED if the reader for the requested format is not avaiable yet
- Version
- 3.0
- See also
A3DAsmModelFileLoadFromFile
A3DAsmModelFileLoadFromMultiplePrcFile
A3DAsmModelFileLoadFromPRCFiles
A3DAsmModelFileLoadFromXMLFile
A3DAsmModelFileLoadFromXMLStream
A3DPkPartsTranslateToA3DAsmModelFile
A3DRWParamsGeneralData
A3DRWParamsLoadData
A3DRWParamsMultiEntriesData
◆ A3DAsmModelFileLoadFromPrcStream()
A3DStatus A3DAsmModelFileLoadFromPrcStream | ( | const A3DUTF8Char * | pcBufferStream, |
unsigned int | uBufferLength, | ||
A3DRWParamsPrcReadHelper ** | ppPrcReadHelper, | ||
A3DAsmModelFile ** | ppModelFile | ||
) |
Loads an A3DAsmModelFile from a PRC Buffer.
This function loads an A3DAsmModelFile from a PRC Buffer.
- Parameters
-
[in] pcBufferStream Buffer containing the PRC stream. [in] uBufferLength Length of pcBufferStream. [in,out] ppPrcReadHelper Reserved for future use. [out] ppModelFile References a pointer into which the location should be stored. of the model file. Set this pointer to null before calling the function.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_ENTITY_NULL A3D_LOAD_CANNOT_ACCESS_CADFILE A3D_LOAD_CANNOT_LOAD_MODEL A3D_LOAD_CANNOT_LOAD_MULTIENTRY A3D_LOAD_EMPTY_MULTI_MODEL A3D_LOAD_FILE_TOO_OLD A3D_LOAD_FILE_TOO_RECENT A3D_LOAD_INVALID_FILE_FORMAT A3D_LOAD_MISSING_COMPONENTS A3D_LOAD_MULTI_MODELS_CADFILE if the file contains multiple entries (see A3DRWParamsMultiEntriesData). A3D_LOAD_READER_NOT_IMPLEMENTED A3D_SUCCESS
- Version
- 5.2
◆ A3DRWParamsPrcReadHelperFree()
A3DVoid A3DRWParamsPrcReadHelperFree | ( | A3DRWParamsPrcReadHelper * | pA3DRWParamsPrcReadHelper | ) |
Free PRC read helper.
- Parameters
-
[in,out] pA3DRWParamsPrcReadHelper The helper to free.
- Remarks
- Because this function does not return A3DStatus the internal thread safety policy is to wait for the availability of the API.
- Version
- 8.1
◆ A3DAsmModelFileLoadFromPrcFile()
A3DStatus A3DAsmModelFileLoadFromPrcFile | ( | const A3DUTF8Char * | pcFileName, |
A3DRWParamsPrcReadHelper ** | ppPrcReadHelper, | ||
A3DAsmModelFile ** | ppModelFile | ||
) |
Loads an A3DAsmModelFile from a PRC physical file.
This function loads an A3DAsmModelFile from a PRC file. The file must be in PRC format.
- Parameters
-
[in] pcFileName References the path to the file containing the 3D CAD model. [in,out] ppPrcReadHelper Reserved for future use. [out] ppModelFile References a pointer into which should be stored the location of the model file. Set this pointer to null before calling the function.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_ENTITY_NULL A3D_LOAD_CANNOT_ACCESS_CADFILE A3D_LOAD_CANNOT_LOAD_MODEL A3D_LOAD_CANNOT_LOAD_MULTIENTRY A3D_LOAD_EMPTY_MULTI_MODEL A3D_LOAD_FILE_TOO_OLD A3D_LOAD_FILE_TOO_RECENT A3D_LOAD_INVALID_FILE_FORMAT A3D_LOAD_MISSING_COMPONENTS A3D_LOAD_MULTI_MODELS_CADFILE if the file contains multiple entries (see A3DRWParamsMultiEntriesData). A3D_LOAD_READER_NOT_IMPLEMENTED A3D_SUCCESS
- Version
- 4.0
◆ A3DGet3DPDFStreams()
A3DStatus A3DGet3DPDFStreams | ( | const A3DUTF8Char * | pcFileName, |
A3DStream3DPDFData ** | ppStreamData, | ||
A3DInt32 * | piNumStreams | ||
) |
Function to retrieve all 3D streams embedded in a PDF document.
The stream is the raw binary data stored as a char* stream. A PRC stream can be interpreted with the function A3DAsmModelFileLoadFromPrcStream. A U3D stream needs to be written as a physical file before being read with classical A3DAsmModelFileLoadFromFile function.
- Parameters
-
[in] pcFileName References the path to the PDF file [out] ppStreamData Array of stream data [out] piNumStreams Number of streams
If pcFileName is NULL, *ppStreamData will be freed if *piNumStreams is non-null. A3DGet3DPDFStreams(NULL, ppStreamData, piNumStreams) to release *ppStreamData.
- Remarks
- Note that this method does not set the identifier of the A3DStream3DPDFData. It will be defaulted to kA3DPDFUnknownStreamIdentifier.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_LOAD_CANNOT_ACCESS_CADFILE A3D_SUCCESS
- Version
- 6.0
◆ A3DPDFGetStreams()
A3DStatus A3DPDFGetStreams | ( | const A3DUTF8Char * | pcFileName, |
A3DUns32 | iFlags, | ||
A3DStream3DPDFData ** | ppStreamData, | ||
A3DInt32 * | piNumStreams | ||
) |
Function to retrieve all 3D streams embedded in a PDF document, this function export native and PDF views (defined using Acrobat and not in the origin native CAD file). It also manages secured PDF.
The stream is the raw binary data stored as a char* stream. A PRC stream can be interpreted with the function A3DAsmModelFileLoadFromPrcStream. A U3D stream needs to be written as a physical file before being read with classical A3DAsmModelFileLoadFromFile function.
- Parameters
-
[in] pcFileName References the path to the PDF file [in] iFlags view flags Field to indicate the options for filtering 3D views. [out] ppStreamData Array of stream data [out] piNumStreams Number of streams
If pcFileName is NULL, *ppStreamData will be freed if *piNumStreams is non-null. A3DPDFGetStreams(NULL, NULL, ppStreamData, piNumStreams) to release *ppStreamData.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_SUCCESS A3D_LOAD_CANNOT_ACCESS_CADFILE
- Version
- 12.0