< Home

< Programming Guide

< Supported File Formats

REFERENCE MANUAL

Data Structures | Modules | Enumerations | Functions
Product Occurrence

Creates and accesses product occurrence PRC entities. More...

Data Structures

struct  A3DAsmProductOccurrenceData
 A structure specifying product occurrence data. 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.
 

Enumerations

enum  A3DEProductLoadStatus {
  kA3DProductLoadStatusUnknown = 0, kA3DProductLoadStatusError, kA3DProductLoadStatusNotLoaded, kA3DProductLoadStatusNotLoadable,
  kA3DProductLoadStatusLoaded
}
 Load status of the PRC model file. More...
 

Functions

A3DStatus A3DAsmProductOccurrenceGet (const A3DAsmProductOccurrence *pProductOccurrence, A3DAsmProductOccurrenceData *pData)
 Populates the A3DAsmProductOccurrenceData structure. More...
 
A3DStatus A3DAsmProductOccurrenceCreate (const A3DAsmProductOccurrenceData *pData, A3DAsmProductOccurrence **ppProductOccurrence)
 Creates an A3DAsmProductOccurrence from A3DAsmProductOccurrenceData structure. More...
 
A3DStatus A3DAsmProductOccurrenceSetProductPrototype (A3DAsmProductOccurrence *pProductOccurrence, A3DAsmProductOccurrence *pProductPrototype)
 Sets up an A3DAsmProductOccurrence entity as a prototype to another A3DAsmProductOccurrence entity. More...
 
A3DStatus A3DAsmProductOccurrenceUnload (A3DAsmProductOccurrence *pProductOccurrence)
 Removes all tessellation and geometry of an A3DAsmProductOccurrence entity. More...
 
A3DStatus A3DAsmProductOccurrenceGetFilePathName (const A3DAsmProductOccurrence *pProductOccurrence, A3DUTF8Char **ppcFileName)
 Returns the full path name of the file associated with the product occurrence. More...
 
A3DStatus A3DAsmProductOccurrenceAddView (A3DAsmProductOccurrence *pProductOccurrence, A3DMkpView *pView)
 Adds a view in the Array of views. More...
 
A3DStatus A3DAsmProductOccurrenceEdit (const A3DAsmProductOccurrenceData *pData, A3DAsmProductOccurrence *pProductOccurrence)
 Allows to modify some data of a product occurrence. 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

Load status of the PRC model file.

Version
2.1
Enumerator
kA3DProductLoadStatusUnknown 

Unknown status.

kA3DProductLoadStatusError 

Loading error. For example, there is a missing file.

kA3DProductLoadStatusNotLoaded 

Not loaded.

kA3DProductLoadStatusNotLoadable 

Not loadable. For example, limitations exist that prevent the product from loading.

kA3DProductLoadStatusLoaded 

The product was successfully loaded.

Function Documentation

A3DStatus A3DAsmProductOccurrenceGet ( const A3DAsmProductOccurrence pProductOccurrence,
A3DAsmProductOccurrenceData pData 
)

Populates the A3DAsmProductOccurrenceData structure.

Version
2.0
Sample code
A3DAsmProductOccurrence pOccurrence = NULL;
/* Should call something here in order to get a valid A3DAsmProductOccurrence */
iErr = A3DAsmProductOccurrenceGet( pOccurrence , &sData );
if ( iErr == A3D_SUCCESS )
{
/* Insert here your own code to parse through members of ProductOccurrence */
iErr = A3DAsmProductOccurrenceGet( NULL, &sData );
}
Returns
A3D_INITIALIZE_NOT_CALLED
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_ENTITY_NULL
A3D_INVALID_ENTITY_TYPE
A3D_SUCCESS
A3DStatus A3DAsmProductOccurrenceCreate ( const A3DAsmProductOccurrenceData pData,
A3DAsmProductOccurrence **  ppProductOccurrence 
)
A3DStatus A3DAsmProductOccurrenceSetProductPrototype ( A3DAsmProductOccurrence pProductOccurrence,
A3DAsmProductOccurrence pProductPrototype 
)
A3DStatus A3DAsmProductOccurrenceUnload ( A3DAsmProductOccurrence pProductOccurrence)
A3DStatus A3DAsmProductOccurrenceGetFilePathName ( const A3DAsmProductOccurrence pProductOccurrence,
A3DUTF8Char **  ppcFileName 
)

Returns the full path name of the file associated with the product occurrence.

Version
4.0
Returns
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL
A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY
A3D_SUCCESS.
A3DStatus A3DAsmProductOccurrenceAddView ( A3DAsmProductOccurrence pProductOccurrence,
A3DMkpView pView 
)
A3DStatus A3DAsmProductOccurrenceEdit ( const A3DAsmProductOccurrenceData pData,
A3DAsmProductOccurrence pProductOccurrence 
)

Allows to modify some data of a product occurrence.

Version
5.1
Returns
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_ENTITY_NULL
A3D_INVALID_ENTITY_TYPE
A3D_SUCCESS.