au-widget-3d-viewer/au-widget-3d-viewer

Classes

AuWidget3DViewer

A widget that is used to render 3D previews based on DAE models.

The following example illustrates how you can use proof images obtained from the DesignEditor to visualize a model in the 3D-Viewer widget.

{
  "widgets": [
    {
      "name": "previewer",
      "type": "3d-viewer",
      "params": {
        "showAnimationButtons": false,
        "showCameraButtons": true,
        "items": [
          {
            "images": "{{ $['editor'].proofImageUrls }}",
            "model": "models/trifold.dae"
          }
        ]
      }
    }
  ]
}

Extends

Au3dViewerBase

Constructors

Constructor

new AuWidget3DViewer(): AuWidget3DViewer;

Returns

AuWidget3DViewer

Inherited from

Au3dViewerBase.constructor

Properties

image

image: string;

A base64 URL that links to the rendered model image in the initial position.

Inherited from

Au3dViewerBase.image

params

params: any;

Compiled widget configuration.

Inherited from

Au3dViewerBase.params

paused

paused: boolean = false;

If true, animation is paused.

Inherited from

Au3dViewerBase.paused

speed

speed: number = 1;

The current animation speed.

Inherited from

Au3dViewerBase.speed

Methods

checkInitDependenciesWidgets()

checkInitDependenciesWidgets(): string[];

Returns an array of widget names, due to which the current widget cannot receive parameters.

Returns

string[]

Inherited from

Au3dViewerBase.checkInitDependenciesWidgets

closeBox()

closeBox(): void;

Closes the dynamic model.

Returns

void

Inherited from

Au3dViewerBase.closeBox

GetAnimationDuration()

GetAnimationDuration(): number;

Gets the longest animation time in the model.

Returns

number

Inherited from

Au3dViewerBase.GetAnimationDuration

openBox()

openBox(): void;

Opens the dynamic model.

Returns

void

Inherited from

Au3dViewerBase.openBox

PauseAnimation()

PauseAnimation(): void;

Pauses animation.

Returns

void

Inherited from

Au3dViewerBase.PauseAnimation

PlayAnimation()

PlayAnimation(): void;

Plays animation.

Returns

void

Inherited from

Au3dViewerBase.PlayAnimation

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

Au3dViewerBase.resetPreloaderState

SetAnimationAt()

SetAnimationAt(value): void;

Navigates to animation time.

Parameters

Parameter	Type	Description
`value`	`number`	The animation time.

Returns

void

Inherited from

Au3dViewerBase.SetAnimationAt

SetAnimationSpeed()

SetAnimationSpeed(value): void;

Sets the animation speed.

1 - the default speed.

<0 - reverse animation.

-1 - the default speed for reverse animation.

0 - pause.

>1 - increments speed.

Parameters

Parameter	Type
`value`	`number`

Returns

void

Inherited from

Au3dViewerBase.SetAnimationSpeed

showPreloader()

showPreloader(
   isPreload,
   message?,
   timeout?): void;

Shows a preloader.

"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]

Parameters

Parameter	Type	Default value	Description
`isPreload`	`boolean`	`undefined`	If `true`, enables the preloader.
`message`	`string` \| `string`[]	`...`	A text message that appears next to the preloader.
`timeout`	`number`	`5`	-

Returns

void

Inherited from

Au3dViewerBase.showPreloader

showToast()

showToast(data?, duration?): void;

Shows a toast.

return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });

Parameters

Parameter	Type	Description
`data?`	`string`	A string message to display in the toast.
`duration?`	`number`	Defines how long to show the toast for.

Returns

void

Inherited from

Au3dViewerBase.showToast

References

Renames and re-exports AuWidget3DViewer

Classes​