A3DSDKReadWrite.h File Reference

Header file for the read-write module. More...

Data Structures

struct  A3DChainedBuffer
 A structure that contains chained buffers. It is used to by: A3DAsmModelFileExportToParasolidBuffer
A3DRepresentationItemExportToParasolidBuffer
A3DAsmModelFileExportToAcisBuffer
A3DRepresentationItemExportToAcisBuffer
A3DChainedBufferFree
This structure can be used directly when loading a file from a buffer in Parasolid. More...
 
struct  A3DFileInformationData
 File. More...
 
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  A3DRWParamsExportAcisData
 A structure that specifies parameters used to write the model file to ACIS format. More...
 
struct  A3DRWParamsExportIgesData
 A structure that specifies parameters used to write the model file to IGES format. More...
 
struct  A3DRWParamsExportJTData
 A structure that specifies parameters used to write the model file to JT format. More...
 
struct  A3DRWParamsExportParasolidData
 A structure that specifies parameters used to write the model file to Parasolid format. More...
 
struct  A3DRWParamsExportPrcData
 A structure that specifies parameters used to write the model file to PRC format. More...
 
struct  A3DRWParamsExportStepData
 A structure that specifies parameters used to write the model file to a STEP format. More...
 
struct  A3DRWParamsExportStlData
 A structure that specifies parameters used to write the model file to STL format. More...
 
struct  A3DRWParamsExportU3DData
 A structure that specifies parameters used to write the model file to U3D format. More...
 
struct  A3DRWParamsExportXMLData
 A structure that specifies parameters used to write the model file to XML format. 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
 Structure to define the reading parameters used by the load function 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  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  A3DRWParamsTranslateToPkPartsData
 A structure that specifies parameters used to translate the model file or a representation item into an open Parasolid session. More...
 
struct  A3DRWParamsUnigraphicsData
 Reading parameters specific to Unigraphics CAD files. More...
 
struct  A3DStream3DPDFData
 Binary stream for a 3D model stored in a PDF file. The data format is PRC or U3D. More...
 
struct  A3DThumbnailData
 Thumbnail data. More...
 

Typedefs

typedef struct A3DChainedBuffer A3DChainedBuffer
 A structure that contains chained buffers. It is used to by: A3DAsmModelFileExportToParasolidBuffer
A3DRepresentationItemExportToParasolidBuffer
A3DAsmModelFileExportToAcisBuffer
A3DRepresentationItemExportToAcisBuffer
A3DChainedBufferFree
This structure can be used directly when loading a file from a buffer in Parasolid. More...
 

Enumerations

enum  A3DECompressBrepType { kA3DCompressionLow = 0, kA3DCompressionMedium, kA3DCompressionHigh }
 Level of compression used to write the model file to PRC format. More...
 
enum  A3DEJTReadTessellationLevelOfDetail { JTTessLODLow = 0, JTTessLODMedium, JTTessLODHigh }
 JT LOD to retrieve from file. More...
 
enum  A3DEReadGeomTessMode { kA3DReadGeomOnly = 0, kA3DReadGeomAndTess, kA3DReadTessOnly }
 ReadingMode of the model file. Set which kind of content should be read. More...
 
enum  A3DEStepFormat { kA3DStepAP203 = 0, kA3DStepAP214, kA3DStepAP242 }
 STEP formats supported for export. More...
 
enum  A3DEStepNameFromNAUO { kA3DStepNameFromNAUO_ID = 0, kA3DStepNameFromNAUO_NAME, kA3DStepNameFromNAUO_DESCRIPTION }
 Used to select which name to use from NEXT_ASSEMBLY_USAGE_OCCURRENCE as occurrence name. More...
 
enum  A3DETessellationLevelOfDetail {
  kA3DTessLODExtraLow, kA3DTessLODLow, kA3DTessLODMedium, kA3DTessLODHigh,
  kA3DTessLODExtraHigh, kA3DTessLODUserDefined, kA3DTessLODControlledPrecision
}
 Structure to specify the level of detail of the tessellation. More...
 
