Library Session Functions

Fields

A3DStatus A3DDisableHandleSIGSEGV

param

Functions

`A3DStatus`	`A3DDllInitialize`
`A3DStatus`	`A3DDllTerminate`
`A3DStatus`	`A3DDllGetVersion`
`A3DStatus`	`A3DDllGetBuildInformation`
`A3DStatus`	`A3DDllIsInitialized`

Detailed Description

group a3d_libsession_functions

Starts, configures, and terminates a session with the library.

The functions in this section start and terminate a session with the library.

Field Documentation

A3DStatus A3DGetCurveAsAnalytic param

Function to get curves as analytic (line or circle) according to a certain tolerance.

delete RTF data created by A3DMkpRTFInit

Get each independent field of a RTF data.

Calculates the bounding box of the model file entity, without using any callback functions.

Draws the markup item entities, using the callbacks defined by A3DDrawInitCallbacks.

Draws the representation item entities, using the callbacks defined by A3DDrawInitCallbacks.

Draws the model file entities, using the callbacks defined by A3DDrawInitCallbacks.

Enables internal SIGSEGV handling (Linux only)

Function to compute Hidden Line Removal on a A3DAsmModelFile.

Function to project Point Cloud on BrepModel with a A3DProjectPointCloudManager.

Function to get surface as analytic according to a certain tolerance.

Function to get curves as analytic (line or circle) according to a certain tolerance Try to use UV curves from Edges if exist, otherwise use 3D Curves.

Use A3DEntityDelete to delete the analytic curve after using it.

Deprecated:: Use A3DSimplifyCurveWithAnalytics instead. This will be removed in version 2026.1.0.

Use A3DEntityDelete to delete the analytic curve after using it.

Deprecated:: use A3DSimplifyCurveWithAnalyticsFromCoEdge instead. This will be removed in version 2026.1.0.

Use A3DEntityDelete to delete the analytic surface after using it. Recognized surface type are: Conic Surface Cylindrical Surface Plane Surface Spherical Surface Toric Surface

Deprecated:: use A3DSimplifySurfaceWithAnalytics instead. This will be removed in version 2026.1.0.

Version: 5.0
Version: 5.0
Version: 5.0

Deprecated:: use A3DProjectPointCloud3 instead. This will be removed in version 2026.1.0.

Version: 8.1

Memory Management

In case of success, ppProjectedPointCloud contains heap allocated memory you are responsible for. To free the memory on ppProjectedPointCloud, call A3DProjectPointCloud2 by setting pManager to 0. In this case, all other parameters are ignored:

A3DProjectPointCloud2(0, 0, 0, A3D_FALSE, 0, 0.0, ppProjectedPointCloud);

Deprecated:: use A3DComputeOrthoHLROnModelFile3 instead. This will be removed in version 2026.1.0.

Call A3DComputeOrthoHLROnModelFile( NULL, pOptMrkRView, NULL, pNumberHLRData, pppHLRData) to release pppHLRData structure ( A3DCrvPolyLine was not released) Note: If the model file doesn’t contain any representation items, function returns A3D_INVALID_DATA error;

Version: 8.1

Deprecated:: use A3DComputeOrthoHLROnModelFile3 instead. This will be removed in version 2026.1.0.

Version: 9.0

Call A3DComputeOrthoHLROnModelFile2( NULL, NULL, NULL, pNumberHLRRepItem, pppHLRRepItem) to release pppHLRRepItem structure ( internal A3DCrvPolyLine was not released)

If pOptMrkRView is a cutting view, psSectionParametersData can be set to 0. In this case, the cutting planes within pOptMrkRView are used for the computation. Planes must to ordered and be set a profile, otherwise the function will return #A3D_TOOLS_INVALID_SECTION_PLANE.

This function activates the handling of the SIGSEGV signal on Linux. When this function is activated, SIGSEGV is handled and an exception is thrown to return A3D_EXCEPTION.

Remark

If the model file doesn’t contain any representation item, the function will return #A3D_INVALID_DATA error

Deprecated:: the default behavior has changed with 11.2 to disable the SIGSEGV handling This will be removed in version 2026.1.0.

Deprecated:: The Draw module is deprecated and will be removed in version 2026.1.0.

To set the uiDrawFlags argument, use the flags defined in Flags for Drawing Model File Entities.

Version: 2.0

Deprecated:: The Draw module is deprecated and will be removed in version 2026.1.0.

Deprecated:: The Draw module is deprecated and will be removed in version 2026.1.0.

Deprecated:: The Draw module is deprecated and will be removed in version 2026.1.0.

To set the uiDrawFlags argument, use the flags defined in Flags for Drawing Model File Entities.

Version: 2.0
Version: 2.0
Version: 2.0

Deprecated:: This function is deprecated. Please use A3DMkpRTFFieldGet instead to implement the same behaviour. This will be removed in version 2026.1.0.

