(HOOPS Publish Advanced) Module to access and define View Carousel widget More...

Data Structures

struct  A3DPDF3DViewCarouselData
 Structure to define a view carousel widget. More...
 

Enumerations

enum  A3DPDFEDirection {
  kA3DPDFHorizontal = 0,
  kA3DPDFVertical
}
 Direction of scrolling for a widget (usually View Carousel) More...
 

Functions

A3DStatus A3DPDF3DViewCarouselCreate (A3DPDFDocument *pDoc, const A3DPDF3DViewCarouselData *p3DViewCarouselData, A3DPDF3DViewCarousel **pp3DViewCarousel)
 Function to create a view carousel widget. More...
 
A3DStatus 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. More...
 
A3DStatus A3DPDFPageInsert3DViewCarousel (A3DPDFPage *pPage, A3DPDF3DViewCarousel *pCarousel)
 Function to insert a view carousel widget in a page. More...
 

Detailed Description

(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.

Enumeration Type Documentation

◆ A3DPDFEDirection

Direction of scrolling for a widget (usually View Carousel)

Version
10.0
Enumerator
kA3DPDFHorizontal 

Horizontal direction.

kA3DPDFVertical 

Vertical direction.

Function Documentation

◆ A3DPDFDefineViewCarousel()

A3DStatus 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 to implement the same behaviour (see Data Model Module module).

The PDF document must contain the buttons for the views and the buttons to go to the next and the previous view.

Parameters
[in,out]pDocThe document which will contain the carousel.
[in]pPageThe page where the carousel will be put.
[in]pAnnotThe annotation which contains the views of the carousel.
[in]pModelFileThe model file corresponding with the annotation.
[in]iNbButtonsThe number of buttons in the ppButtonsNames array.
[in]ppButtonsNamesThe names of the view buttons in the pdf file. The size of this array should be iNbButtonsRows*iNbButtonsCols.
[in]pPreviousButtonNameThe name of the button to press to scroll the carousel to previous views.
[in]pNextButtonNameThe name of the button to press to scroll the carousel to next views.
[in]iNbViewsIf 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.
[in]ppViewsIf 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.
[in]ppImagesIf NULL, the images are automatically created from the views and the following applies:

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.

Parameters
[in]iScrollStepThis 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).
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
8.0

◆ A3DPDF3DViewCarouselCreate()

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.

Parameters
[in,out]pDocThe Document object to work with.
[in]p3DViewCarouselDataThe view carousel parameters. The name is mandatory.
[out]pp3DViewCarouselThe view carousel created.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.0

◆ A3DPDFPageInsert3DViewCarousel()

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.

Parameters
[in,out]pPageThe Page object to work with.
[in]pCarouselThe button object to insert on the page.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_SUCCESS
Version
10.0