enum  A3DETranslateToPkPartsAccurate { kA3DE_ACCURATE_NO, kA3DE_ACCURATE_YES, kA3DE_ACCURATE_ONLY_IF_NOT_PARASOLID }
 Control mode of the accurate edge computation in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData. More...
 
enum  A3DETranslateToPkPartsHealing { kA3DE_HEALING_NO, kA3DE_HEALING_YES, kA3DE_HEALING_ONLY_IF_NOT_PARASOLID }
 Control mode of the healing in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData. More...
 
enum  A3DETranslateToPkPartsMergeEntities { kA3DE_MERGE_NO, kA3DE_MERGE_YES, kA3DE_MERGE_ONLY_IF_NOT_PARASOLID }
 Control mode of the accurate edge computation in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData. More...
 
enum  A3DETranslateToPkPartsSimplifyGeometry { kA3DE_SIMPLIFY_NO, kA3DE_SIMPLIFY_YES, kA3DE_SIMPLIFY_ONLY_IF_NOT_PARASOLID }
 Control mode of the healing in TranslateToPkParts functions. Used in A3DRWParamsTranslateToPkPartsData. More...
 
enum  A3DEU3DVersion { kA3DECMA1, kA3DECMA3 }
 U3D formats supported for export. More...
 
enum  A3DEUnits {
  kA3DUnitPoint = 0, kA3DUnitInch, kA3DUnitMillimeter, kA3DUnitCentimeter,
  kA3DUnitPicas, kA3DUnitFoot, kA3DUnitYard, kA3DUnitMeter,
  kA3DUnitKilometer, kA3DUnitMile, kA3DUnitUnknown
}
 Unit used in the model file. More...
 
enum  A3DEWriteGeomTessMode { kA3DWriteGeomOnly = 0, kA3DWriteGeomAndTess, kA3DWriteTessOnly }
 WritingMode of the model file. Set which kind of content should be written. More...
 
enum  A3DProEFamilyTables { A3DProEFamTabAcceleratorFileOnly = 0, A3DProEFamTabOrUseTessellation = 1, A3DProEFamTabOrUseWireAndGeneric = 2 }
 Used to select how to read family tables. More...
 
enum  A3DProEReadConstructEntities { A3DProEReadConstructEntities_AsDatum = 0, A3DProEReadConstructEntities_Yes, A3DProEReadConstructEntities_No }
 Used to control the construction entities reading, entity such as sketch, curves... More...
 
enum  A3DProESessionColorType { kA3DLastCreoVersionSessionColor = 0, kA3DHExchangeSessionColor, kA3DFileVersionSessionColor }
 Used to control the default PMI color: If you load a Wildfire file and set kA3DFileVersionSessionColor to: More...
 

Functions

A3DStatus A3DAsmGetFilesContextsFromModelFile (const A3DAsmModelFile *pA3DAsmModelFile, A3DUns32 *uNbFilesContexts, A3DFileContextData ***ppFilesContexts)
 Extract all the files contexts (RefSet, Configs...) from a model file. More...
 
A3DStatus A3DAsmGetFilesPathFromModelFile (const A3DAsmModelFile *pA3DAsmModelFile, A3DUns32 *uNbPartFiles, A3DUTF8Char ***ppPartFilesPaths, A3DUns32 *uNbAssemblyFiles, A3DUTF8Char ***ppAssemblyFilesPaths, A3DUns32 *uNbMissingFiles, A3DUTF8Char ***ppMissingFilesPaths)
 Extract file paths from a model file. More...
 
A3DStatus A3DAsmModelFileExportToAcisBuffer (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportAcisData *pParamsExportData, A3DChainedBuffer **pBuffer)
 Writes a model file to a buffer in binary ACIS format. More...
 
A3DStatus A3DAsmModelFileExportToAcisFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportAcisData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in ACIS format. More...
 
A3DStatus A3DAsmModelFileExportToIgesFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportIgesData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in IGES format. More...
 
A3DStatus A3DAsmModelFileExportToJTFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportJTData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in JT format. More...
 
