three.MF.V3.Tasks.ScanData

View Source

  1from MF.V3.Descriptors.ScanData import ScanData as MF_V3_Descriptors_ScanData_ScanData
  2from MF.V3.Settings.ScanData import ScanData as MF_V3_Settings_ScanData_ScanData
  3from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
  4
  5
  6class ScanData:
  7    """*
  8    Download the raw scan data for a scan in the current open project.
  9
 10    > Request example:
 11
 12    ```json
 13    {
 14    "Task":{
 15    "Index":1,
 16    "Type":"ScanData",
 17    "Input":{
 18    "index":1,
 19    "buffers":["All"]
 20    }
 21    }
 22    }
 23    ```
 24
 25    > Vertex position buffer message from server.
 26
 27    ```json
 28    {
 29    "Buffer":{
 30    "Index":0,
 31    "Size":1558188,
 32    "Descriptor":{
 33    "components":[{
 34    "type":"Position"
 35    "size":3,
 36    "offset":0,
 37    "normalized":false,
 38    }],
 39    "stride":3
 40    },
 41    "Task":{
 42    "Index":1,
 43    "Type":"ScanData",
 44    "Input":{
 45    "index":1,
 46    "buffers":["All"]
 47    }
 48    }
 49    }
 50    }
 51    ```
 52
 53    > Vertex position binary data transfer from server [1558188 bytes].
 54
 55    > Vertex normal buffer message from server.
 56
 57    ```json
 58    {
 59    "Buffer":{
 60    "Index":1,
 61    "Size":1558188,
 62    "Descriptor":{
 63    "components":[{
 64    "type":"Normal"
 65    "size":3,
 66    "offset":0,
 67    "normalized":false,
 68    }],
 69    "stride":3
 70    },
 71    "Task":{
 72    "Index":1,
 73    "Type":"ScanData",
 74    "Input":{
 75    "index":1,
 76    "buffers":["All"]
 77    }
 78    }
 79    }
 80    }
 81    ```
 82
 83    > Vertex normal binary data transfer from server [1558188 bytes].
 84
 85    > Vertex texture coordinate buffer message from server.
 86
 87    ```json
 88    {
 89    "Buffer":{
 90    "Index":2,
 91    "Size":1038792,
 92    "Descriptor":{
 93    "components":[{
 94    "type":"UV"
 95    "size":2,
 96    "offset":0,
 97    "normalized":false,
 98    }],
 99    "stride":2
100    },
101    "Task":{
102    "Index":1,
103    "Type":"ScanData",
104    "Input":{
105    "index":1,
106    "buffers":["All"]
107    }
108    }
109    }
110    }
111    ```
112
113    > Vertex texture coordinate binary data transfer from server [1038792 bytes].
114
115    > Texture image buffer message from server.
116
117    ```json
118    {
119    "Buffer":{
120    "Index":3,
121    "Size":3504494,
122    "Descriptor":{
123    "components":[{
124    "type":"Texture"
125    "size":0,
126    "offset":0,
127    "normalized":false,
128    }],
129    "stride":0
130    },
131    "Task":{
132    "Index":1,
133    "Type":"ScanData",
134    "Input":{
135    "index":1,
136    "buffers":["All"]
137    }
138    }
139    }
140    }
141    ```
142
143    > Texture binary data transfer from server [3504494 bytes].
144
145    > Triangle index buffer message from server.
146
147    ```json
148    {
149    "Buffer":{
150    "Index":4,
151    "Size":1996356,
152    "Descriptor":{
153    "components":[{
154    "type":"Triangle"
155    "size":1,
156    "offset":0,
157    "normalized":false,
158    }],
159    "stride":1
160    },
161    "Task":{
162    "Index":1,
163    "Type":"ScanData",
164    "Input":{
165    "index":1,
166    "buffers":["All"]
167    }
168    }
169    }
170    }
171    ```
172
173    > Triangle index binary data transfer from server [1996356 bytes].
174
175    > Response example:
176
177    ```json
178    {
179    "Task":{
180    "Index":1,
181    "Type":"ScanData",
182    "Input":{"buffers":["All"],"index":1},
183    "Output":{
184    "buffers":[
185    {"components":[{"normalized":false,"offset":0,"size":3,"type":"Position"}],"stride":3},
186    {"components":[{"normalized":false,"offset":0,"size":3,"type":"Normal"}],"stride":3},
187    {"components":[{"normalized":false,"offset":0,"size":2,"type":"UV"}],"stride":2},
188    {"components":[{"normalized":false,"offset":0,"size":0,"type":"Texture"}],"stride":0},
189    {"components":[{"normalized":false,"offset":0,"size":1,"type":"Triangle"}],"stride":1}
190    ],
191    "index":1,
192    "name":"Scan-1"
193    },
194    "State":"Completed"
195    }
196    }
197    ```
198    """
199    class Request:
200
201        """
202         Client request for the `ScanData` task.
203        """
204        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData):
205            # A unique identifier generated by the client.
206            self.Index = Index
207            # "ScanData"
208            self.Type = Type
209            # Requested scan data.
210            self.Input = Input
211
212    class Response:
213
214        """
215         Server response for the `ScanData` task.
216        """
217        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData, Output: MF_V3_Descriptors_ScanData_ScanData, State: MF_V3_Task_TaskState = None, Error: str = None):
218            # The unique identifier generated by the client.
219            self.Index = Index
220            # "ScanData"
221            self.Type = Type
222            # The scan data requested by the client.
223            self.Input = Input
224            # The scan data sent from the server.
225            self.Output = Output
226            # The current state of the task.
227            self.State = State
228            # A string describing the error if the task has failed.
229            self.Error = Error
230
231    class Buffer:
232
233        """
234         Server buffer message for the `ScanData` task.
235        """
236        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_ScanData_ScanData.Buffer):
237            # The zero-based index identifying the data buffer.
238            self.Index = Index
239            # The size of the incoming data buffer in bytes.
240            self.Size = Size
241            # The requested ScanData task.
242            self.Task = Task
243            # The scan data buffer descriptor.
244            self.Descriptor = Descriptor
245
246    def __init__(self):
247        pass