Version: 4.2

Deprecated:: This function is deprecated. Please use A3DMkpRTFFieldDelete instead to implement the same behaviour. This will be removed in version 2026.1.0.

Version: 4.2

Warning

must be deleted by the user

Warning

If A3DProjectPointCloudManagerCreateFromRI is used to create pManager, and A3DProjectPointCloudManagerDataFromRI::m_bUseExactComputation is set to false, you can’t set bUseExactComputation to true. In this case, an A3D_INVALID_DATA error is returned.

Warning

You must call this function before A3DDllInitialize

Retval A3D_SUCCESS:: if an analytic has been created
Retval A3D_ERROR:
Retval A3D_SUCCESS:: if an analytic has been created
Retval A3D_ERROR:
Return:: A3D_SUCCESS on success, or an error code on failure
Return:: A3D_SUCCESS on success, or an error code on failure
Param pSrf:: [in] The input surface
Param dTol:: [in] Tolerance
Param pAnalyticSurface:: [out] The new analytic surface.
Param peAnalyticType:: [out] The type of analytic surface
Retval A3D_SUCCESS:
Retval A3D_INVALID_ENTITY_NULL:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_ERROR:
Return:: A3D_SUCCESS on success, or an error code on failure
Param pManager:: [in] A3DProjectPointCloudManager created by A3DProjectPointCloudManagerCreateFromModelFile function.
Param uPointCloudSize:: [in] Number of points in pPointCloudToProject.
Param pPointCloudToProject:: [in] Point cloud to project. This point cloud must be in the same coordinate system as the BrepData structures stored in BrepModel.
Param bUseExactComputation:: [in] Flag to use exact topology. When this flag is false, the algorithm drops the point cloud on the faceted geometry, otherwise, the exact topology is used.
Param uNbThreads:: [in] Number of threads wanted. 0 means non multi-thread. Please avoid setting a number of threads larger than the number of CPU cores.
Param dInsidePointEdgeTolerance:: [in] Tolerance used to check if projection point which is inside a face is on edge.
Param ppProjectedPointCloud:: [out] Point cloud projected.
Retval A3D_SUCCESS:
Retval A3D_INVALID_DATA_STRUCT_NULL:
Retval A3D_INVALID_DATA_STRUCT_SIZE:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_INVALID_DATA:
Retval A3D_ERROR:
Return:: A3D_SUCCESS on success, or an error code on failure
Param pModelFile:: [in] Model file to work on.
Param pOptMrkRView:: [in] optional A3DMkpView (cut, filter and/or move entities).
Param psHLRViewPlaneData:: [in] define a plane as a camera with orthogonal projection.
Param pNumberHLRData:: [out] Number A3DHLRRepresentationItemData.
Param pppHLRData:: [out] HLR curve result grouped by A3DRiRepresentationItem entity. pppHLRData is automatically allocated by A3DComputeOrthoHLROnModelFile.
Retval A3D_SUCCESS:
Retval A3D_INVALID_DATA_STRUCT_NULL:
Retval A3D_INVALID_DATA_STRUCT_SIZE:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_INVALID_DATA:
Retval A3D_ERROR:
Retval A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE:
Return:: A3D_SUCCESS on success, or an error code on failure
Param pModelFile:: [in] Model file to work on.
Param pOptMrkRView:: [in] optional A3DMkpView (cut, filter and/or move entities).
Param psHLRViewPlaneData:: [in] define a plane as a camera with orthogonal projection.
Param pNumberHLRRepItem:: [out] Number A3DHLRRepresentationItem.
Param pppHLRRepItem:: [out] HLR curve result grouped by A3DRiRepresentationItem entity. pppHLRRepItem is automatically allocated by A3DComputeOrthoHLROnModelFile.
Retval A3D_SUCCESS:
Retval A3D_INVALID_DATA_STRUCT_NULL:
Retval A3D_INVALID_DATA_STRUCT_SIZE:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_INVALID_DATA:
Retval A3D_ERROR:
Retval A3D_TOOLS_INVALID_SECTION_PLANE:
Retval A3D_INCOMPATIBLE_FUNCTION_WITH_KEEP_PARSED_ENTITY_MODE:
Return:: A3D_SUCCESS on success, or an error code on failure
Retval A3D_SUCCESS:
Retval A3D_ERROR:: if not on Linux
Return:: A3D_SUCCESS on success, or an error code on failure
Retval A3D_INITIALIZE_NOT_CALLED:
Retval A3D_INVALID_DATA_STRUCT_SIZE:
Retval A3D_INVALID_DATA_STRUCT_NULL:
Retval A3D_INVALID_ENTITY_NULL:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_SUCCESS:
Retval A3D_INITIALIZE_NOT_CALLED:
Retval A3D_INVALID_DATA_STRUCT_SIZE:
Retval A3D_INVALID_DATA_STRUCT_NULL:
Retval A3D_INVALID_ENTITY_NULL:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_SUCCESS:
Retval A3D_INITIALIZE_NOT_CALLED:
Retval A3D_INVALID_DATA_STRUCT_SIZE:
Retval A3D_INVALID_DATA_STRUCT_NULL:
Retval A3D_INVALID_ENTITY_NULL:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_SUCCESS:
Return:: A3D_SUCCESS on success, or an error code on failure
Return:: A3D_SUCCESS on success, or an error code on failure
Return:: A3D_SUCCESS on success, or an error code on failure
Retval A3D_INITIALIZE_NOT_CALLED:
Retval A3D_INVALID_DATA_STRUCT_SIZE:
Retval A3D_INVALID_DATA_STRUCT_NULL:
Retval A3D_INVALID_ENTITY_NULL:
Retval A3D_INVALID_ENTITY_TYPE:
Retval A3D_SUCCESS:
Return:: A3D_SUCCESS on success, or an error code on failure
Retval A3D_ERROR:
Retval A3D_SUCCESS:
Return:: A3D_SUCCESS on success, or an error code on failure
Retval A3D_ERROR:
Retval A3D_SUCCESS:
Return:: A3D_SUCCESS on success, or an error code on failure

