three.MF.V3.Tasks.ExportHeatMap 

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

* Export a mesh with vertex colors generated by the 'HeatMap' task.

Request example:

{
"Task":{
"Index":1,
"Type":"ExportHeatMap",
"Input":{"color":{"min":0.0,"max":1.0}}
}
}

Export file buffer message from server.

{
"Buffer":{
"Index":0,
"Size":8413737,
"Task":{
"Index":1,
"Type":"ExportHeatMap",
"Input":{"color":{"min":0.0,"max":1.0}}
}
}
}

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

Response from server:

{
"Task":{
"Index":1,
"Type":"ExportHeatMap",
"Input":{"color":{"min":0.0,"max":1.0}},
"State":"Completed"
}
}
class ExportHeatMap.Request: 
53    class Request:
54
55        """
56         Client request for the `ExportHeatMap` task.
57        """
58        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Export_Export):
59            # A unique identifier generated by the client.
60            self.Index = Index
61            # "ExportHeatMap"
62            self.Type = Type
63            # Export settings.
64            self.Input = Input

Client request for the ExportHeatMap task.

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

Server response for the ExportHeatMap task.

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

Server buffer message for the ExportHeatMap task.

ExportHeatMap.Buffer(Index: int, Size: int, Task: MF.V3.Task.Task) 
88        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task):
89            # The zero-based index identifying the data buffer.
90            self.Index = Index
91            # The size of the incoming data buffer in bytes.
92            self.Size = Size
93            # The requested ExportHeatMap task.
94            self.Task = Task
Index
Size
Task