three.MF.V3.Tasks.SetGroup 

  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 SetGroup:
  7    """*
  8    Set scan group properties.
  9
 10    > Request example:
 11
 12    ```json
 13    {
 14    "Task":{
 15    "Index":1,
 16    "Type":"SetGroup",
 17    "Input":{
 18    "index":2,
 19    "name":"Amazing Scan"
 20    "color":[1,0,0,1],
 21    "rotation":[0,3.14,0],
 22    "translation":[0,10,25]
 23    }
 24    }
 25    }
 26    ```
 27
 28    > Response example:
 29
 30    ```json
 31    {
 32    "Task":{
 33    "Index":1,
 34    "Type":"SetGroup",
 35    "Input":{
 36    "index":2,
 37    "name":"Amazing Scan"
 38    "color":[1,0,0,1],
 39    "rotation":[0,3.14,0],
 40    "translation":[0,10,25]
 41    }
 42    "Output":{
 43    "groups":[
 44    {
 45    "index":1,
 46    "scan":1,
 47    "name":"Scan-1",
 48    "color":[0.75,0.5,0.2,1.0],
 49    "rotation":[0.03,0.1,-0.01],
 50    "translation":[-101,67,-561],
 51    "visible":true
 52    },
 53    {
 54    "index":2,
 55    "scan":2,
 56    "name":"Amazing Scan",
 57    "color":[1,0,0,1],
 58    "rotation":[0,3.14,0],
 59    "translation":[0,10,25],
 60    "visible":true
 61    },
 62    {
 63    "index":3,
 64    "scan":3,
 65    "name":"Scan-3",
 66    "color":[0.6,0.8,0.9,1.0],
 67    "visible":true
 68    }
 69    ]
 70    },
 71    "State":"Completed"
 72    }
 73    }
 74    ```
 75    """
 76    class Request:
 77
 78        """
 79         Client request for the `SetGroup` task.
 80        """
 81        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
 82            # A unique identifier generated by the client.
 83            self.Index = Index
 84            # "SetGroup"
 85            self.Type = Type
 86            # The requested group settings.
 87            self.Input = Input
 88
 89    class Response:
 90
 91        """
 92         Server response for the `SetGroup` task.
 93        """
 94        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):
 95            # The unique identifier generated by the client.
 96            self.Index = Index
 97            # "SetGroup"
 98            self.Type = Type
 99            # The requested group settings.
100            self.Input = Input
101            # The root scan group in the current open project.
102            self.Output = Output
103            # The current state of the task.
104            self.State = State
105            # A string describing the error if the task has failed.
106            self.Error = Error
107
108    def __init__(self):
109        pass
class SetGroup: 
  7class SetGroup:
  8    """*
  9    Set scan group properties.
 10
 11    > Request example:
 12
 13    ```json
 14    {
 15    "Task":{
 16    "Index":1,
 17    "Type":"SetGroup",
 18    "Input":{
 19    "index":2,
 20    "name":"Amazing Scan"
 21    "color":[1,0,0,1],
 22    "rotation":[0,3.14,0],
 23    "translation":[0,10,25]
 24    }
 25    }
 26    }
 27    ```
 28
 29    > Response example:
 30
 31    ```json
 32    {
 33    "Task":{
 34    "Index":1,
 35    "Type":"SetGroup",
 36    "Input":{
 37    "index":2,
 38    "name":"Amazing Scan"
 39    "color":[1,0,0,1],
 40    "rotation":[0,3.14,0],
 41    "translation":[0,10,25]
 42    }
 43    "Output":{
 44    "groups":[
 45    {
 46    "index":1,
 47    "scan":1,
 48    "name":"Scan-1",
 49    "color":[0.75,0.5,0.2,1.0],
 50    "rotation":[0.03,0.1,-0.01],
 51    "translation":[-101,67,-561],
 52    "visible":true
 53    },
 54    {
 55    "index":2,
 56    "scan":2,
 57    "name":"Amazing Scan",
 58    "color":[1,0,0,1],
 59    "rotation":[0,3.14,0],
 60    "translation":[0,10,25],
 61    "visible":true
 62    },
 63    {
 64    "index":3,
 65    "scan":3,
 66    "name":"Scan-3",
 67    "color":[0.6,0.8,0.9,1.0],
 68    "visible":true
 69    }
 70    ]
 71    },
 72    "State":"Completed"
 73    }
 74    }
 75    ```
 76    """
 77    class Request:
 78
 79        """
 80         Client request for the `SetGroup` task.
 81        """
 82        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
 83            # A unique identifier generated by the client.
 84            self.Index = Index
 85            # "SetGroup"
 86            self.Type = Type
 87            # The requested group settings.
 88            self.Input = Input
 89
 90    class Response:
 91
 92        """
 93         Server response for the `SetGroup` task.
 94        """
 95        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):
 96            # The unique identifier generated by the client.
 97            self.Index = Index
 98            # "SetGroup"
 99            self.Type = Type
