View Carousel Module
Functions
A3DStatus |
A3DPDF3DViewCarouselCreate |
A3DStatus |
A3DPDFPageInsert3DViewCarousel |
A3DStatus |
deprecated_A3DPDFDefineViewCarousel |
Detailed Description
-
group
a3d_pdfwidget_carousel (HOOPS Publish Advanced) Module to access and define View Carousel widget
This module describes the functions and structures that allow you to define a View Carousel. A View Carousel is a high level widget to display a set of 3D views. The view list is displayed on a set of buttons, each button icon shows the poster related to the view, and the icon has the view name as label. The user can scroll the buttons set with previous and next buttons.
Type Documentation
Function Documentation
-
A3DStatus
A3DPDF3DViewCarouselCreate(A3DPDFDocument *pDoc, const A3DPDF3DViewCarouselData *p3DViewCarouselData, A3DPDF3DViewCarousel **pp3DViewCarousel) Function to create a view carousel widget.
The view carousel widget is primarily created with this function, and it should be positioned on the page with the function A3DPDFPageInsert3DViewCarousel. Ultimately, the widget should be linked to a data table with A3DPDF3DViewCarouselBindToTable.
- Version
- 10.0
Parameters: - pDoc – [inout] The Document object to work with.
- p3DViewCarouselData – [in] The view carousel parameters. The name is mandatory.
- pp3DViewCarousel – [out] The view carousel created.
Return values: A3D_SUCCESS –
Returns: A3D_SUCCESS in case of success or an error code
-
A3DStatus
A3DPDFPageInsert3DViewCarousel(A3DPDFPage *pPage, A3DPDF3DViewCarousel *pCarousel) Function to insert a view carousel widget in a page.
The page must be the same as the page of the underlying buttons.
- Version
- 10.0
Parameters: - pPage – [inout] The Page object to work with.
- pCarousel – [in] The button object to insert on the page.
Return values: A3D_SUCCESS –
Returns: A3D_SUCCESS in case of success or an error code
-
A3DStatus
deprecated_A3DPDFDefineViewCarousel(A3DPDFDocument *pDoc, A3DPDFPage *pPage, A3DPDF3DAnnot *pAnnot, A3DAsmModelFile *pModelFile, A3DInt32 iNbButtons, A3DUTF8Char **ppButtonsNames, A3DUTF8Char *pPreviousButtonName, A3DUTF8Char *pNextButtonName, A3DInt32 iNbViews, A3DPDFView **ppViews, A3DPDFImage **ppImages, A3DInt32 iScrollStep) Function to create a ‘standard’ view carousel and position it in the PDF document.
- Deprecated:
This function is deprecated. Please use the A3DPDF3DViewCarousel widget and A3DPDFDataTable instead to implement the same behaviour (see Data Model Module module). This will be removed in version 2026.1.0.
The PDF document must contain the buttons for the views and the buttons to go to the next and the previous view.
HOOPS Publish uses the graphics driver of the user’s PC. By default, HOOPS Publish attempts to select the graphics driver in this order: DX11->DX9->OpenGL2->OpenGL. To override the default driver selection, set the A3DPOSTERDRV environment variable to one of the following values: DX11, DX9, OGL2, OGL1
If not NULL, ppImages must contain the images that will be used for the views. In that case, the size of the array should be the same as the size of ppViews parameter.
- Version
- 8.0
Parameters: - pDoc – [inout] The document which will contain the carousel.
- pPage – [in] The page where the carousel will be put.
- pAnnot – [in] The annotation which contains the views of the carousel.
- pModelFile – [in] The model file corresponding with the annotation.
- iNbButtons – [in] The number of buttons in the ppButtonsNames array.
- ppButtonsNames – [in] The names of the view buttons in the pdf file. The size of this array should be iNbButtonsRows*iNbButtonsCols.
- pPreviousButtonName – [in] The name of the button to press to scroll the carousel to previous views.
- pNextButtonName – [in] The name of the button to press to scroll the carousel to next views.
- iNbViews – [in] If equal to 0, all the views of the model file will be used, in the order they are found in the model file. If superior than 0, the number of the views of the next parameter.
- ppViews – [in] If NULL, all the views of the model file will be used. If not NULL, ppViews must contain the views that will be used for the carousel.
- ppImages – [in] If NULL, the images are automatically created from the views and the following applies:
- iScrollStep – [in] This is the number of buttons icons scrolled. If = iNbButtons, the carousel scrolls the icons by page (all the icons are replaced in the carousel). If = the number of rows, the icons are scrolled by rows. If = the number of columns, the icons are scrolled by columns. If = 1, the carousel scrolls the icons one by one (all the icons are shifted of 1 increment in the carousel).
Return values: A3D_SUCCESS –
Returns: A3D_SUCCESS in case of success or an error code
