Reads and writes a physical file containing a PRC model file; and creates and accesses model file entities. More...

Data Structures

struct  A3DAsmModelFileData
 ModelFile structure. More...
 

Enumerations

enum  A3DEModellerType
 A3DSDKStructure. More...
 

Functions

A3DStatus A3DAsmModelFileCreate (const A3DAsmModelFileData *pData, A3DAsmModelFile **ppModelFile)
 Creates an A3DAsmModelFile from A3DAsmModelFileData structure. More...
 
A3DStatus A3DAsmModelFileDelete (A3DAsmModelFile *pModelFile)
 Deletes the entire A3DAsmModelFile entity from memory. More...
 
A3DStatus A3DAsmModelFileGet (const A3DAsmModelFile *pModelFile, A3DAsmModelFileData *pData)
 Populates the A3DAsmModelFileData structure. More...
 
A3DStatus A3DAsmModelFileUnloadParts (A3DAsmModelFile *pModelFile, A3DUns32 uiPartsSize, A3DAsmProductOccurrence **ppParts)
 Removes all tessellation and geometry of an A3DAsmProductOccurrence entity This can only be done on parts. More...
 

Detailed Description

Reads and writes a physical file containing a PRC model file; and creates and accesses model file entities.

The A3DAsmModelFile is the root entity of the PRC data. It is the starting point for parsing a PRC file. It is also one of the arguments used to create a 3D annotation within a PDF document.

Entity type is kA3DTypeAsmModelFile.

See also
Technical Overview

Enumeration Type Documentation

A3DSDKStructure.

Modeller type

Version
2.1

Function Documentation

A3DStatus A3DAsmModelFileDelete ( A3DAsmModelFile pModelFile)

Deletes the entire A3DAsmModelFile entity from memory.

Every entity under this model file is also deleted. This function is responsible for freeing the whole memory reserved for ModelFile. After this call, access to the model file is no longer possible, and pointer must be set to NULL.

Version
2.0
Returns
A3D_INVALID_ENTITY_NULL
A3D_INVALID_ENTITY_TYPE
A3D_SUCCESS
A3DStatus A3DAsmModelFileGet ( const A3DAsmModelFile pModelFile,
A3DAsmModelFileData pData 
)

Populates the A3DAsmModelFileData structure.

Version
2.0
Parameters
pModelFileA reference to the model file, which is created by invoking A3DAsmModelFileLoadFromFile
pDataA reference to the A3DAsmModelFileData structure in which the HOOPS Exchange Library stores the model file data
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
Sample code
A3DAsmModelFile pModel = NULL;
/* Should call something here in order to get a valid A3DAsmModelFile */
iErr = A3DAsmModelFileGet( pModel , &sData );
if ( iErr == A3D_SUCCESS )
{
/* Insert here your own code to parse through members of Model File */
for (A3DUns32 ui=0;ui<sData.m_uiPOccurrencesSize;ui++)
{
/* current product occurrence is sData.m_ppPOccurrences[ui] */
}
iErr = A3DAsmModelFileGet( NULL, &sData );
}
A3DStatus A3DAsmModelFileUnloadParts ( A3DAsmModelFile pModelFile,
A3DUns32  uiPartsSize,
A3DAsmProductOccurrence **  ppParts 
)

Removes all tessellation and geometry of an A3DAsmProductOccurrence entity This can only be done on parts.

Version
9.1
Parameters
pModelFileThe model file
uiPartsSizeSize of next array.
ppPartsArray of parts to unload.
Returns
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_PRODUCTOCCURRENCE_INCONSISTENT_PART_EXTERNAL
A3D_PRODUCTOCCURRENCE_INCONSISTENT_EMPTY
A3D_SUCCESS.