class ScanData: View Source

  7class ScanData:
  8    """*
  9    Download the raw scan data for a scan in the current open project.
 10
 11    > Request example:
 12
 13    ```json
 14    {
 15    "Task":{
 16    "Index":1,
 17    "Type":"ScanData",
 18    "Input":{
 19    "index":1,
 20    "buffers":["All"]
 21    }
 22    }
 23    }
 24    ```
 25
 26    > Vertex position buffer message from server.
 27
 28    ```json
 29    {
 30    "Buffer":{
 31    "Index":0,
 32    "Size":1558188,
 33    "Descriptor":{
 34    "components":[{
 35    "type":"Position"
 36    "size":3,
 37    "offset":0,
 38    "normalized":false,
 39    }],
 40    "stride":3
 41    },
 42    "Task":{
 43    "Index":1,
 44    "Type":"ScanData",
 45    "Input":{
 46    "index":1,
 47    "buffers":["All"]
 48    }
 49    }
 50    }
 51    }
 52    ```
 53
 54    > Vertex position binary data transfer from server [1558188 bytes].
 55
 56    > Vertex normal buffer message from server.
 57
 58    ```json
 59    {
 60    "Buffer":{
 61    "Index":1,
 62    "Size":1558188,
 63    "Descriptor":{
 64    "components":[{
 65    "type":"Normal"
 66    "size":3,
 67    "offset":0,
 68    "normalized":false,
 69    }],
 70    "stride":3
 71    },
 72    "Task":{
 73    "Index":1,
 74    "Type":"ScanData",
 75    "Input":{
 76    "index":1,
 77    "buffers":["All"]
 78    }
 79    }
 80    }
 81    }
 82    ```
 83
 84    > Vertex normal binary data transfer from server [1558188 bytes].
 85
 86    > Vertex texture coordinate buffer message from server.
 87
 88    ```json
 89    {
 90    "Buffer":{
 91    "Index":2,
 92    "Size":1038792,
 93    "Descriptor":{
 94    "components":[{
 95    "type":"UV"
 96    "size":2,
 97    "offset":0,
 98    "normalized":false,
 99    }],
100    "stride":2
101    },
102    "Task":{
103    "Index":1,
104    "Type":"ScanData",
105    "Input":{
106    "index":1,
107    "buffers":["All"]
108    }
109    }
110    }
111    }
112    ```
113
114    > Vertex texture coordinate binary data transfer from server [1038792 bytes].
115
116    > Texture image buffer message from server.
117
118    ```json
119    {
120    "Buffer":{
121    "Index":3,
122    "Size":3504494,
123    "Descriptor":{
124    "components":[{
125    "type":"Texture"
126    "size":0,
127    "offset":0,
128    "normalized":false,
129    }],
130    "stride":0
131    },
132    "Task":{
133    "Index":1,
134    "Type":"ScanData",
135    "Input":{
136    "index":1,
137    "buffers":["All"]
138    }
139    }
140    }
141    }
142    ```
143
144    > Texture binary data transfer from server [3504494 bytes].
145
146    > Triangle index buffer message from server.
147
148    ```json
149    {
150    "Buffer":{
151    "Index":4,
152    "Size":1996356,
153    "Descriptor":{
154    "components":[{
155    "type":"Triangle"
156    "size":1,
157    "offset":0,
158    "normalized":false,
159    }],
160    "stride":1
161    },
162    "Task":{
163    "Index":1,
164    "Type":"ScanData",
165    "Input":{
166    "index":1,
167    "buffers":["All"]
168    }
169    }
170    }
171    }
172    ```
173
174    > Triangle index binary data transfer from server [1996356 bytes].
175
176    > Response example:
177
178    ```json
179    {
180    "Task":{
181    "Index":1,
182    "Type":"ScanData",
183    "Input":{"buffers":["All"],"index":1},
184    "Output":{
185    "buffers":[
186    {"components":[{"normalized":false,"offset":0,"size":3,"type":"Position"}],"stride":3},
187    {"components":[{"normalized":false,"offset":0,"size":3,"type":"Normal"}],"stride":3},
188    {"components":[{"normalized":false,"offset":0,"size":2,"type":"UV"}],"stride":2},
189    {"components":[{"normalized":false,"offset":0,"size":0,"type":"Texture"}],"stride":0},
190    {"components":[{"normalized":false,"offset":0,"size":1,"type":"Triangle"}],"stride":1}
191    ],
192    "index":1,
193    "name":"Scan-1"
194    },
195    "State":"Completed"
196    }
197    }
198    ```
199    """
200    class Request:
201
202        """
203         Client request for the `ScanData` task.
204        """
205        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData):
206            # A unique identifier generated by the client.
207            self.Index = Index
208            # "ScanData"
209            self.Type = Type
210            # Requested scan data.
211            self.Input = Input
212
213    class Response:
214
215        """
216         Server response for the `ScanData` task.
217        """
218        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData, Output: MF_V3_Descriptors_ScanData_ScanData, State: MF_V3_Task_TaskState = None, Error: str = None):
219            # The unique identifier generated by the client.
220            self.Index = Index
221            # "ScanData"
222            self.Type = Type
223            # The scan data requested by the client.
224            self.Input = Input
225            # The scan data sent from the server.
226            self.Output = Output
227            # The current state of the task.
228            self.State = State
229            # A string describing the error if the task has failed.
230            self.Error = Error
231
232    class Buffer:
233
234        """
235         Server buffer message for the `ScanData` task.
236        """
237        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_ScanData_ScanData.Buffer):
238            # The zero-based index identifying the data buffer.
239            self.Index = Index
240            # The size of the incoming data buffer in bytes.
241            self.Size = Size
242            # The requested ScanData task.
243            self.Task = Task
244            # The scan data buffer descriptor.
245            self.Descriptor = Descriptor
246
247    def __init__(self):
248        pass

