HOOPS Publish Standard Actions Module

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

Data Structures

struct  A3DPDFActionLaunchURLData
 Structure to define an action to launch a URL in a browser window. More...
 
struct  A3DPDFActionPauseAnimationData
 Structure to define an action to pause the animation player on a 3D annotation. More...
 
struct  A3DPDFActionResumeAnimationData
 Structure to define an action to resume the animation player on a 3D annotation. More...
 
struct  A3DPDFActionSetRenderingStyleData
 Structure to define an action to set the default rendering type for all objects in the scene on a 3D annotation. More...
 
struct  A3DPDFActionSetViewData
 Structure to define an action to activate a view in a 3D annotation. More...
 
struct  A3DPDFActionStartAnimationData
 Structure to define an action to start an animation on a 3D annotation. More...
 

Functions

A3DStatus A3DPDFActionLaunchURLCreate (const A3DPDFActionLaunchURLData *pData, A3DPDFActionLaunchURL **ppAction)
 Creates an A3DPDFActionLaunchURL from A3DPDFActionLaunchURLData structure. More...
 
A3DStatus A3DPDFActionPauseAnimationCreate (const A3DPDFActionPauseAnimationData *pData, A3DPDFActionPauseAnimation **ppAction)
 Creates an A3DPDFActionPauseAnimation from A3DPDFActionPauseAnimationData structure. More...
 
A3DStatus A3DPDFActionResumeAnimationCreate (const A3DPDFActionResumeAnimationData *pData, A3DPDFActionResumeAnimation **ppAction)
 Creates an A3DPDFActionResumeAnimation from A3DPDFActionResumeAnimationData structure. More...
 
A3DStatus A3DPDFActionSetRenderingStyleCreate (const A3DPDFActionSetRenderingStyleData *pData, A3DPDFActionSetRenderingStyle **ppAction)
 Creates an A3DPDFActionSetRenderingStyle from A3DPDFActionSetRenderingStyleData structure. More...
 
A3DStatus A3DPDFActionSetViewCreate (const A3DPDFActionSetViewData *pData, A3DPDFActionSetView **ppAction)
 Creates an A3DPDFActionSetView from A3DPDFActionSetViewData structure. More...
 
A3DStatus A3DPDFActionStartAnimationCreate (const A3DPDFActionStartAnimationData *pData, A3DPDFActionStartAnimation **ppAction)
 Creates an A3DPDFActionStartAnimation from A3DPDFActionStartAnimationData structure. More...
 
A3DStatus A3DPDFButtonAddAction (A3DPDFButton *pButton, const A3DPDFAction *pAction)
 Adds an action on a button. More...
 
A3DStatus A3DPDFLinkAddAction (A3DPDFLink *pLink, const A3DPDFAction *pAction)
 Adds an action on a link. More...
 

Detailed Description

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

◆ A3DPDFActionSetViewCreate()

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

Creates an A3DPDFActionSetView from A3DPDFActionSetViewData structure.

Version
10.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3DPDF_INVALID_VIEW_INDEX
A3D_SUCCESS

◆ A3DPDFActionStartAnimationCreate()

A3DStatus A3DPDFActionStartAnimationCreate ( const A3DPDFActionStartAnimationData pData,
A3DPDFActionStartAnimation **  ppAction 
)

Creates an A3DPDFActionStartAnimation from A3DPDFActionStartAnimationData structure.

Version
10.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DPDFActionPauseAnimationCreate()

A3DStatus A3DPDFActionPauseAnimationCreate ( const A3DPDFActionPauseAnimationData pData,
A3DPDFActionPauseAnimation **  ppAction 
)

Creates an A3DPDFActionPauseAnimation from A3DPDFActionPauseAnimationData structure.

Version
10.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DPDFActionResumeAnimationCreate()

A3DStatus A3DPDFActionResumeAnimationCreate ( const A3DPDFActionResumeAnimationData pData,
A3DPDFActionResumeAnimation **  ppAction 
)

Creates an A3DPDFActionResumeAnimation from A3DPDFActionResumeAnimationData structure.

Version
10.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DPDFActionSetRenderingStyleCreate()

A3DStatus A3DPDFActionSetRenderingStyleCreate ( const A3DPDFActionSetRenderingStyleData pData,
A3DPDFActionSetRenderingStyle **  ppAction 
)

Creates an A3DPDFActionSetRenderingStyle from A3DPDFActionSetRenderingStyleData structure.

Version
10.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DPDFActionLaunchURLCreate()

A3DStatus A3DPDFActionLaunchURLCreate ( const A3DPDFActionLaunchURLData pData,
A3DPDFActionLaunchURL **  ppAction 
)

Creates an A3DPDFActionLaunchURL from A3DPDFActionLaunchURLData structure.

Version
10.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DPDFButtonAddAction()

A3DStatus A3DPDFButtonAddAction ( A3DPDFButton pButton,
const A3DPDFAction pAction 
)

Adds an action on a button.

Parameters
[in,out]pButtonThe button object to work with.
[in]pActionThe action to be stored on the button.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.0

◆ A3DPDFLinkAddAction()

A3DStatus A3DPDFLinkAddAction ( A3DPDFLink pLink,
const A3DPDFAction pAction 
)

Adds an action on a link.

Parameters
[in,out]pLinkThe link object to work with.
[in]pActionThe action to be stored on the link.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.0