three.MF.V3.Tasks.Import

  1from MF.V3.Settings.Import import Import as MF_V3_Settings_Import_Import
  2from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
  3
  4
  5class Import:
  6    """*
  7    Import a set of 3D meshes to the current open project.  The meshes must be archived in a ZIP file.  Supported formats are DAE, FBX, GLB, OBJ, PLY and STL.
  8
  9    > Request example:
 10
 11    ```json
 12    {
 13    "Task":{
 14    "Index":1,
 15    "Type":"Import",
 16    "Input":{"unit":"Inch"}
 17    }
 18    }
 19    ```
 20
 21    > Buffer message from client.
 22
 23    ```json
 24    {
 25    "Buffer":{
 26    "Index":0,
 27    "Size":1052,
 28    "Task":{
 29    "Index":1,
 30    "Type":"Import",
 31    "Input":{"unit":"Inch"}
 32    }
 33    }
 34    }
 35    ```
 36
 37    > Binary data transfer from client: The mesh zip file [1052 bytes].
 38    > Response example:
 39
 40    ```json
 41    {
 42    "Task":{
 43    "Index":1,
 44    "Type":"Import",
 45    "Input":{"unit":"Inch"},
 46    "Output":{
 47    "groups":[{"index":1,"name":"box","scan":1}],
 48    "imported":[{"file":"mesh.ply"}],
 49    "ignored":[],
 50    },
 51    "State":"Completed"
 52    }
 53    }
 54    ```
 55    """
 56    class Request:
 57
 58        """
 59         Client request for the `Import` task.
 60        """
 61        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None):
 62            # A unique identifier generated by the client.
 63            self.Index = Index
 64            # "Import"
 65            self.Type = Type
 66            # Import settings.
 67            self.Input = Input
 68
 69    class Response:
 70
 71        """
 72         Server response for the `Import` task.
 73        """
 74        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 75            # The unique identifier generated by the client.
 76            self.Index = Index
 77            # "Import"
 78            self.Type = Type
 79            # Requested export settings.
 80            self.Input = Input
 81            # The current state of the task.
 82            self.State = State
 83            # A string describing the error if the task has failed.
 84            self.Error = Error
 85
 86    class Buffer:
 87
 88        """
 89         Client buffer message for the `Import` task.
 90        """
 91        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
 92            # The zero-based index identifying the data buffer.
 93            self.Index = Index
 94            # The size of the incoming data buffer in bytes.
 95            self.Size = Size
 96            # The requested Import task.
 97            self.Task = Task
 98
 99    def __init__(self):
100        pass
class Import:
  6class Import:
  7    """*
  8    Import a set of 3D meshes to the current open project.  The meshes must be archived in a ZIP file.  Supported formats are DAE, FBX, GLB, OBJ, PLY and STL.
  9
 10    > Request example:
 11
 12    ```json
 13    {
 14    "Task":{
 15    "Index":1,
 16    "Type":"Import",
 17    "Input":{"unit":"Inch"}
 18    }
 19    }
 20    ```
 21
 22    > Buffer message from client.
 23
 24    ```json
 25    {
 26    "Buffer":{
 27    "Index":0,
 28    "Size":1052,
 29    "Task":{
 30    "Index":1,
 31    "Type":"Import",
 32    "Input":{"unit":"Inch"}
 33    }
 34    }
 35    }
 36    ```
 37
 38    > Binary data transfer from client: The mesh zip file [1052 bytes].
 39    > Response example:
 40
 41    ```json
 42    {
 43    "Task":{
 44    "Index":1,
 45    "Type":"Import",
 46    "Input":{"unit":"Inch"},
 47    "Output":{
 48    "groups":[{"index":1,"name":"box","scan":1}],
 49    "imported":[{"file":"mesh.ply"}],
 50    "ignored":[],
 51    },
 52    "State":"Completed"
 53    }
 54    }
 55    ```
 56    """
 57    class Request:
 58
 59        """
 60         Client request for the `Import` task.
 61        """
 62        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None):
 63            # A unique identifier generated by the client.
 64            self.Index = Index
 65            # "Import"
 66            self.Type = Type
 67            # Import settings.
 68            self.Input = Input
 69
 70    class Response:
 71
 72        """
 73         Server response for the `Import` task.
 74        """
 75        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 76            # The unique identifier generated by the client.
 77            self.Index = Index
 78            # "Import"
 79            self.Type = Type
 80            # Requested export settings.
 81            self.Input = Input
 82            # The current state of the task.
 83            self.State = State
 84            # A string describing the error if the task has failed.
 85            self.Error = Error
 86
 87    class Buffer:
 88
 89        """
 90         Client buffer message for the `Import` task.
 91        """
 92        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
 93            # The zero-based index identifying the data buffer.
 94            self.Index = Index
 95            # The size of the incoming data buffer in bytes.
 96            self.Size = Size
 97            # The requested Import task.
 98            self.Task = Task
 99
