three.MF.V3.Tasks.ExportMerge 

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

* Export a merged scan.

Request example:

{
"Task":{
"Index":1,
"Type":"ExportMerge",
"Input":{
"format":"obj",
"texture":true
}
}
}

Export file buffer message from server.

{
"Buffer":{
"Index":0,
"Size":8413737,
"Task":{
"Index":1,
"Type":"ExportMerge",
"Input":{
"format":"obj",
"texture":true
}
}
}
}

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

Response example:

{
"Task":{
"Index":1,
"Type":"ExportMerge"
"Input":{
"format":"obj",
"texture":true
},
"State":"Completed"
}
}
class ExportMerge.Request: 
62    class Request:
63
64        """
65         Client request for the `ExportMerge` task.
66        """
67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "ExportMerge"
71            self.Type = Type
72            # Export settings.
73            self.Input = Input

Client request for the ExportMerge task.

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

Server response for the ExportMerge task.

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

Server buffer message for the ExportMerge task.

ExportMerge.Buffer(Index: int, Size: int, Task: MF.V3.Task.Task) 
 97        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
 98            # The zero-based index identifying the data buffer.
 99            self.Index = Index
100            # The size of the incoming data buffer in bytes.
101            self.Size = Size
102            # The requested ExportMerge task.
103            self.Task = Task
Index
Size
Task