* Download the raw scan data for a scan in the current open project.

Request example:

{
"Task":{
"Index":1,
"Type":"ScanData",
"Input":{
"index":1,
"buffers":["All"]
}
}
}

Vertex position buffer message from server.

{
"Buffer":{
"Index":0,
"Size":1558188,
"Descriptor":{
"components":[{
"type":"Position"
"size":3,
"offset":0,
"normalized":false,
}],
"stride":3
},
"Task":{
"Index":1,
"Type":"ScanData",
"Input":{
"index":1,
"buffers":["All"]
}
}
}
}

Vertex position binary data transfer from server [1558188 bytes].

Vertex normal buffer message from server.

{
"Buffer":{
"Index":1,
"Size":1558188,
"Descriptor":{
"components":[{
"type":"Normal"
"size":3,
"offset":0,
"normalized":false,
}],
"stride":3
},
"Task":{
"Index":1,
"Type":"ScanData",
"Input":{
"index":1,
"buffers":["All"]
}
}
}
}

Vertex normal binary data transfer from server [1558188 bytes].

Vertex texture coordinate buffer message from server.

{
"Buffer":{
"Index":2,
"Size":1038792,
"Descriptor":{
"components":[{
"type":"UV"
"size":2,
"offset":0,
"normalized":false,
}],
"stride":2
},
"Task":{
"Index":1,
"Type":"ScanData",
"Input":{
"index":1,
"buffers":["All"]
}
}
}
}

Vertex texture coordinate binary data transfer from server [1038792 bytes].

Texture image buffer message from server.

