three.MF.V3.Tasks.ListExportFormats

 1from MF.V3.Descriptors.Export import Export as MF_V3_Descriptors_Export_Export
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3from typing import List
 4
 5
 6class ListExportFormats:
 7    """*
 8    List all export formats and the geometry elements they support.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"ListExportFormats"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"ListExportFormats",
28    "Output":{[
29    {
30    "format": "ply",
31    "colors": true,
32    "description": "Polygon format",
33    "extension": ".ply",
34    "faces": ["Point","Triangle","Quad"],
35    "normals": true,
36    "textures": "Single"
37    },
38    {
39    "format": "obj",
40    "colors": true,
41    "description": "Wavefront format",
42    "extension": ".obj",
43    "faces": ["Point","Triangle","Quad"],
44    "normals": true,
45    "textures": "Multiple"
46    },
47    {
48    "format": "stl",
49    "colors": false,
50    "description": "Stereolithography format",
51    "extension": ".stl",
52    "faces": ["Point","Triangle"],
53    "normals": true,
54    "textures": "None"
55    }
56    ]},
57    "State":"Completed"
58    }
59    }
60    ```
61    """
62    class Request:
63
64        """
65         Client request for the `ListExportFormats` task.
66        """
67        def __init__(self, Index: int, Type: str):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "ListExportFormats"
71            self.Type = Type
72
73    class Response:
74
75        """
76         Server response for the `ListExportFormats` task.
77        """
78        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Export_Export] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
79            # The unique identifier generated by the client.
80            self.Index = Index
81            # "ListExportFormats"
82            self.Type = Type
83            # The list of export format descriptors.
84            self.Output = Output
85            # The current state of the task.
86            self.State = State
87            # A string describing the error if the task has failed.
88            self.Error = Error
89
90    def __init__(self):
91        pass
class ListExportFormats:
 7class ListExportFormats:
 8    """*
 9    List all export formats and the geometry elements they support.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"ListExportFormats"
18    }
19    }
20    ```
21
22    > Response example:
23
24    ```json
25    {
26    "Task":{
27    "Index":1,
28    "Type":"ListExportFormats",
29    "Output":{[
30    {
31    "format": "ply",
32    "colors": true,
33    "description": "Polygon format",
34    "extension": ".ply",
35    "faces": ["Point","Triangle","Quad"],
36    "normals": true,
37    "textures": "Single"
38    },
39    {
40    "format": "obj",
41    "colors": true,
42    "description": "Wavefront format",
43    "extension": ".obj",
44    "faces": ["Point","Triangle","Quad"],
45    "normals": true,
46    "textures": "Multiple"
47    },
48    {
49    "format": "stl",
50    "colors": false,
51    "description": "Stereolithography format",
52    "extension": ".stl",
53    "faces": ["Point","Triangle"],
54    "normals": true,
55    "textures": "None"
56    }
57    ]},
58    "State":"Completed"
59    }
60    }
61    ```
62    """
63    class Request:
64
65        """
66         Client request for the `ListExportFormats` task.
67        """
68        def __init__(self, Index: int, Type: str):
69            # A unique identifier generated by the client.
70            self.Index = Index
71            # "ListExportFormats"
72            self.Type = Type
73
74    class Response:
75
76        """
77         Server response for the `ListExportFormats` task.
78        """
79        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Export_Export] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
80            # The unique identifier generated by the client.
81            self.Index = Index
82            # "ListExportFormats"
83            self.Type = Type
84            # The list of export format descriptors.
85            self.Output = Output
86            # The current state of the task.
87            self.State = State
88            # A string describing the error if the task has failed.
89            self.Error = Error
90
91    def __init__(self):
92        pass

* List all export formats and the geometry elements they support.

Request example:

{
"Task":{
"Index":1,
"Type":"ListExportFormats"
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"ListExportFormats",
"Output":{[
{
"format": "ply",
"colors": true,
"description": "Polygon format",
"extension": ".ply",
"faces": ["Point","Triangle","Quad"],
"normals": true,
"textures": "Single"
},
{
"format": "obj",
"colors": true,
"description": "Wavefront format",
"extension": ".obj",
"faces": ["Point","Triangle","Quad"],
"normals": true,
"textures": "Multiple"
},
{
"format": "stl",
"colors": false,
"description": "Stereolithography format",
"extension": ".stl",
"faces": ["Point","Triangle"],
"normals": true,
"textures": "None"
}
]},
"State":"Completed"
}
}
class ListExportFormats.Request:
63    class Request:
64
65        """
66         Client request for the `ListExportFormats` task.
67        """
68        def __init__(self, Index: int, Type: str):
69            # A unique identifier generated by the client.
70            self.Index = Index
71            # "ListExportFormats"
72            self.Type = Type

Client request for the ListExportFormats task.

ListExportFormats.Request(Index: int, Type: str)
68        def __init__(self, Index: int, Type: str):
69            # A unique identifier generated by the client.
70            self.Index = Index
71            # "ListExportFormats"
72            self.Type = Type
Index
Type
class ListExportFormats.Response:
74    class Response:
75
76        """
77         Server response for the `ListExportFormats` task.
78        """
79        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Export_Export] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
80            # The unique identifier generated by the client.
81            self.Index = Index
82            # "ListExportFormats"
83            self.Type = Type
84            # The list of export format descriptors.
85            self.Output = Output
86            # The current state of the task.
87            self.State = State
88            # A string describing the error if the task has failed.
89            self.Error = Error

Server response for the ListExportFormats task.

ListExportFormats.Response( Index: int, Type: str, Output: List[MF.V3.Descriptors.Export.Export] = None, State: MF.V3.Task.TaskState = None, Error: str = None)
79        def __init__(self, Index: int, Type: str, Output: List[MF_V3_Descriptors_Export_Export] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
80            # The unique identifier generated by the client.
81            self.Index = Index
82            # "ListExportFormats"
83            self.Type = Type
84            # The list of export format descriptors.
85            self.Output = Output
86            # The current state of the task.
87            self.State = State
88            # A string describing the error if the task has failed.
89            self.Error = Error
Index
Type
Output
State
Error