Interface IImporter
Interface to implement when adding an importer
Namespace: UnityEditor.Industrial.Configuring.UI
Syntax
public interface IImporterMethods
ImportAllPaths(IEnumerable<String>)
Called when checking if the importer supports given file path
Import all paths is useful when a product is separated in many files. Otherwise it is preferable to simply override ImportPath.
Declaration
Task<(bool, IEnumerable<Product>)> ImportAllPaths(IEnumerable<string> paths)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<String> | paths | The paths. |
Returns
| Type | Description |
|---|---|
| Task<ValueTuple<Boolean, IEnumerable<Product>>> | Task<System.ValueTuple<System.Boolean, IEnumerable<Product>>>. |
ImportObject(Object, Product)
Imports the object.
Declaration
Task<(bool, IEnumerable<Product>)> ImportObject(Object obj, Product productSource = null)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The object. |
| Product | productSource | The product source. |
Returns
| Type | Description |
|---|---|
| Task<ValueTuple<Boolean, IEnumerable<Product>>> | Task<System.ValueTuple<System.Boolean, IEnumerable<Product>>>. |
ImportPath(String)
Called when checking if the importer supports given file path
Declaration
Task<(bool, IEnumerable<Product>)> ImportPath(string path)Parameters
| Type | Name | Description |
|---|---|---|
| String | path | The path. |
Returns
| Type | Description |
|---|---|
| Task<ValueTuple<Boolean, IEnumerable<Product>>> | Task<System.ValueTuple<System.Boolean, IEnumerable<Product>>>. |
OnPostProductImport(Configurator)
This API allows you to do some action after a product has been imported to a configurator
Declaration
void OnPostProductImport(Configurator configurator)Parameters
| Type | Name | Description |
|---|---|---|
| Configurator | configurator | The configurator. |
SaveObjectNonPersistentDependencies(Object, Product)
Saves the object non persistent dependencies.
Declaration
Task<(bool, Object)> SaveObjectNonPersistentDependencies(Object obj, Product productSource = null)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The object. |
| Product | productSource | The product source. |
Returns
| Type | Description |
|---|---|
| Task<ValueTuple<Boolean, Object>> | Task<System.ValueTuple<System.Boolean, UnityEngine.Object>>. |