ImporterNode

The ImporterNode performs import and convert tasks using the CVP Importers Plugin SDK. It can be used to bring 3D content into the project folder and transform the content into formats that can then be loaded by the XR framework.

• ImporterNode gives unified access to a large set of importers/converters with multiple input and output file formats.

• Multiple ImporterNodes can run in parallel to perform different import/convert tasks.

• ImporterNode is included in the Importers Plugin.

  Note: Some importers/converters that are supported by ImporterNode may not work properly when consumed directly inside a XR Studio Graphic Context. We suggest that you test the importer node behavior with XR Viewer.

Platform support

This node is supported on XR-Windows platform only.

Import and convert workflow

When an ImporterNode is available, these are the steps to perform the task:

1. Select the importer/converter to use by setting the importerCode field. Each importerCode corresponds to a different importer. When setting the importerCode, the importer/converter list of parameters is refreshed in the node.

2. Configure all the required parameters/XXX fields to customize the importer task.

3. Start the task by invoking the start field.

4. Observe the task process by doing the following:

   • Checking the importerTaskState.

   • Reading the messages field.

Guidelines

• The importerTaskState is initially set to not_started. After start, it moves to running.

• The importerTaskState will end to completed or error depending on the success of the import.

• It’s always possible to abort the task by invoking the stop field.

Importer specific fields

When setting the importerCode, the list of import/convert fields is refreshed automatically. Each importerCode corresponds to a specific list of parameters even though most of them are quite standard.

Each field expects a specific data type. For more information, see CVP Importer SDK documentation.

Security restrictions

The ImporterNode verifies the paths provided to an ImporterNode before starting the import/convert task.

If checkInputPathAccessibility is set to true, both input and output paths will be checked for data access restrictions. If set to false, only the destination path will be checked for access rights.

Code example

This is a code example for the ImporterNode.

<!-- load plugin and create ImporterNode -->

<plugin file="plugins\Importers\ImportersPlugin.dll" />

<ImporterNode name="importer" importerCode="RVM2MWX"/>

<!-- coroutine to start an import task-->

<Coroutine name="crt_startTask" args="from=sstring,to=sstring,code=sstring">

<set name="importer.importerCode" value="[@%code%]" />

<wait condition="[@crt_startTask.timeFromWait]&lt;0.001" />

<!-- copying paths and start task -->

<set name="importer.parameter\sourcepath" value="[@%from%]" />

<set name="importer.parameter\destinationpath" value="[@%to%]" />

<set name="importer.start" />

</Coroutine>

ImporterNode fields

These are the fields for ImporterNode node. Only the node-specific fields are indicated, not fields obtained by inheritance.

Field inheritance: NodeBase > FileExplorer