{
"Buffer":{
"Index":3,
"Size":3504494,
"Descriptor":{
"components":[{
"type":"Texture"
"size":0,
"offset":0,
"normalized":false,
}],
"stride":0
},
"Task":{
"Index":1,
"Type":"ScanData",
"Input":{
"index":1,
"buffers":["All"]
}
}
}
}

Texture binary data transfer from server [3504494 bytes].

Triangle index buffer message from server.

{
"Buffer":{
"Index":4,
"Size":1996356,
"Descriptor":{
"components":[{
"type":"Triangle"
"size":1,
"offset":0,
"normalized":false,
}],
"stride":1
},
"Task":{
"Index":1,
"Type":"ScanData",
"Input":{
"index":1,
"buffers":["All"]
}
}
}
}

Triangle index binary data transfer from server [1996356 bytes].

Response example:

{
"Task":{
"Index":1,
"Type":"ScanData",
"Input":{"buffers":["All"],"index":1},
"Output":{
"buffers":[
{"components":[{"normalized":false,"offset":0,"size":3,"type":"Position"}],"stride":3},
{"components":[{"normalized":false,"offset":0,"size":3,"type":"Normal"}],"stride":3},
{"components":[{"normalized":false,"offset":0,"size":2,"type":"UV"}],"stride":2},
{"components":[{"normalized":false,"offset":0,"size":0,"type":"Texture"}],"stride":0},
{"components":[{"normalized":false,"offset":0,"size":1,"type":"Triangle"}],"stride":1}
],
"index":1,
"name":"Scan-1"
},
"State":"Completed"
}
}

class ScanData.Request: View Source

200    class Request:
201
202        """
203         Client request for the `ScanData` task.
204        """
205        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData):
206            # A unique identifier generated by the client.
207            self.Index = Index
208            # "ScanData"
209            self.Type = Type
210            # Requested scan data.
211            self.Input = Input

Client request for the ScanData task.

ScanData.Request(Index: int, Type: str, Input: MF.V3.Settings.ScanData.ScanData) View Source

205        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData):
206            # A unique identifier generated by the client.
207            self.Index = Index
208            # "ScanData"
209            self.Type = Type
210            # Requested scan data.
211            self.Input = Input

Index

Type

Input

class ScanData.Response: View Source

213    class Response:
214
215        """
216         Server response for the `ScanData` task.
217        """
218        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData, Output: MF_V3_Descriptors_ScanData_ScanData, State: MF_V3_Task_TaskState = None, Error: str = None):
219            # The unique identifier generated by the client.
220            self.Index = Index
221            # "ScanData"
222            self.Type = Type
223            # The scan data requested by the client.
224            self.Input = Input
225            # The scan data sent from the server.
226            self.Output = Output
227            # The current state of the task.
228            self.State = State
229            # A string describing the error if the task has failed.
230            self.Error = Error

Server response for the ScanData task.

ScanData.Response( Index: int, Type: str, Input: MF.V3.Settings.ScanData.ScanData, Output: MF.V3.Descriptors.ScanData.ScanData, State: MF.V3.Task.TaskState = None, Error: str = None) View Source

218        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_ScanData_ScanData, Output: MF_V3_Descriptors_ScanData_ScanData, State: MF_V3_Task_TaskState = None, Error: str = None):
219            # The unique identifier generated by the client.
220            self.Index = Index
221            # "ScanData"
222            self.Type = Type
223            # The scan data requested by the client.
224            self.Input = Input
225            # The scan data sent from the server.
226            self.Output = Output
227            # The current state of the task.
228            self.State = State
229            # A string describing the error if the task has failed.
230            self.Error = Error

Index

Type

Input

Output

State

Error

class ScanData.Buffer: View Source

232    class Buffer:
233
234        """
235         Server buffer message for the `ScanData` task.
236        """
237        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_ScanData_ScanData.Buffer):
238            # The zero-based index identifying the data buffer.
239            self.Index = Index
240            # The size of the incoming data buffer in bytes.
241            self.Size = Size
242            # The requested ScanData task.
243            self.Task = Task
244            # The scan data buffer descriptor.
245            self.Descriptor = Descriptor

Server buffer message for the ScanData task.

ScanData.Buffer( Index: int, Size: int, Task: MF.V3.Task.Task, Descriptor: MF.V3.Descriptors.ScanData.ScanData.Buffer) View Source

237        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_ScanData_ScanData.Buffer):
238            # The zero-based index identifying the data buffer.
239            self.Index = Index
240            # The size of the incoming data buffer in bytes.
241            self.Size = Size
242            # The requested ScanData task.
243            self.Task = Task
244            # The scan data buffer descriptor.
245            self.Descriptor = Descriptor

Index

Size

Task

Descriptor