100    def __init__(self):
101        pass

* Import a set of 3D meshes to the current open project. The meshes must be archived in a ZIP file. Supported formats are DAE, FBX, GLB, OBJ, PLY and STL.

Request example:

{
"Task":{
"Index":1,
"Type":"Import",
"Input":{"unit":"Inch"}
}
}

Buffer message from client.

{
"Buffer":{
"Index":0,
"Size":1052,
"Task":{
"Index":1,
"Type":"Import",
"Input":{"unit":"Inch"}
}
}
}

Binary data transfer from client: The mesh zip file [1052 bytes]. Response example:

{
"Task":{
"Index":1,
"Type":"Import",
"Input":{"unit":"Inch"},
"Output":{
"groups":[{"index":1,"name":"box","scan":1}],
"imported":[{"file":"mesh.ply"}],
"ignored":[],
},
"State":"Completed"
}
}
class Import.Request:
57    class Request:
58
59        """
60         Client request for the `Import` task.
61        """
62        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None):
63            # A unique identifier generated by the client.
64            self.Index = Index
65            # "Import"
66            self.Type = Type
67            # Import settings.
68            self.Input = Input

Client request for the Import task.

Import.Request(Index: int, Type: str, Input: MF.V3.Settings.Import.Import = None)
62        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None):
63            # A unique identifier generated by the client.
64            self.Index = Index
65            # "Import"
66            self.Type = Type
67            # Import settings.
68            self.Input = Input
Index
Type
Input
class Import.Response:
70    class Response:
71
72        """
73         Server response for the `Import` task.
74        """
75        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None, State: MF_V3_Task_TaskState = None, Error: str = None):
76            # The unique identifier generated by the client.
77            self.Index = Index
78            # "Import"
79            self.Type = Type
80            # Requested export settings.
81            self.Input = Input
82            # The current state of the task.
83            self.State = State
84            # A string describing the error if the task has failed.
85            self.Error = Error

Server response for the Import task.

Import.Response( Index: int, Type: str, Input: MF.V3.Settings.Import.Import = None, State: MF.V3.Task.TaskState = None, Error: str = None)
75        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Import_Import = None, State: MF_V3_Task_TaskState = None, Error: str = None):
76            # The unique identifier generated by the client.
77            self.Index = Index
78            # "Import"
79            self.Type = Type
80            # Requested export settings.
81            self.Input = Input
82            # The current state of the task.
83            self.State = State
84            # A string describing the error if the task has failed.
85            self.Error = Error
Index
Type
Input
State
Error
class Import.Buffer:
87    class Buffer:
88
89        """
90         Client buffer message for the `Import` task.
91        """
92        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
93            # The zero-based index identifying the data buffer.
94            self.Index = Index
95            # The size of the incoming data buffer in bytes.
96            self.Size = Size
97            # The requested Import task.
98            self.Task = Task

Client buffer message for the Import task.

Import.Buffer(Index: int, Size: int, Task: MF.V3.Task.Task)
92        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
93            # The zero-based index identifying the data buffer.
94            self.Index = Index
95            # The size of the incoming data buffer in bytes.
96            self.Size = Size
97            # The requested Import task.
98            self.Task = Task
Index
Size
Task