Module to define Animation. 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. More...
 
struct  A3DPDFAnimTransformationData
 Structure to define a transformation. More...
 
struct  A3DPDFTargetEntityData
 Structure to define a target entity. More...
 

Functions

A3DStatus A3DPDF3DArtworkEditAnimationJavascript (A3DPDF3DArtwork *p3DArtwork, const A3DUTF8Char *pcJavascriptFile, A3DBool bUseAnimationFile)
 Debug function to edit the JavaScript stream corresponding to the animation data in a file. 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. 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

Module to define Animation.

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

Function Documentation

◆ A3DPDFAnimKeyFrameCreate()

A3DStatus A3DPDFAnimKeyFrameCreate ( const A3DPDFAnimKeyFrameData pKeyFrameData,
A3DPDFAnimKeyFrame **  ppKeyFrame 
)

Function to create a keyframe.

Parameters
[in]pKeyFrameDataThe keyframe parameters.
[out]ppKeyFrameThe keyframe object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
6.1

◆ A3DPDFTargetEntityCreate()

A3DStatus A3DPDFTargetEntityCreate ( const A3DPDFTargetEntityData pTargetData,
A3DPDFTargetEntity **  ppTargetEntity 
)

Structure to define a target entity of a motion.

Returns
A3D_SUCCESS in case of success or an error code
Return values
A3DPDF_BAD_PARAMETERSif wrong parameters are given : see A3DPDFTargetEntityData
A3D_SUCCESS
Version
7.1

◆ A3DPDFGetEntitiesFromName()

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]pModelFileThe model file which contains the targets.
[in]iNamesSizeThe number of names.
[in]ppNamesAn array of names of size iNamesSize.
[in]piIndexesIf the targeted entity had sons, index of the son in the model file tree. Must be -1 if no sons are wanted.
[out]ppTargetEntitiesThe targeted entities retrieved. If several entities in the model file tree have the same name, all these entities are in the array.
[out]ppiDataSizesFor each name, the number of found entities.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
A3D_ERRORif wrong parameters are given
Version
7.1

◆ A3DPDFAnimMotionCreate()

A3DStatus A3DPDFAnimMotionCreate ( const A3DPDFAnimMotionData pMotionData,
A3DPDFAnimMotion **  ppAnimationMotion 
)

Function to create an animation motion.

Deprecated:
This function is deprecated. Please use A3DPDFAnimMotionCreate2 instead.
Parameters
[in]pMotionDataThe motion parameters.
[out]ppAnimationMotionThe motion object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
6.1

◆ A3DPDFAnimMotionCreate2()

A3DStatus A3DPDFAnimMotionCreate2 ( const A3DPDFAnimMotionData2 pMotionData,
A3DPDFAnimMotion **  ppAnimationMotion 
)

Function to create an animation motion.

Parameters
[in]pMotionDataThe motion parameters.
[out]ppAnimationMotionThe motion object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
7.1

◆ A3DPDFAnimationCreate()

A3DStatus A3DPDFAnimationCreate ( const A3DPDFAnimationData pAnimationData,
A3DPDFAnimation **  ppAnimation 
)

Function to create an animation.

Parameters
[in]pAnimationDataThe animation parameters.
[out]ppAnimationThe animation object created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
A3DPDF_ANIMATION_NULL_MOTIONif one or several motions are null.
Version
6.1

◆ A3DPDF3DArtworkEditAnimationJavascript()

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.

Parameters
[in,out]p3DArtworkThe artwork which contains the animation.
[in]pcJavascriptFileThe path of the file in which the JavaScript will be outputted. The content of the file can be modified by the user.
[in]bUseAnimationFileIf true, the modified content will be used to generate the final PDF file.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
6.1