A3DStatus A3DAsmModelFileExportToParasolidBuffer (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportParasolidData *pParamsExportData, A3DChainedBuffer **pBuffer)
 Writes a model file to a buffer in Parasolid format. More...
 
A3DStatus A3DAsmModelFileExportToParasolidFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportParasolidData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in Parasolid format. More...
 
A3DStatus A3DAsmModelFileExportToPrcFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportPrcData *pParamsExportData, const A3DUTF8Char *pcCADFileName, A3DRWParamsPrcWriteHelper **ppPrcWriteHelper)
 Writes a model file to a physical file in a PRC format. More...
 
A3DStatus A3DAsmModelFileExportToPrcStream (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportPrcData *pParamsExportData, A3DUTF8Char *&pcStream, unsigned int &uLength, A3DRWParamsPrcWriteHelper **ppPrcWriteHelper)
 Writes a model file to a physical file in a PRC format. More...
 
A3DStatus A3DAsmModelFileExportToStepFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportStepData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in STEP format. More...
 
A3DStatus A3DAsmModelFileExportToStlFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportStlData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in STL format. More...
 
A3DStatus A3DAsmModelFileExportToU3DFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportU3DData *pParamsExportData, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in Universal 3D format. More...
 
A3DStatus A3DAsmModelFileExportToVrmlFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DUTF8Char *pcCADFileName)
 Writes a model file to a physical file in VRML format. More...
 
A3DStatus A3DAsmModelFileExportToXMLFile (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportXMLData *pParamsExportData, const A3DUTF8Char *pcXMLFileName, unsigned int *uMapSize, unsigned int **puMapXmlIds, A3DEntity ***ppMapProductOccurrences)
 Writes a model file to a physical file in XML format. More...
 
A3DStatus A3DAsmModelFileLoadFromFile (const A3DUTF8Char *pcFileName, const A3DRWParamsLoadData *pLoadParametersData, A3DAsmModelFile **ppModelFile)
 Loads an A3DAsmModelFile from a physical file. More...
 
A3DStatus A3DAsmModelFileLoadFromMultiplePrcFile (const A3DUTF8Char *pcFileName, const A3DUns32 uNbPart, const A3DUTF8Char **ppCADFilePath, const A3DUTF8Char **ppPRCFilePath, const A3DRWParamsLoadData *pParamsLoadData, A3DAsmModelFile **pA3DAsmModelFile)
 Creates a model file from multiple PRC files + an PRC assembly file + a map for file names. More...
 
A3DStatus A3DAsmModelFileLoadFromPRCFiles (const A3DUTF8Char *pcRootPrcFilePath, const A3DUns32 uNbFile, const A3DUTF8Char **ppPRCFilePath, const A3DUTF8Char **ppCADFilePath, const A3DRWParamsLoadData *pParamsLoadData, A3DAsmModelFile **pA3DAsmModelFile)
 Creates a model file from multiple PRC files + an PRC assembly file + a map for file names. This function replugs all the parts And Product from a list from a PRC file loaded with an "assembly NO Dependency" mode. More...
 
A3DStatus A3DAsmModelFileLoadFromPrcStream (const A3DUTF8Char *pcBufferStream, unsigned int uBufferLength, A3DRWParamsPrcReadHelper **ppPrcReadHelper, A3DAsmModelFile **ppModelFile)
 Loads an A3DAsmModelFile from a PRC Buffer. More...
 
A3DStatus A3DAsmModelFileLoadFromXMLFile (const A3DUTF8Char *pcFileName, const A3DRWParamsLoadData *pLoadParametersData, A3DAsmModelFile **ppModelFile)
 Loads an A3DAsmModelFile from a XML file and a set of native cad files. More...
 
A3DStatus A3DAsmModelFileTranslateToPkParts (const A3DAsmModelFile *pA3DAsmModelFile, const A3DRWParamsExportParasolidData *pParamsExportData, const A3DRWParamsTranslateToPkPartsData *pParamsTranslateToPkPartsData, int *pNbPkParts, int **pPkParts)
 Writes a model file to parts in the current Parasolid session. More...
 
