three.MF.V3.Tasks.BoundingBox

 1from MF.V3.Descriptors.BoundingBox import BoundingBox as MF_V3_Descriptors_BoundingBox_BoundingBox
 2from MF.V3.Settings.BoundingBox import BoundingBox as MF_V3_Settings_BoundingBox_BoundingBox
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class BoundingBox:
 7    """*
 8    Get the bounding box of a set of scan groups.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"BoundingBox",
17    "Input":{
18    "selection":{"mode":"visible"},
19    "axisAligned":false
20    }
21    }
22    }
23    ```
24
25    > Response example:
26
27    ```json
28    {
29    "Task":{
30    "Index":1,
31    "Type":"BoundingBox",
32    "Input":{
33    "selection":{"mode":"visible"},
34    "axisAligned":false
35    },
36    "Output":{
37    "center":[11.9,-10.1,94.5],
38    "rotation":[
39    0.7, -0.7, 0.0,
40    0.7,  0.7, 0.0,
41    0.0,  0.0, 1.0],
42    "size":[442.2,253.1,447.1],
43    "transform":[
44    221, 0.0, 0.0,  11.9,
45    0.0, 126, 0.0, -10.1,
46    0.0, 0.0, 223,  94.5,
47    0.0, 0.0, 0.0,   1.0]
48    },
49    "State":"Completed"
50    }
51    }
52    ```
53    """
54    class Request:
55
56        """
57         Client request for the `BoundingBox` task.
58        """
59        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "BoundingBox"
63            self.Type = Type
64            # The bounding box settings.
65            self.Input = Input
66
67    class Response:
68
69        """
70         Server response for the `BoundingBox` task.
71        """
72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox, Output: MF_V3_Descriptors_BoundingBox_BoundingBox, State: MF_V3_Task_TaskState = None, Error: str = None):
73            # The unique identifier generated by the client.
74            self.Index = Index
75            # "BoundingBox"
76            self.Type = Type
77            # The requested bounding box settings.
78            self.Input = Input
79            # The root scan group in the current open project.
80            self.Output = Output
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    def __init__(self):
87        pass
class BoundingBox:
 7class BoundingBox:
 8    """*
 9    Get the bounding box of a set of scan groups.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"BoundingBox",
18    "Input":{
19    "selection":{"mode":"visible"},
20    "axisAligned":false
21    }
22    }
23    }
24    ```
25
26    > Response example:
27
28    ```json
29    {
30    "Task":{
31    "Index":1,
32    "Type":"BoundingBox",
33    "Input":{
34    "selection":{"mode":"visible"},
35    "axisAligned":false
36    },
37    "Output":{
38    "center":[11.9,-10.1,94.5],
39    "rotation":[
40    0.7, -0.7, 0.0,
41    0.7,  0.7, 0.0,
42    0.0,  0.0, 1.0],
43    "size":[442.2,253.1,447.1],
44    "transform":[
45    221, 0.0, 0.0,  11.9,
46    0.0, 126, 0.0, -10.1,
47    0.0, 0.0, 223,  94.5,
48    0.0, 0.0, 0.0,   1.0]
49    },
50    "State":"Completed"
51    }
52    }
53    ```
54    """
55    class Request:
56
57        """
58         Client request for the `BoundingBox` task.
59        """
60        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox):
61            # A unique identifier generated by the client.
62            self.Index = Index
63            # "BoundingBox"
64            self.Type = Type
65            # The bounding box settings.
66            self.Input = Input
67
68    class Response:
69
70        """
71         Server response for the `BoundingBox` task.
72        """
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox, Output: MF_V3_Descriptors_BoundingBox_BoundingBox, State: MF_V3_Task_TaskState = None, Error: str = None):
74            # The unique identifier generated by the client.
75            self.Index = Index
76            # "BoundingBox"
77            self.Type = Type
78            # The requested bounding box settings.
79            self.Input = Input
80            # The root scan group in the current open project.
81            self.Output = Output
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    def __init__(self):
88        pass

* Get the bounding box of a set of scan groups.

Request example:

{
"Task":{
"Index":1,
"Type":"BoundingBox",
"Input":{
"selection":{"mode":"visible"},
"axisAligned":false
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"BoundingBox",
"Input":{
"selection":{"mode":"visible"},
"axisAligned":false
},
"Output":{
"center":[11.9,-10.1,94.5],
"rotation":[
0.7, -0.7, 0.0,
0.7,  0.7, 0.0,
0.0,  0.0, 1.0],
"size":[442.2,253.1,447.1],
"transform":[
221, 0.0, 0.0,  11.9,
0.0, 126, 0.0, -10.1,
0.0, 0.0, 223,  94.5,
0.0, 0.0, 0.0,   1.0]
},
"State":"Completed"
}
}
class BoundingBox.Request:
55    class Request:
56
57        """
58         Client request for the `BoundingBox` task.
59        """
60        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox):
61            # A unique identifier generated by the client.
62            self.Index = Index
63            # "BoundingBox"
64            self.Type = Type
65            # The bounding box settings.
66            self.Input = Input

Client request for the BoundingBox task.

BoundingBox.Request(Index: int, Type: str, Input: MF.V3.Settings.BoundingBox.BoundingBox)
60        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox):
61            # A unique identifier generated by the client.
62            self.Index = Index
63            # "BoundingBox"
64            self.Type = Type
65            # The bounding box settings.
66            self.Input = Input
Index
Type
Input
class BoundingBox.Response:
68    class Response:
69
70        """
71         Server response for the `BoundingBox` task.
72        """
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox, Output: MF_V3_Descriptors_BoundingBox_BoundingBox, State: MF_V3_Task_TaskState = None, Error: str = None):
74            # The unique identifier generated by the client.
75            self.Index = Index
76            # "BoundingBox"
77            self.Type = Type
78            # The requested bounding box settings.
79            self.Input = Input
80            # The root scan group in the current open project.
81            self.Output = Output
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 BoundingBox task.

BoundingBox.Response( Index: int, Type: str, Input: MF.V3.Settings.BoundingBox.BoundingBox, Output: MF.V3.Descriptors.BoundingBox.BoundingBox, State: MF.V3.Task.TaskState = None, Error: str = None)
73        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_BoundingBox_BoundingBox, Output: MF_V3_Descriptors_BoundingBox_BoundingBox, State: MF_V3_Task_TaskState = None, Error: str = None):
74            # The unique identifier generated by the client.
75            self.Index = Index
76            # "BoundingBox"
77            self.Type = Type
78            # The requested bounding box settings.
79            self.Input = Input
80            # The root scan group in the current open project.
81            self.Output = Output
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
Output
State
Error