Animation Module

Detailed Description

group a3d_pdf_animation_module

Module to define Animation.

This module describes the functions and structures that allow you to define 3D animations on a 3D Annot.

Function Documentation

A3DStatus deprecated_A3DPDFAnimMotionCreate(const deprecated_A3DPDFAnimMotionData *pMotionData, A3DPDFAnimMotion **ppAnimationMotion)

Function to create an animation motion.

Deprecated:

This function is deprecated. Please use A3DPDFAnimMotionCreate2 instead. This will be removed in version 2026.1.0. When migrating from A3DPDFAnimMotionCreate to A3DPDFAnimMotionCreate2, please be sure to specify targets as A3DPDFTargetEntity instead of A3DMiscMarkupLinkedItem.

Version
6.1

Parameters:
  • pMotionData – [in] The motion parameters.
  • ppAnimationMotion – [out] The motion object created.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFAnimKeyFrameCreate(const A3DPDFAnimKeyFrameData *pKeyFrameData, A3DPDFAnimKeyFrame **ppKeyFrame)

Function to create a keyframe.

Version
6.1

Parameters:
  • pKeyFrameData – [in] The keyframe parameters.
  • ppKeyFrame – [out] The keyframe object created.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFTargetEntityCreate(const A3DPDFTargetEntityData *pTargetData, A3DPDFTargetEntity **ppTargetEntity)

Structure to define a target entity of a motion.

Version
7.1

Return values:
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFGetEntitiesFromName(A3DAsmModelFile *pModelFile, A3DInt32 iNamesSize, A3DUTF8Char **ppNames, A3DInt32 *piIndexes, A3DPDFTargetEntity ****ppTargetEntities, A3DInt32 **ppiDataSizes)

Utility function to retrieve the targets from their names.

Version
7.1

Parameters:
  • pModelFile – [in] The model file which contains the targets.
  • iNamesSize – [in] The number of names.
  • ppNames – [in] An array of names of size iNamesSize.
  • piIndexes – [in] If the targeted entity had sons, index of the son in the model file tree. Must be -1 if no sons are wanted.
  • ppTargetEntities – [out] The targeted entities retrieved. If several entities in the model file tree have the same name, all these entities are in the array.
  • ppiDataSizes – [out] For each name, the number of found entities.
Return values:
  • A3D_SUCCESS –
  • A3D_ERROR – if wrong parameters are given
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFAnimMotionCreate2(const A3DPDFAnimMotionData2 *pMotionData, A3DPDFAnimMotion **ppAnimationMotion)

Function to create an animation motion.

Version
7.1

Parameters:
  • pMotionData – [in] The motion parameters.
  • ppAnimationMotion – [out] The motion object created.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFAnimationCreate(const A3DPDFAnimationData *pAnimationData, A3DPDFAnimation **ppAnimation)

Function to create an animation.

Version
6.1

Parameters:
  • pAnimationData – [in] The animation parameters.
  • ppAnimation – [out] The animation object created.
Return values:
  • A3D_SUCCESS –
  • A3DPDF_ANIMATION_NULL_MOTION – if one or several motions are null.
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDF3DArtworkEditAnimationJavascript(A3DPDF3DArtwork *p3DArtwork, const A3DUTF8Char *pcJavascriptFile, A3DBool bUseAnimationFile)

Debug function to edit the JavaScript stream corresponding to the animation data in a file.

If bUseAnimationFile is set to false, the ‘standard’ JavaScript of the animation will be created from the animation data. If true, the output file will be used instead of the animation data. To use the new content, the code execution should be stopped after the call to this function, then the code modified, then the execution restarted. This function must be called before A3DPDF3DAnnotCreate.

Version
6.1

Parameters:
  • p3DArtwork – [inout] The artwork which contains the animation.
  • pcJavascriptFile – [in] The path of the file in which the JavaScript will be outputted. The content of the file can be modified by the user.
  • bUseAnimationFile – [in] If true, the modified content will be used to generate the final PDF file.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code