WanaPlan

API Docs for: 2.7.0
Show:

ExporterComponent3D

Extends BaseComponent3D
Module: Component
Parent Module: Wanaplan

Summary

A component for exporting a plan into a supported file format.

Constructor

ExporterComponent3D

Syntax

ExporterComponent3D

(
  • core
)

Summary

Parameters:

  • core Core

    The main engine.

Methods

destroy

Syntax

destroy

()

Summary

Called when the component is removed.

export

Syntax

export

(
  • format
  • options
)

Summary

Exports the scene into the desired format.

Parameters:

  • format String

    The desired format (stl, obj, dae, sketchfab).

  • options Object

    An object of options for the targeted exporter. You can see available options in the exporter documentation.

export

Syntax

export

(
  • format
  • options
)
static

Summary

Exports the scene into the desired format.

Parameters:

  • format String

    The desired format (stl, obj, dae, sketchfab).

  • options Object

    An object of options for the targeted exporter. You can see available options in the exporter documentation.

initialize

Syntax

initialize

() private

Summary

Initializes the component and adds a menu item.

onCancelClicked

Syntax

onCancelClicked

(
  • event
)
private

Summary

Closes the context menu.

Parameters:

  • event Event

    An event object.

onExporterPropertyChanged

Syntax

onExporterPropertyChanged

(
  • event
)
private

Summary

Updates a property when the user change it.

Parameters:

  • event Event

    An event object.

onExporterRequest

Syntax

onExporterRequest

(
  • event
)
private

Summary

Shows the exporter window and switches to 3D mode if needed.

Parameters:

  • event Event

    An event object.