HOOPS Publish Standard Actions Module

Detailed Description

group a3d_pdfaction

Module to set pre-defined HOOPS Publish Standard actions on PDF entities.

This module describes the functions and structures that allow you to define actions.

Function Documentation

A3DStatus A3DPDFActionSetViewCreate(const A3DPDFActionSetViewData *pData, A3DPDFActionSetView **ppAction)

Creates an A3DPDFActionSetView from A3DPDFActionSetViewData structure.

Version
10.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3DPDF_INVALID_VIEW_INDEX –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFActionStartAnimationCreate(const A3DPDFActionStartAnimationData *pData, A3DPDFActionStartAnimation **ppAction)

Creates an A3DPDFActionStartAnimation from A3DPDFActionStartAnimationData structure.

Version
10.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFActionPauseAnimationCreate(const A3DPDFActionPauseAnimationData *pData, A3DPDFActionPauseAnimation **ppAction)

Creates an A3DPDFActionPauseAnimation from A3DPDFActionPauseAnimationData structure.

Version
10.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFActionResumeAnimationCreate(const A3DPDFActionResumeAnimationData *pData, A3DPDFActionResumeAnimation **ppAction)

Creates an A3DPDFActionResumeAnimation from A3DPDFActionResumeAnimationData structure.

Version
10.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFActionSetRenderingStyleCreate(const A3DPDFActionSetRenderingStyleData *pData, A3DPDFActionSetRenderingStyle **ppAction)

Creates an A3DPDFActionSetRenderingStyle from A3DPDFActionSetRenderingStyleData structure.

Version
10.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFActionLaunchURLCreate(const A3DPDFActionLaunchURLData *pData, A3DPDFActionLaunchURL **ppAction)

Creates an A3DPDFActionLaunchURL from A3DPDFActionLaunchURLData structure.

Version
10.0

Return values:
  • A3D_INVALID_DATA_STRUCT_SIZE –
  • A3D_INVALID_DATA_STRUCT_NULL –
  • A3D_SUCCESS –
Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFButtonAddAction(A3DPDFButton *pButton, const A3DPDFAction *pAction)

Adds an action on a button.

Version
10.0

Parameters:
  • pButton – [inout] The button object to work with.
  • pAction – [in] The action to be stored on the button.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code
A3DStatus A3DPDFLinkAddAction(A3DPDFLink *pLink, const A3DPDFAction *pAction)

Adds an action on a link.

Version
10.0

Parameters:
  • pLink – [inout] The link object to work with.
  • pAction – [in] The action to be stored on the link.
Return values:

A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code