100            # The requested group settings.
101            self.Input = Input
102            # The root scan group in the current open project.
103            self.Output = Output
104            # The current state of the task.
105            self.State = State
106            # A string describing the error if the task has failed.
107            self.Error = Error
108
109    def __init__(self):
110        pass

* Set scan group properties.

Request example:

{
"Task":{
"Index":1,
"Type":"SetGroup",
"Input":{
"index":2,
"name":"Amazing Scan"
"color":[1,0,0,1],
"rotation":[0,3.14,0],
"translation":[0,10,25]
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"SetGroup",
"Input":{
"index":2,
"name":"Amazing Scan"
"color":[1,0,0,1],
"rotation":[0,3.14,0],
"translation":[0,10,25]
}
"Output":{
"groups":[
{
"index":1,
"scan":1,
"name":"Scan-1",
"color":[0.75,0.5,0.2,1.0],
"rotation":[0.03,0.1,-0.01],
"translation":[-101,67,-561],
"visible":true
},
{
"index":2,
"scan":2,
"name":"Amazing Scan",
"color":[1,0,0,1],
"rotation":[0,3.14,0],
"translation":[0,10,25],
"visible":true
},
{
"index":3,
"scan":3,
"name":"Scan-3",
"color":[0.6,0.8,0.9,1.0],
"visible":true
}
]
},
"State":"Completed"
}
}
class SetGroup.Request: 
77    class Request:
78
79        """
80         Client request for the `SetGroup` task.
81        """
82        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
83            # A unique identifier generated by the client.
84            self.Index = Index
85            # "SetGroup"
86            self.Type = Type
87            # The requested group settings.
88            self.Input = Input

Client request for the SetGroup task.

SetGroup.Request(Index: int, Type: str, Input: MF.V3.Settings.Group.Group) 
82        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Group_Group):
83            # A unique identifier generated by the client.
84            self.Index = Index
85            # "SetGroup"
86            self.Type = Type
87            # The requested group settings.
88            self.Input = Input
Index
Type
Input
class SetGroup.Response: 
 90    class Response:
 91
 92        """
 93         Server response for the `SetGroup` task.
 94        """
 95        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):
 96            # The unique identifier generated by the client.
 97            self.Index = Index
 98            # "SetGroup"
 99            self.Type = Type
100            # The requested group settings.
101            self.Input = Input
102            # The root scan group in the current open project.
103            self.Output = Output
104            # The current state of the task.
105            self.State = State
106            # A string describing the error if the task has failed.
107            self.Error = Error

Server response for the SetGroup task.

SetGroup.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) 
 95        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):
 96            # The unique identifier generated by the client.
 97            self.Index = Index
 98            # "SetGroup"
 99            self.Type = Type
100            # The requested group settings.
101            self.Input = Input
102            # The root scan group in the current open project.
103            self.Output = Output
104            # The current state of the task.
105            self.State = State
106            # A string describing the error if the task has failed.
107            self.Error = Error
Index
Type
Input
Output
State
Error