A3DStatus A3DChainedBufferFree (A3DChainedBuffer *pBuffer)
 This function is used to free memory allocated by following functions: A3DAsmModelFileExportToParasolidBuffer
A3DRepresentationItemExportToParasolidBuffer
A3DAsmModelFileExportToAcisBuffer
A3DRepresentationItemExportToAcisBuffer
A3DChainedBufferFree
. More...
 
A3DStatus A3DCheckFileFormat (const A3DUTF8Char *pcFileName, const int &rCadTypeWanted)
 Checks the format of a physical file. More...
 
A3DStatus A3DExtractFileThumbnail (const A3DUTF8Char *pcFileName, A3DThumbnailData *pThumbnailData)
 Extract thumbnail stored in a CAD file. More...
 
A3DStatus A3DGet3DPDFStreams (const A3DUTF8Char *pcFileName, A3DStream3DPDFData **ppStreamData, A3DInt32 *piNumStreams)
 Function to retrieve all 3D streams embedded in a PDF document. More...
 
A3DStatus A3DGetFileFormat (const A3DUTF8Char *pcFileName, A3DEModellerType *peModellerType)
 Returns the format of a physical file. More...
 
A3DStatus A3DGetFileInformation (const A3DUTF8Char *pcFileName, A3DFileInformationData *pFileInformationData)
 Get file information a CAD file. More...
 
A3DStatus A3DHealPkParts (int *pNbPkParts, int **pPkParts, const A3DRWParamsTranslateToPkPartsData *pParamsTranslateToPkPartsData)
 Heal parts in the current Parasolid session. More...
 
A3DVoid A3DLicPutPRCLicense (const A3DUTF8Char *pcKey)
 Sets the license for the current instance. More...
 
A3DStatus A3DMiscPKMapperGetA3DEntitiesFromPKEntity (const A3DMiscPKMapper *pMapper, int pPKEntity, int *piNbA3DEntities, A3DEntity ***ppA3DEntities)
 Get HOOPS Exchange entities from Parasolid entity. More...
 
A3DStatus A3DMiscPKMapperGetPKEntitiesFromA3DEntity (const A3DMiscPKMapper *pMapper, const A3DEntity *pA3DEntity, int *piNbPKEntities, int **ppPKEntities)
 Get Parasolid entities from HOOPS Exchange entity. More...
 
A3DStatus A3DRepresentationItemExportToAcisBuffer (const A3DRiRepresentationItem *pRepItem, A3DChainedBuffer **pBuffer, double dScale)
 Writes a representation item to a buffer in binary ACIS format. More...
 
A3DStatus A3DRepresentationItemExportToParasolidBuffer (const A3DRiRepresentationItem *pRepItem, A3DChainedBuffer **pBuffer, double dUnit)
 Writes a representation item to a buffer in Parasolid format. More...
 
A3DStatus A3DRepresentationItemExportToParasolidFile (const A3DRiRepresentationItem *pRepItem, const A3DUTF8Char *pcTempFileName, A3DDouble dUnit)
 Writes a representation item to a file in Parasolid format. More...
 
A3DStatus A3DRepresentationItemTranslateToPkParts (const A3DRiRepresentationItem *pRepItem, const A3DRWParamsTranslateToPkPartsData *pParamsTranslateToPkPartsData, double dUnit, int *pNbPkParts, int **pPkParts)
 Writes a representation item to parts in the current Parasolid session. More...
 
A3DVoid A3DRWParamsPrcReadHelperFree (A3DRWParamsPrcReadHelper *pA3DRWParamsPrcReadHelper)
 Free PRC read helper. More...
 
A3DVoid A3DRWParamsPrcWriteHelperFree (A3DRWParamsPrcWriteHelper *pA3DRWParamsPrcWriteHelper)
 Free PRC write helper. More...
 

Detailed Description

Header file for the read-write module.

Author
Tech Soft 3D
Version
9.1
Date
March 2016
Copyright (c) 2016 by Tech Soft 3D, LLC. All rights reserved.