A3DPDFActionStartAnimationData

struct A3DPDFActionStartAnimationData

Structure to define an action to start an animation on a 3D annotation.

This action is to start an animation on the 3D annotation. The animation can later be paused or resumed with other actions:c:type:~A3DPDFActionPauseAnimationand:c:type:~A3DPDFActionResumeAnimation.

The animation can be a native animation (typically in a U3D file), or an animation built with HOOPS Publish API (see:ref:Animation Module <group__a3d__pdf__animation__module>). This should be set with:c:member:m_bIsNativeAnimation <A3DPDFActionStartAnimationData.m_bIsNativeAnimation>.

  • A native (U3D) animation is identified with:c:member:m_iAnimIndex <A3DPDFActionStartAnimationData.m_iAnimIndex>, and [m_dStartTime,:c:member:m_dEndTime <A3DPDFActionStartAnimationData.m_dEndTime>]. Use:c:member:m_dStartTime=0. <A3DPDFActionStartAnimationData.m_dStartTime>and:c:member:m_dEndTime=-1. <A3DPDFActionStartAnimationData.m_dEndTime>to run all the animation.
  • A HOOPS Publish animation is identified primarily by:c:member:m_pcAnimName <A3DPDFActionStartAnimationData.m_pcAnimName>. If:c:member:m_pcAnimName <A3DPDFActionStartAnimationData.m_pcAnimName>is NULL, then the animation is identified by its index (m_iAnimIndex). If:c:member:m_iAnimIndex <A3DPDFActionStartAnimationData.m_iAnimIndex>is -1, then the animation is run from:c:member:m_dStartTime <A3DPDFActionStartAnimationData.m_dStartTime>to:c:member:m_dEndTime <A3DPDFActionStartAnimationData.m_dEndTime>. Use:c:member:m_dStartTime=0. <A3DPDFActionStartAnimationData.m_dStartTime>and:c:member:m_dEndTime=-1. <A3DPDFActionStartAnimationData.m_dEndTime>to run all the animation.

s

10.0

Variables

A3DPDF3DAnnot *A3DPDFActionStartAnimationData.m_p3DAnnot

The 3D annotation that holds the animations.

A3DUTF8Char *A3DPDFActionStartAnimationData.m_pcAnimName

Name identifier of the animation in the 3D annotation.

A3DInt32 A3DPDFActionStartAnimationData.m_iAnimIndex

Index identifier of the animation in the 3D annotation.

A3DBool A3DPDFActionStartAnimationData.m_bIsNativeAnimation

True if the animation is natively stored into the Artwork.

The only situation currently supported for this scenario is a U3D file with a U3D native animation embedded.

A3DDouble A3DPDFActionStartAnimationData.m_dStartTime

Time where to start the animation (in seconds).

A3DDouble A3DPDFActionStartAnimationData.m_dEndTime

Time where to end the animation (in seconds).

If the value is -1., the animation runs until its end.