Animation functions. More...
Modules | |
| Bit Field to indicate which data must be interpolated. | |
Data Structures | |
| struct | A3DPDFAnimAppearanceData |
| Structure grouping the appearance characteristics. More... | |
| struct | A3DPDFAnimationData |
| Structure to define an animation. More... | |
| struct | A3DPDFAnimCameraData |
| Structure grouping the camera characteristics. More... | |
| struct | A3DPDFAnimKeyFrameData |
| Structure to define a keyframe. More... | |
| struct | A3DPDFAnimMotionData |
| Structure to define an animation motion. More... | |
| struct | A3DPDFAnimMotionData2 |
| Structure to define an animation motion. Replaces A3DPDFAnimMotionData. More... | |
| struct | A3DPDFAnimTransformationData |
| Structure to define a transformation. More... | |
| struct | A3DPDFTargetEntityData |
| Structure to define a target entity. More... | |
Functions | |
| A3DStatus | A3DPDF3DArtworkEditAnimationJavascript (A3DPDF3DArtwork *p3DArtwork, 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. More... | |
| A3DStatus | A3DPDFAnimationCreate (const A3DPDFAnimationData *pAnimationData, A3DPDFAnimation **ppAnimation) |
| Function to create an animation. More... | |
| A3DStatus | A3DPDFAnimKeyFrameCreate (const A3DPDFAnimKeyFrameData *pKeyFrameData, A3DPDFAnimKeyFrame **ppKeyFrame) |
| Function to create a keyframe. More... | |
| A3DStatus | A3DPDFAnimMotionCreate (const A3DPDFAnimMotionData *pMotionData, A3DPDFAnimMotion **ppAnimationMotion) |
| Function to create an animation motion. More... | |
| A3DStatus | A3DPDFAnimMotionCreate2 (const A3DPDFAnimMotionData2 *pMotionData, A3DPDFAnimMotion **ppAnimationMotion) |
| Function to create an animation motion. Replaces A3DPDFAnimMotionCreate. More... | |
| A3DStatus | A3DPDFGetEntitiesFromName (A3DAsmModelFile *pModelFile, A3DInt32 iNamesSize, A3DUTF8Char **ppNames, A3DInt32 *piIndexes, A3DPDFTargetEntity ****ppTargetEntities, A3DInt32 **ppiDataSizes) |
| Utility function to retrieve the targets from their names. More... | |
| A3DStatus | A3DPDFTargetEntityCreate (const A3DPDFTargetEntityData *pTargetData, A3DPDFTargetEntity **ppTargetEntity) |
| Structure to define a target entity of a motion. More... | |
Detailed Description
Animation functions.
This module describes the functions and structures that allow you to define 3D animations on a 3D Annot.
Function Documentation
| A3DStatus A3DPDF3DArtworkEditAnimationJavascript | ( | A3DPDF3DArtwork * | p3DArtwork, |
| 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.
- Parameters
-
[in,out] p3DArtwork The artwork which contains the animation. [in] pcJavascriptFile The path of the file in which the JavaScript will be outputted. The content of the file can be modified by the user. [in] bUseAnimationFile If true, the modified content will be used to generate the final PDF file.
- Returns
- A3D_SUCCESS
- Version
- 6.1
| A3DStatus A3DPDFAnimationCreate | ( | const A3DPDFAnimationData * | pAnimationData, |
| A3DPDFAnimation ** | ppAnimation | ||
| ) |
Function to create an animation.
- Parameters
-
[in] pAnimationData The animation parameters. [out] ppAnimation The animation object created.
- Returns
- A3D_SUCCESS
-
A3DPDF_ANIMATION_NULL_MOTION if one or several motions are null.
- Version
- 6.1
| A3DStatus A3DPDFAnimKeyFrameCreate | ( | const A3DPDFAnimKeyFrameData * | pKeyFrameData, |
| A3DPDFAnimKeyFrame ** | ppKeyFrame | ||
| ) |
Function to create a keyframe.
- Parameters
-
[in] pKeyFrameData The keyframe parameters. [out] ppKeyFrame The keyframe object created.
- Returns
- A3D_SUCCESS
- Version
- 6.1
| A3DStatus A3DPDFAnimMotionCreate | ( | const A3DPDFAnimMotionData * | pMotionData, |
| A3DPDFAnimMotion ** | ppAnimationMotion | ||
| ) |
Function to create an animation motion.
- Parameters
-
[in] pMotionData The motion parameters. [out] ppAnimationMotion The motion object created.
- Returns
- A3D_SUCCESS
- Version
- 6.1
| A3DStatus A3DPDFAnimMotionCreate2 | ( | const A3DPDFAnimMotionData2 * | pMotionData, |
| A3DPDFAnimMotion ** | ppAnimationMotion | ||
| ) |
Function to create an animation motion. Replaces A3DPDFAnimMotionCreate.
- Parameters
-
[in] pMotionData The motion parameters. [out] ppAnimationMotion The motion object created.
- Returns
- A3D_SUCCESS
- Version
- 7.1
| A3DStatus A3DPDFGetEntitiesFromName | ( | A3DAsmModelFile * | pModelFile, |
| A3DInt32 | iNamesSize, | ||
| A3DUTF8Char ** | ppNames, | ||
| A3DInt32 * | piIndexes, | ||
| A3DPDFTargetEntity **** | ppTargetEntities, | ||
| A3DInt32 ** | ppiDataSizes | ||
| ) |
Utility function to retrieve the targets from their names.
- Parameters
-
[in] pModelFile The model file which contains the targets. [in] iNamesSize The number of names in the next array. [in] ppNames The array of names. [in] piIndexes If the targeted entity had sons, index of the son in the model file tree. Must be -1 if no sons are wanted. [out] ppTargetEntities The targeted entities retrieved. If several entities in the model file tree have the same name, all these entities are in the array. [out] ppiDataSizes For each name, the number of found entities.
- Returns
- A3D_ERROR if wrong parameters are given
-
A3D_SUCCESS
- Version
- 7.1
| A3DStatus A3DPDFTargetEntityCreate | ( | const A3DPDFTargetEntityData * | pTargetData, |
| A3DPDFTargetEntity ** | ppTargetEntity | ||
| ) |
Structure to define a target entity of a motion.
- Version
- 7.1
