3D viewer
Introduction
The 3D viewer module is the 3D standalone viewer provided by TraceParts.
Description
This module provides a 3D viewer of the 3D model of one given part number of a catalog. This module includes 3 ways of visualization based on 3 different technologies. The optimized one is automatically chosen related to the version of the web browser.
Building a URL
The 3D viewer request takes the following form:
https://www.traceparts.com/els/ELSID/en/api/viewer/3d?parameters
Parameters
Certain parameters are required while others are optional. As it is standard in URLs, all parameters are separated using the ampersand (&) character. The list of parameters and their possible values are enumerated below.
The final URL containing your EasyLink ID (ELSID) will be provided by your TraceParts account manager.
Required parameters
|
Parameter Name |
Data type |
Default value |
Description |
|
SupplierID |
string |
none |
CatalogID given by the CatalogsList API |
|
PartNumber |
string |
none |
Part number of the catalog from the TraceParts database |
Optional parameters (Rendering)
|
Parameter Name |
Data type |
Default value |
Description |
|
SetBackgroundColor |
Hexadecimal |
0xFFFFFF |
Sets a color on the background of the 3D viewer. |
|
SetRenderMode |
text |
shaded-edged |
Rendering of the 3D model. Values: “shaded-edged”, “shaded”, “transparent”, “wireframe”, “edged” |
|
DisplayGroundGrid |
Boolean |
false |
Enable the ground grid |
|
SetGroundGridColor |
Hexadecimal |
0x000000 |
Changes the color of the ground grid when DisplayGroundGrid=true |
|
EnableMirrorEffect |
Boolean |
true |
Enable the mirror effect on the XZ plane |
|
DisplayCoordinateSystem |
Boolean |
false |
Display the coordinate system |
|
EnablePresentationMode |
Boolean |
false |
The model rotates on the Y axis until a user interaction |
Optional parameters (toolbars)
|
Parameter Name |
Data type |
Default value |
Description |
|
DisplayUIMenu |
Boolean |
true |
Display the toolbars (on the bottom and on the right) |
|
DisplayUIMenuBottom |
Boolean |
true |
Display the bottom menu with Selection, Reset, Screenshot and Settings sub menus |
|
DisplayUIMenuRight |
Boolean |
false |
Display the right menu with Presentation, Views and Render sub menus |
|
DisplayUIContextMenu |
Boolean |
true |
Enable the contextual menu with Views and Render sub menus |
|
EnableUIMenuBottomFadeOut |
Boolean |
true |
Enable the fide out effect of the bottom menu |
|
EnableUIMenuRightFadeOut |
Boolean |
true |
Enable the fide out effect of the right menu |
|
DisplayUISelectionModeSubMenu |
Boolean |
true |
Display the Selection sub menu |
|
DisplayUIResetButtonMenu |
Boolean |
true |
Display the Reset button |
|
DisplayUIScreenshotButtonMenu |
Boolean |
true |
Display the Screenshot button |
|
DisplayUISettingsSubMenu |
Boolean |
true |
Display the Settings menu |
|
DisplayUIViewsSubMenu |
Boolean |
true |
Display the Views sub menu |
|
DisplayUIRenderModesSubMenu |
Boolean |
true |
Display the Render sub menu |
|
DisplayUIPresentationModeButtonMenu |
Boolean |
true |
Display the Presentation button |
|
DisplayUIViewsSubContextMenu |
Boolean |
true |
Display the Views sub menu (for the contextual menu) |
|
DisplayUIRenderModesSubContextMenu |
Boolean |
true |
Display the Render sub menu (for the contextual menu) |
Example of 3D viewer call
The request below returns the 3D viewer of the part number “1857837” from the PHOENIX CONTACT catalog.
https://www.traceparts.com/els/phoenix-contact/en/api/viewer/3d?SupplierID=PHOENIX_CONTACT&PartNumber=1857837
By using the DisplayCoordinateSystem parameter, the coordinate system is display on the left corner.
https://www.traceparts.com/els/phoenix-contact/en/api/viewer/3d?SupplierID=PHOENIX_CONTACT&PartNumber=1857837&DisplayCoordinateSystem=true
Developer support
Please contact us for any problems, questions or comments related to this module.
Last updated November 20, 2018