three.MF.V3.Tasks.Export 

  1from MF.V3.Settings.Export import Export as MF_V3_Settings_Export_Export
  2from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
  3
  4
  5class Export:
  6    """*
  7    Export a group of scans.
  8
  9    > Request example:
 10
 11    ```json
 12    {
 13    "Task":{
 14    "Index":1,
 15    "Type":"Export",
 16    "Input":{
 17    "selection":{"mode":"visible"},
 18    "format":"obj",
 19    "texture":true,
 20    "merge":false
 21    }
 22    }
 23    }
 24    ```
 25
 26    > Export file buffer message from server.
 27
 28    ```json
 29    {
 30    "Buffer":{
 31    "Index":0,
 32    "Size":8413737,
 33    "Task":{
 34    "Index":1,
 35    "Type":"Export",
 36    "Input":{
 37    "selection":{"mode":"visible"},
 38    "format":"obj",
 39    "texture":true,
 40    "merge":false
 41    }
 42    }
 43    }
 44    }
 45    ```
 46
 47    > Export file binary data transfer from server [8413737 bytes].
 48
 49    > Response from server:
 50
 51    ```json
 52    {
 53    "Task":{
 54    "Index":1,
 55    "Type":"Export"
 56    "Input":{
 57    "selection":{"mode":"visible"},
 58    "format":"obj",
 59    "texture":true,
 60    "merge":false
 61    },
 62    "State":"Completed"
 63    }
 64    }
 65    ```
 66    """
 67    class Request:
 68
 69        """
 70         Client request for the `Export` task.
 71        """
 72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export):
 73            # A unique identifier generated by the client.
 74            self.Index = Index
 75            # "Export"
 76            self.Type = Type
 77            # Export settings.
 78            self.Input = Input
 79
 80    class Response:
 81
 82        """
 83         Server response for the `Export` task.
 84        """
 85        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export, State: MF_V3_Task_TaskState = None, Error: str = None):
 86            # The unique identifier generated by the client.
 87            self.Index = Index
 88            # "Export"
 89            self.Type = Type
 90            # Requested export settings.
 91            self.Input = Input
 92            # The current state of the task.
 93            self.State = State
 94            # A string describing the error if the task has failed.
 95            self.Error = Error
 96
 97    class Buffer:
 98
 99        """
100         Server buffer message for the `Export` task.
101        """
102        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
103            # The zero-based index identifying the data buffer.
104            self.Index = Index
105            # The size of the incoming data buffer in bytes.
106            self.Size = Size
107            # The requested Export task.
108            self.Task = Task
109
110    def __init__(self):
111        pass
class Export: 
  6class Export:
  7    """*
  8    Export a group of scans.
  9
 10    > Request example:
 11
 12    ```json
 13    {
 14    "Task":{
 15    "Index":1,
 16    "Type":"Export",
 17    "Input":{
 18    "selection":{"mode":"visible"},
 19    "format":"obj",
 20    "texture":true,
 21    "merge":false
 22    }
 23    }
 24    }
 25    ```
 26
 27    > Export file buffer message from server.
 28
 29    ```json
 30    {
 31    "Buffer":{
 32    "Index":0,
 33    "Size":8413737,
 34    "Task":{
 35    "Index":1,
 36    "Type":"Export",
 37    "Input":{
 38    "selection":{"mode":"visible"},
 39    "format":"obj",
 40    "texture":true,
 41    "merge":false
 42    }
 43    }
 44    }
 45    }
 46    ```
 47
 48    > Export file binary data transfer from server [8413737 bytes].
 49
 50    > Response from server:
 51
 52    ```json
 53    {
 54    "Task":{
 55    "Index":1,
 56    "Type":"Export"
 57    "Input":{
 58    "selection":{"mode":"visible"},
 59    "format":"obj",
 60    "texture":true,
 61    "merge":false
 62    },
 63    "State":"Completed"
 64    }
 65    }
 66    ```
 67    """
 68    class Request:
 69
 70        """
 71         Client request for the `Export` task.
 72        """
 73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export):
 74            # A unique identifier generated by the client.
 75            self.Index = Index
 76            # "Export"
 77            self.Type = Type
 78            # Export settings.
 79            self.Input = Input
 80
 81    class Response:
 82
 83        """
 84         Server response for the `Export` task.
 85        """
 86        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export, State: MF_V3_Task_TaskState = None, Error: str = None):
 87            # The unique identifier generated by the client.
 88            self.Index = Index
 89            # "Export"
 90            self.Type = Type
 91            # Requested export settings.
 92            self.Input = Input
 93            # The current state of the task.
 94            self.State = State
 95            # A string describing the error if the task has failed.
 96            self.Error = Error
 97
 98    class Buffer:
 99
