three.MF.V3.Tasks.TransformGroup

View Source

 1from MF.V3.Descriptors.Project import Project as MF_V3_Descriptors_Project_Project
 2from MF.V3.Settings.Group import Group as MF_V3_Settings_Group_Group
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class TransformGroup:
 7    """*
 8    Apply a rigid transformation to a group.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"TransformGroup",
17    "Input":{
18    "index":1,
19    "rotation":[0.5, 1.0, 1.5],
20    "translation":[10, 20, 30]
21    }
22    }
23    }
24    ```
25
26    > Response example:
27
28    ```json
29    {
30    "Task":{
31    "Index":1,
32    "Type":"TransformGroup",
33    "Input":{
34    "index":1,
35    "rotation":[0.5, 1.0, 1.5],
36    "translation":[10, 20, 30]
37    },
38    "Output":{
39    "groups":[
40    {
41    "index":1,
42    "name":"Group 1",
43    "rotation":[0.5, 1.0, 1.5],
44    "translation":[10, 20, 30]
45    }
46    ]
47    },
48    "State":"Completed"
49    }
50    }
51    ```
52    """
53    class Request:
54
55        """
56         Client request for the `TransformGroup` task.
57        """
58        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
59            # A unique identifier generated by the client.
60            self.Index = Index
61            # "TransformGroup"
62            self.Type = Type
63            # The group settings containing the requested rotation and translation.
64            self.Input = Input
65
66    class Response:
67
68        """
69         Server response for the `TransformGroup` task.
70        """
71        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
72            # The unique identifier generated by the client.
73            self.Index = Index
74            # "TransformGroup"
75            self.Type = Type
76            # The group settings containing the requested rotation and translation.
77            self.Input = Input
78            # The root scan group in the current open project.
79            self.Output = Output
80            # The current state of the task.
81            self.State = State
82            # A string describing the error if the task has failed.
83            self.Error = Error
84
85    def __init__(self):
86        pass

class TransformGroup: View Source

 7class TransformGroup:
 8    """*
 9    Apply a rigid transformation to a group.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"TransformGroup",
18    "Input":{
19    "index":1,
20    "rotation":[0.5, 1.0, 1.5],
21    "translation":[10, 20, 30]
22    }
23    }
24    }
25    ```
26
27    > Response example:
28
29    ```json
30    {
31    "Task":{
32    "Index":1,
33    "Type":"TransformGroup",
34    "Input":{
35    "index":1,
36    "rotation":[0.5, 1.0, 1.5],
37    "translation":[10, 20, 30]
38    },
39    "Output":{
40    "groups":[
41    {
42    "index":1,
43    "name":"Group 1",
44    "rotation":[0.5, 1.0, 1.5],
45    "translation":[10, 20, 30]
46    }
47    ]
48    },
49    "State":"Completed"
50    }
51    }
52    ```
53    """
54    class Request:
55
56        """
57         Client request for the `TransformGroup` task.
58        """
59        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "TransformGroup"
63            self.Type = Type
64            # The group settings containing the requested rotation and translation.
65            self.Input = Input
66
67    class Response:
68
69        """
70         Server response for the `TransformGroup` task.
71        """
72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
73            # The unique identifier generated by the client.
74            self.Index = Index
75            # "TransformGroup"
76            self.Type = Type
77            # The group settings containing the requested rotation and translation.
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

* Apply a rigid transformation to a group.

Request example:

{
"Task":{
"Index":1,
"Type":"TransformGroup",
"Input":{
"index":1,
"rotation":[0.5, 1.0, 1.5],
"translation":[10, 20, 30]
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"TransformGroup",
"Input":{
"index":1,
"rotation":[0.5, 1.0, 1.5],
"translation":[10, 20, 30]
},
"Output":{
"groups":[
{
"index":1,
"name":"Group 1",
"rotation":[0.5, 1.0, 1.5],
"translation":[10, 20, 30]
}
]
},
"State":"Completed"
}
}

class TransformGroup.Request: View Source

54    class Request:
55
56        """
57         Client request for the `TransformGroup` task.
58        """
59        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "TransformGroup"
63            self.Type = Type
64            # The group settings containing the requested rotation and translation.
65            self.Input = Input

Client request for the TransformGroup task.

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

59        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
60            # A unique identifier generated by the client.
61            self.Index = Index
62            # "TransformGroup"
63            self.Type = Type
64            # The group settings containing the requested rotation and translation.
65            self.Input = Input

Index

Type

Input

class TransformGroup.Response: View Source

67    class Response:
68
69        """
70         Server response for the `TransformGroup` task.
71        """
72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
73            # The unique identifier generated by the client.
74            self.Index = Index
75            # "TransformGroup"
76            self.Type = Type
77            # The group settings containing the requested rotation and translation.
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

Server response for the TransformGroup task.

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

72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group, Output: MF_V3_Descriptors_Project_Project.Group, State: MF_V3_Task_TaskState = None, Error: str = None):
73            # The unique identifier generated by the client.
74            self.Index = Index
75            # "TransformGroup"
76            self.Type = Type
77            # The group settings containing the requested rotation and translation.
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

Index

Type

Input

Output

State

Error