View Carousel Module

Types

	A3DPDF3DViewCarouselData
	A3DPDFEDirection

Fields

	kA3DPDFHorizontal
	kA3DPDFVertical

Functions

	A3D_API_DEPRECATED
A3DStatus	A3DPDF3DViewCarouselCreate
A3DStatus	A3DPDFPageInsert3DViewCarousel

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

enum A3DPDFEDirection

Direction of scrolling for a widget (usually View Carousel)

Version

10.0

Values:

enumerator kA3DPDFHorizontal

Horizontal direction.

enumerator kA3DPDFVertical

Vertical direction.

Function Documentation

Warning

doxygenfunction: Unable to resolve function “A3D_API_DEPRECATED” with arguments “None”. Candidate function could not be parsed. Parsing error is Error when parsing function declaration. If the function has no return type: Error in declarator or parameters-and-qualifiers Invalid C++ declaration: Expected identifier in nested name. [error at 60] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) ————————————————————^ If the function has a return type: Error in declarator If declarator-id with parameters-and-qualifiers: Invalid C++ declaration: Expected identifier in nested name. [error at 19] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) ——————-^ If parenthesis in noptr-declarator: Error in declarator or parameters-and-qualifiers If pointer to member declarator: Invalid C++ declaration: Expected ‘::’ in pointer to member (function). [error at 29] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) —————————–^ If declarator-id: Invalid C++ declaration: Expecting “(” in parameters-and-qualifiers. [error at 29] A3D_API_DEPRECATED (A3DStatus, A3DPDFDocumentAddImageAsIcon,(A3DPDFDocument *pDoc, const A3DPDFImage *pImage, const A3DUTF8Char *pcIconName)) —————————–^

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