100        """
101         Server buffer message for the `Export` task.
102        """
103        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
104            # The zero-based index identifying the data buffer.
105            self.Index = Index
106            # The size of the incoming data buffer in bytes.
107            self.Size = Size
108            # The requested Export task.
109            self.Task = Task
110
111    def __init__(self):
112        pass

* Export a group of scans.

Request example:

{
"Task":{
"Index":1,
"Type":"Export",
"Input":{
"selection":{"mode":"visible"},
"format":"obj",
"texture":true,
"merge":false
}
}
}

Export file buffer message from server.

{
"Buffer":{
"Index":0,
"Size":8413737,
"Task":{
"Index":1,
"Type":"Export",
"Input":{
"selection":{"mode":"visible"},
"format":"obj",
"texture":true,
"merge":false
}
}
}
}

Export file binary data transfer from server [8413737 bytes].

Response from server:

{
"Task":{
"Index":1,
"Type":"Export"
"Input":{
"selection":{"mode":"visible"},
"format":"obj",
"texture":true,
"merge":false
},
"State":"Completed"
}
}
class Export.Request: 
68    class Request:
69
70        """
71         Client request for the `Export` task.
72        """
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export):
74            # A unique identifier generated by the client.
75            self.Index = Index
76            # "Export"
77            self.Type = Type
78            # Export settings.
79            self.Input = Input

Client request for the Export task.

Export.Request(Index: int, Type: str, Input: MF.V3.Settings.Export.Export) 
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export):
74            # A unique identifier generated by the client.
75            self.Index = Index
76            # "Export"
77            self.Type = Type
78            # Export settings.
79            self.Input = Input
Index
Type
Input
class Export.Response: 
81    class Response:
82
83        """
84         Server response for the `Export` task.
85        """
86        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export, State: MF_V3_Task_TaskState = None, Error: str = None):
87            # The unique identifier generated by the client.
88            self.Index = Index
89            # "Export"
90            self.Type = Type
91            # Requested export settings.
92            self.Input = Input
93            # The current state of the task.
94            self.State = State
95            # A string describing the error if the task has failed.
96            self.Error = Error

Server response for the Export task.

Export.Response( Index: int, Type: str, Input: MF.V3.Settings.Export.Export, State: MF.V3.Task.TaskState = None, Error: str = None) 
86        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export, State: MF_V3_Task_TaskState = None, Error: str = None):
87            # The unique identifier generated by the client.
88            self.Index = Index
89            # "Export"
90            self.Type = Type
91            # Requested export settings.
92            self.Input = Input
93            # The current state of the task.
94            self.State = State
95            # A string describing the error if the task has failed.
96            self.Error = Error
Index
Type
Input
State
Error
class Export.Buffer: 
 98    class Buffer:
 99
100        """
101         Server buffer message for the `Export` task.
102        """
103        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
104            # The zero-based index identifying the data buffer.
105            self.Index = Index
106            # The size of the incoming data buffer in bytes.
107            self.Size = Size
108            # The requested Export task.
109            self.Task = Task

Server buffer message for the Export task.

Export.Buffer(Index: int, Size: int, Task: MF.V3.Task.Task) 
103        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
104            # The zero-based index identifying the data buffer.
105            self.Index = Index
106            # The size of the incoming data buffer in bytes.
107            self.Size = Size
108            # The requested Export task.
109            self.Task = Task
Index
Size
Task