Function Documentation

A3DStatus A3DDllInitialize(A3DInt32 iMajorVersion, A3DInt32 iMinorVersion)

Starts a session with the library.

This function initializes the internal structures in the library.

Version: 2.0

Sample code

A3DInt32 iErr = A3D_SUCCESS;
A3DInt32 iMajorVersion = 0, iMinorVersion = 0;

iErr = A3DDllGetVersion( &iMajorVersion, &iMinorVersion );
if( iMajorVersion != A3D_DLL_MAJORVERSION ) 

    iErr = A3D_ERROR;

else if( iMinorVersion < A3D_DLL_MINORVERSION ) 

    iErr = A3D_ERROR;



if( iErr == A3D_SUCCESS ) 
{
    iErr = A3DDllInitialize( A3D_DLL_MAJORVERSION, A3D_DLL_MAJORVERSION );
    if ( iErr == A3D_SUCCESS )
    {
        /* Insert your own code to create/read models */
        /* ... */
        /* At end of process, terminate the DLL use */
        iErr = A3DDllTerminate();
    }
}

Warning

You must call this function before calling any other functions in the HOOPS Exchange, with these exceptions:

You can call A3DDllGetVersion anytime.
To have the library produce an XML trace file, you must call A3DDllActivateXMLTrace before calling this function.

Parameters:

iMajorVersion – The major version of the HOOPS Exchange. Set this value to A3D_DLL_MAJORVERSION
iMinorVersion – The minor version of the HOOPS Exchange. Set this value to A3D_DLL_MINORVERSION

Return values:

`A3D_INITIALIZE_ALREADY_CALLED` –
`A3D_SUCCESS` –

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DDllTerminate()

Terminates a session with the library.

This function terminates a session with the library. It deallocates memory it has previously allocated for its internal use.

You must call this function to end a session with the library.

Version: 2.0

Warning

You can call this function only after successfully calling A3DDllInitialize.

Warning

When your process is done with A3DLIBS.dll (after calling A3DDllTerminate), you MUST unload that DLL, as shown in the sample code for A3DDllInitialize. Unloading the DLL helps to avoid conflicts that can occur when multiple processes use A3DLIBS.dll.

Warning

Processes must avoid parallel access to A3DLIBS.dll.

Return values:

A3D_INITIALIZE_NOT_CALLED –
A3D_SUCCESS –

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DDllGetVersion(A3DInt32 *piMajorVersion, A3DInt32 *piMinorVersion)

Gets the version identifiers for the currently installed library.

This function returns the version of the currently installed library. Use these version identifiers to determine whether that library is compatible with your application. The value returned through the piMajorVersion argument is identical to the Acrobat version identifier. The value returned through the piMinorVersion argument is specific to the library.

To ensure compatibility, the A3D_DLL_MAJORVERSION must be identical to the major version of currently installed library, and the A3D_DLL_MINORVERSION must be less than or equal to the minor version of the currently installed library.

You can call A3DDllGetVersion anytime, even before calling A3DDllInitialize and after calling A3DDllTerminate. This function does not allocate memory.

Version: 2.0

Return values:: A3D_SUCCESS –
Returns:: A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DDllGetBuildInformation(A3DUTF8Char **ppBuildInformation)

Gets information relative to build.

This function returns build information. This can be asked by support to help solving problem. This function does not allocate memory.

Version: 14.2

Return values:: A3D_SUCCESS –
Returns:: A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DDllIsInitialized()

Gets the status of the library initialization library.

This function returns the status of the library initialization library.

This function does not allocate memory.

Version: 11.0

Return values:: A3D_SUCCESS –
Returns:: A3D_SUCCESS on success, or an error code on failure