Product Occurrence
Creates and accesses product occurrence PRC entities. More...
Modules | |
| Bit field flag definitions for product occurrences | |
| Part Definition | |
| Filter Module | |
| Creates and accesses filter entities that control the entities and layers included in the 3D image. | |
| Mechanism | |
Data Structures | |
| struct | A3DAsmAttachmentsInfosSLW |
| A structure specifying assembly attachments infos specific to SolidWorks format. More... | |
| struct | A3DAsmLayer |
| A structure describing a layer. More... | |
| struct | A3DAsmProductOccurrenceData |
| A structure specifying product occurrence data. More... | |
| struct | A3DAsmProductOccurrenceDataCat |
| A structure specifying product occurrence data specific to Catia format. More... | |
| struct | A3DAsmProductOccurrenceDataCV5 |
| A structure specifying product occurrence data specific to CV5 format. More... | |
| struct | A3DAsmProductOccurrenceDataInv |
| A structure specifying product occurrence data specific to Inventor format. More... | |
| struct | A3DAsmProductOccurrenceDataJT |
| A structure specifying product occurrence data specific to JT format. More... | |
| struct | A3DAsmProductOccurrenceDataProe |
| A structure specifying product occurrence data specific to CV5 format. More... | |
| struct | A3DAsmProductOccurrenceDataSLW |
| A structure specifying product occurrence data specific to SolidWorks format. More... | |
| struct | A3DAsmProductOccurrenceDataUg |
| A structure specifying product occurrence data specific to Ug format. More... | |
| struct | A3DElementsByRefsetUg |
| A structure specifying a List of Elements Ids associated to a refset, for Ug Format. More... | |
| struct | A3DMaterialAndVisualisationInfos |
| A structure to store material, visibility, suppressed, etc... informations, to put on other product occurence. Used for Assemblies / Views that modify those informations. It will be applied during shattered post-treatment. More... | |
| struct | A3DPromotedBodyUg |
| A structure specifying Promoted Bodies Ids for Ug Format. More... | |
| struct | A3DViewMaterialAndVisualisationInfos |
| A structure to store a list of MaterialAndVisualisationInfos, applied by a view. Used for a View that modify those informations. It will be applied during shattered post-treatment. More... | |
Detailed Description
Creates and accesses product occurrence PRC entities.
A product occurrence denotes an assembly tree. If the assembly tree contains a single part, the product occurrence points directly to a part definition. In the case of a more complex assembly tree, a product occurrence is a hierarchy of child product occurrences. And a product occurrence can reference product occurrences that are designated as ProductPrototypes or ExternalData. Such ProductOccurrences denote subassembly structures, which in turn can point to PartDefinitions.
Entity type is kA3DTypeAsmProductOccurrence.
Enumeration Type Documentation
◆ A3DEProductLoadStatus
Load status of the PRC model file.
- Version
- 2.1
◆ A3DEProductOccurrenceTypeCat
A3DAsmProductOccurrenceData extension for Catia V4
- Version
- 8.2
◆ A3DEProductOccurrenceTypeInv
A3DAsmProductOccurrenceData extension for Inventor
- Version
- 8.2
| Enumerator | |
|---|---|
| A3DEProductOccurrenceTypeInv_none | Unknown Inventor type |
| A3DEProductOccurrenceTypeInv_iam | Inventor assembly |
| A3DEProductOccurrenceTypeInv_ipt | Inventor Part |
◆ A3DEProductOccurrenceTypeSLW
A3DAsmProductOccurrenceData extension for SolidWorks
- Version
- 8.2
Function Documentation
◆ A3DAsmProductOccurrenceGet()
| A3DStatus A3DAsmProductOccurrenceGet | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceData * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceData structure.
- Version
- 2.0
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
- Sample code
◆ A3DAsmProductOccurrenceCreate()
| A3DStatus A3DAsmProductOccurrenceCreate | ( | const A3DAsmProductOccurrenceData * | pData, |
| A3DAsmProductOccurrence ** | ppProductOccurrence | ||
| ) |
Creates an A3DAsmProductOccurrence from A3DAsmProductOccurrenceData structure.
- Version
- 2.0
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY A3D_SUCCESS.
◆ A3DAsmProductOccurrenceSetProductPrototype()
| A3DStatus A3DAsmProductOccurrenceSetProductPrototype | ( | A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrence * | pProductPrototype | ||
| ) |
Sets up an A3DAsmProductOccurrence entity as a prototype to another A3DAsmProductOccurrence entity.
- Version
- 2.0
This function sets an A3DAsmProductOccurrence entity as a prototype to another A3DAsmProductOccurrence entity, and duplicates the A3DAsmProductOccurrenceData structure.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY A3D_SUCCESS.
◆ A3DAsmProductOccurrenceUnload()
| A3DStatus A3DAsmProductOccurrenceUnload | ( | A3DAsmProductOccurrence * | pProductOccurrence | ) |
Removes all tessellation and geometry of an A3DAsmProductOccurrence entity.
- Version
- 3.1
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY A3D_SUCCESS.
◆ A3DAsmProductOccurrenceGetFilePathName()
| A3DStatus A3DAsmProductOccurrenceGetFilePathName | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DUTF8Char ** | ppcFileName | ||
| ) |
Returns the full path name of the file associated with the product occurrence. Warning: Using this function on a product occurrence holding a prototype is not recommended, as the result is influenced by how the data is originally stored in the CAD file.
- Version
- 4.0
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY A3D_SUCCESS.
◆ A3DAsmProductOccurrenceGetOriginalFilePathName()
| A3DStatus A3DAsmProductOccurrenceGetOriginalFilePathName | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DUTF8Char ** | ppcFileName | ||
| ) |
Returns the original file name stored in the CAD file. Warning: Using this function on a product occurrence holding a prototype is not recommended, as the result is influenced by how the data is originally stored in the CAD file.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY A3D_SUCCESS.
◆ A3DAsmProductOccurrenceAddView()
| A3DStatus A3DAsmProductOccurrenceAddView | ( | A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DMkpView * | pView | ||
| ) |
Adds a view in the Array of views.
- Version
- 4.1
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY A3D_SUCCESS.
◆ A3DAsmProductOccurrenceEdit()
| A3DStatus A3DAsmProductOccurrenceEdit | ( | const A3DAsmProductOccurrenceData * | pData, |
| A3DAsmProductOccurrence * | pProductOccurrence | ||
| ) |
Allows to modify some data of a product occurrence.
- Version
- 5.1
- Warning
- This function must not be applied within an HOOPS Visualize context. See \doc{/start/getting-started}.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS.
◆ A3DAsmProductOccurrenceDeepCopy()
| A3DStatus A3DAsmProductOccurrenceDeepCopy | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrence ** | ppNewProductOccurrence | ||
| ) |
Creates a new product occurrence by making a deep copy of the data.
- The Copy can be processed on a member of an assembly at different levels. Here an assembly sample and the several copied product added. The deep copy will copied all the data and create new part, for the new instances.
- The prototype mechanism is still present after the copy to assure the possibility to distinguish instances. Due to his position in the tree the product occurrence of a part can reach its part definition by traversing multiple prototype. It's the case of the product A/B1/C1/D1.
- After the deep clone, only last prototype is necessary, All intermediate prototypes are removed and possible redefinition (color, …) or data (attributes) are moved to the new product member.
- A/B1/C1/D1 -> B/C1/D1 -> C/D1 -> D Becomes Copy A/B1/C1/D1 + intermediate properties -> Copy D
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_ERROR A3D_SUCCESS
- Version
- 11.2
◆ A3DAsmProductOccurrenceGetFather()
| A3DStatus A3DAsmProductOccurrenceGetFather | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrence ** | ppProductOccurrenceFather | ||
| ) |
Get the father of a product occurrence.
- The father is NULL for root product occurrences and root prototypes (i.e. prototypes with no prototype). For external data the father is the "member" product occurrence that targets it.
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_ERROR A3D_SUCCESS
- Version
- 13
◆ A3DAsmProductOccurrenceGetSLW()
| A3DStatus A3DAsmProductOccurrenceGetSLW | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceDataSLW * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceDataSLW structure.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
◆ A3DAsmProductOccurrenceGetCat()
| A3DStatus A3DAsmProductOccurrenceGetCat | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceDataCat * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceDataCat structure.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
◆ A3DAsmProductOccurrenceGetCV5()
| A3DStatus A3DAsmProductOccurrenceGetCV5 | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceDataCV5 * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceDataCV5 structure.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
◆ A3DAsmProductOccurrenceGetUg()
| A3DStatus A3DAsmProductOccurrenceGetUg | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceDataUg * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceDataUg structure.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
◆ A3DAsmProductOccurrenceGetProe()
| A3DStatus A3DAsmProductOccurrenceGetProe | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceDataProe * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceDataProe structure.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
◆ A3DAsmProductOccurrenceGetInv()
| A3DStatus A3DAsmProductOccurrenceGetInv | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceDataInv * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceDataInv structure.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
◆ A3DAsmProductOccurrenceGetJT()
| A3DStatus A3DAsmProductOccurrenceGetJT | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DAsmProductOccurrenceDataJT * | pData | ||
| ) |
Populates the A3DAsmProductOccurrenceDataJT structure.
- Version
- 8.2
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INITIALIZE_NOT_CALLED A3D_INVALID_DATA_STRUCT_SIZE A3D_INVALID_DATA_STRUCT_NULL A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS
◆ A3DAsmProductOccurrenceGetLayerList()
| A3DStatus A3DAsmProductOccurrenceGetLayerList | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DUns32 * | piLayers, | ||
| A3DAsmLayer ** | ppLayerArray | ||
| ) |
Allow to get the layer name of an item from his layer defined by A3DMiscCascadedAttributesData::m_usLayer.
- Version
- 11.1
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS.
◆ A3DAsmProductOccurrenceGetIdentifier()
| A3DStatus A3DAsmProductOccurrenceGetIdentifier | ( | const A3DAsmProductOccurrence * | pProductOccurrence, |
| A3DUTF8Char ** | ppcIdentifier | ||
| ) |
Combine Part ID and Occurrence identifier.
- Version
- 9.1
- Returns
- A3D_SUCCESS in case of success or an error code
- Return values
-
A3D_INVALID_ENTITY_NULL A3D_INVALID_ENTITY_TYPE A3D_SUCCESS.