File: __init__.pyi

package info (click to toggle)
python-ocp 7.8.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 64,720 kB
  • sloc: cpp: 362,337; pascal: 33; python: 23; makefile: 4
file content (254 lines) | stat: -rw-r--r-- 13,779 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
import OCP.TopAbs
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import io
__all__  = [
"TopAbs",
"TopAbs_Orientation",
"TopAbs_ShapeEnum",
"TopAbs_State",
"TopAbs_COMPOUND",
"TopAbs_COMPSOLID",
"TopAbs_EDGE",
"TopAbs_EXTERNAL",
"TopAbs_FACE",
"TopAbs_FORWARD",
"TopAbs_IN",
"TopAbs_INTERNAL",
"TopAbs_ON",
"TopAbs_OUT",
"TopAbs_REVERSED",
"TopAbs_SHAPE",
"TopAbs_SHELL",
"TopAbs_SOLID",
"TopAbs_UNKNOWN",
"TopAbs_VERTEX",
"TopAbs_WIRE"
]
class TopAbs():
    """
    This package gives resources for Topology oriented applications such as : Topological Data Structure, Topological Algorithms.
    """
    @staticmethod
    def Complement_s(Or : TopAbs_Orientation) -> TopAbs_Orientation: 
        """
        Reverses the interior/exterior status of each side of the object. So, to take the complement of an object means to reverse the interior/exterior status of its boundary, i.e. inside becomes outside. The method returns the complementary orientation, following the rules in the table below: FORWARD REVERSED REVERSED FORWARD INTERNAL EXTERNAL EXTERNAL INTERNAL
        """
    @staticmethod
    def Compose_s(Or1 : TopAbs_Orientation,Or2 : TopAbs_Orientation) -> TopAbs_Orientation: 
        """
        Compose the Orientation <Or1> and <Or2>. This composition is not symmetric (if you switch <Or1> and <Or2> the result is different). It assumes that <Or1> is the Orientation of a Shape S1 containing a Shape S2 of Orientation Or2. The result is the cumulated orientation of S2 in S1. The composition law is :
        """
    @staticmethod
    @overload
    def Print_s(theOrientation : TopAbs_Orientation,theStream : io.BytesIO) -> io.BytesIO: 
        """
        Prints the name of Shape type as a String on the Stream.

        Prints the name of the Orientation as a String on the Stream.

        Prints the name of the State <St> as a String on the Stream <S> and returns <S>.
        """
    @staticmethod
    @overload
    def Print_s(St : TopAbs_State,S : io.BytesIO) -> io.BytesIO: ...
    @staticmethod
    @overload
    def Print_s(theShapeType : TopAbs_ShapeEnum,theStream : io.BytesIO) -> io.BytesIO: ...
    @staticmethod
    def Reverse_s(Or : TopAbs_Orientation) -> TopAbs_Orientation: 
        """
        xchanges the interior/exterior status of the two sides. This is what happens when the sense of direction is reversed. The following rules apply:
        """
    @staticmethod
    @overload
    def ShapeOrientationFromString_s(theOrientationString : str,theOrientation : TopAbs_Orientation) -> bool: 
        """
        Returns the shape orientation from the given string identifier (using case-insensitive comparison).

        Determines the shape orientation from the given string identifier (using case-insensitive comparison).
        """
    @staticmethod
    @overload
    def ShapeOrientationFromString_s(theOrientationString : str) -> TopAbs_Orientation: ...
    @staticmethod
    def ShapeOrientationToString_s(theOrientation : TopAbs_Orientation) -> str: 
        """
        Returns the string name for a given shape orientation.
        """
    @staticmethod
    @overload
    def ShapeTypeFromString_s(theTypeString : str,theType : TopAbs_ShapeEnum) -> bool: 
        """
        Returns the shape type from the given string identifier (using case-insensitive comparison).

        Determines the shape type from the given string identifier (using case-insensitive comparison).
        """
    @staticmethod
    @overload
    def ShapeTypeFromString_s(theTypeString : str) -> TopAbs_ShapeEnum: ...
    @staticmethod
    def ShapeTypeToString_s(theType : TopAbs_ShapeEnum) -> str: 
        """
        Returns the string name for a given shape type.
        """
    def __init__(self) -> None: ...
    pass
class TopAbs_Orientation():
    """
    Identifies the orientation of a topological shape. Orientation can represent a relation between two entities, or it can apply to a shape in its own right. When used to describe a relation between two shapes, orientation allows you to use the underlying entity in either direction. For example on a curve which is oriented FORWARD (say from left to right) you can have both a FORWARD and a REVERSED edge. The FORWARD edge will be oriented from left to right, and the REVERSED edge from right to left. In this way, you share the underlying entity. In other words, two faces of a cube can share an edge, and can also be used to build compound shapes. For each case in which an element is used as the boundary of a geometric domain of a higher dimension, this element defines two local regions of which one is arbitrarily considered as the default region. A change in orientation implies a switch of default region. This allows you to apply changes of orientation to the shape as a whole.

    Members:

      TopAbs_FORWARD

      TopAbs_REVERSED

      TopAbs_INTERNAL

      TopAbs_EXTERNAL
    """
    def __eq__(self,other : object) -> bool: ...
    def __getstate__(self) -> int: ...
    def __hash__(self) -> int: ...
    def __index__(self) -> int: ...
    def __init__(self,value : int) -> None: ...
    def __int__(self) -> int: ...
    def __ne__(self,other : object) -> bool: ...
    def __repr__(self) -> str: ...
    def __setstate__(self,state : int) -> None: ...
    def __str__(self) -> str: ...
    @property
    def name(self) -> None:
        """
        :type: None
        """
    @property
    def value(self) -> int:
        """
        :type: int
        """
    TopAbs_EXTERNAL: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_EXTERNAL: 3>
    TopAbs_FORWARD: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_FORWARD: 0>
    TopAbs_INTERNAL: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_INTERNAL: 2>
    TopAbs_REVERSED: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_REVERSED: 1>
    __entries: dict # value = {'TopAbs_FORWARD': (<TopAbs_Orientation.TopAbs_FORWARD: 0>, None), 'TopAbs_REVERSED': (<TopAbs_Orientation.TopAbs_REVERSED: 1>, None), 'TopAbs_INTERNAL': (<TopAbs_Orientation.TopAbs_INTERNAL: 2>, None), 'TopAbs_EXTERNAL': (<TopAbs_Orientation.TopAbs_EXTERNAL: 3>, None)}
    __members__: dict # value = {'TopAbs_FORWARD': <TopAbs_Orientation.TopAbs_FORWARD: 0>, 'TopAbs_REVERSED': <TopAbs_Orientation.TopAbs_REVERSED: 1>, 'TopAbs_INTERNAL': <TopAbs_Orientation.TopAbs_INTERNAL: 2>, 'TopAbs_EXTERNAL': <TopAbs_Orientation.TopAbs_EXTERNAL: 3>}
    pass
class TopAbs_ShapeEnum():
    """
    Identifies various topological shapes. This enumeration allows you to use dynamic typing of shapes. The values are listed in order of complexity, from the most complex to the most simple i.e. COMPOUND > COMPSOLID > SOLID > .... > VERTEX > SHAPE. Any shape can contain simpler shapes in its definition. Abstract topological data structure describes a basic entity, the shape (present in this enumeration as the SHAPE value), which can be divided into the following component topologies: - COMPOUND: A group of any of the shapes below. - COMPSOLID: A set of solids connected by their faces. This expands the notions of WIRE and SHELL to solids. - SOLID: A part of 3D space bounded by shells. - SHELL: A set of faces connected by some of the edges of their wire boundaries. A shell can be open or closed. - FACE: Part of a plane (in 2D geometry) or a surface (in 3D geometry) bounded by a closed wire. Its geometry is constrained (trimmed) by contours. - WIRE: A sequence of edges connected by their vertices. It can be open or closed depending on whether the edges are linked or not. - EDGE: A single dimensional shape corresponding to a curve, and bound by a vertex at each extremity. - VERTEX: A zero-dimensional shape corresponding to a point in geometry.

    Members:

      TopAbs_COMPOUND

      TopAbs_COMPSOLID

      TopAbs_SOLID

      TopAbs_SHELL

      TopAbs_FACE

      TopAbs_WIRE

      TopAbs_EDGE

      TopAbs_VERTEX

      TopAbs_SHAPE
    """
    def __eq__(self,other : object) -> bool: ...
    def __getstate__(self) -> int: ...
    def __hash__(self) -> int: ...
    def __index__(self) -> int: ...
    def __init__(self,value : int) -> None: ...
    def __int__(self) -> int: ...
    def __ne__(self,other : object) -> bool: ...
    def __repr__(self) -> str: ...
    def __setstate__(self,state : int) -> None: ...
    def __str__(self) -> str: ...
    @property
    def name(self) -> None:
        """
        :type: None
        """
    @property
    def value(self) -> int:
        """
        :type: int
        """
    TopAbs_COMPOUND: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_COMPOUND: 0>
    TopAbs_COMPSOLID: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_COMPSOLID: 1>
    TopAbs_EDGE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_EDGE: 6>
    TopAbs_FACE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_FACE: 4>
    TopAbs_SHAPE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_SHAPE: 8>
    TopAbs_SHELL: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_SHELL: 3>
    TopAbs_SOLID: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_SOLID: 2>
    TopAbs_VERTEX: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_VERTEX: 7>
    TopAbs_WIRE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_WIRE: 5>
    __entries: dict # value = {'TopAbs_COMPOUND': (<TopAbs_ShapeEnum.TopAbs_COMPOUND: 0>, None), 'TopAbs_COMPSOLID': (<TopAbs_ShapeEnum.TopAbs_COMPSOLID: 1>, None), 'TopAbs_SOLID': (<TopAbs_ShapeEnum.TopAbs_SOLID: 2>, None), 'TopAbs_SHELL': (<TopAbs_ShapeEnum.TopAbs_SHELL: 3>, None), 'TopAbs_FACE': (<TopAbs_ShapeEnum.TopAbs_FACE: 4>, None), 'TopAbs_WIRE': (<TopAbs_ShapeEnum.TopAbs_WIRE: 5>, None), 'TopAbs_EDGE': (<TopAbs_ShapeEnum.TopAbs_EDGE: 6>, None), 'TopAbs_VERTEX': (<TopAbs_ShapeEnum.TopAbs_VERTEX: 7>, None), 'TopAbs_SHAPE': (<TopAbs_ShapeEnum.TopAbs_SHAPE: 8>, None)}
    __members__: dict # value = {'TopAbs_COMPOUND': <TopAbs_ShapeEnum.TopAbs_COMPOUND: 0>, 'TopAbs_COMPSOLID': <TopAbs_ShapeEnum.TopAbs_COMPSOLID: 1>, 'TopAbs_SOLID': <TopAbs_ShapeEnum.TopAbs_SOLID: 2>, 'TopAbs_SHELL': <TopAbs_ShapeEnum.TopAbs_SHELL: 3>, 'TopAbs_FACE': <TopAbs_ShapeEnum.TopAbs_FACE: 4>, 'TopAbs_WIRE': <TopAbs_ShapeEnum.TopAbs_WIRE: 5>, 'TopAbs_EDGE': <TopAbs_ShapeEnum.TopAbs_EDGE: 6>, 'TopAbs_VERTEX': <TopAbs_ShapeEnum.TopAbs_VERTEX: 7>, 'TopAbs_SHAPE': <TopAbs_ShapeEnum.TopAbs_SHAPE: 8>}
    pass
class TopAbs_State():
    """
    Identifies the position of a vertex or a set of vertices relative to a region of a shape. The figure shown above illustrates the states of vertices found in various parts of the edge relative to the face which it intersects.

    Members:

      TopAbs_IN

      TopAbs_OUT

      TopAbs_ON

      TopAbs_UNKNOWN
    """
    def __eq__(self,other : object) -> bool: ...
    def __getstate__(self) -> int: ...
    def __hash__(self) -> int: ...
    def __index__(self) -> int: ...
    def __init__(self,value : int) -> None: ...
    def __int__(self) -> int: ...
    def __ne__(self,other : object) -> bool: ...
    def __repr__(self) -> str: ...
    def __setstate__(self,state : int) -> None: ...
    def __str__(self) -> str: ...
    @property
    def name(self) -> None:
        """
        :type: None
        """
    @property
    def value(self) -> int:
        """
        :type: int
        """
    TopAbs_IN: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_IN: 0>
    TopAbs_ON: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_ON: 2>
    TopAbs_OUT: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_OUT: 1>
    TopAbs_UNKNOWN: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_UNKNOWN: 3>
    __entries: dict # value = {'TopAbs_IN': (<TopAbs_State.TopAbs_IN: 0>, None), 'TopAbs_OUT': (<TopAbs_State.TopAbs_OUT: 1>, None), 'TopAbs_ON': (<TopAbs_State.TopAbs_ON: 2>, None), 'TopAbs_UNKNOWN': (<TopAbs_State.TopAbs_UNKNOWN: 3>, None)}
    __members__: dict # value = {'TopAbs_IN': <TopAbs_State.TopAbs_IN: 0>, 'TopAbs_OUT': <TopAbs_State.TopAbs_OUT: 1>, 'TopAbs_ON': <TopAbs_State.TopAbs_ON: 2>, 'TopAbs_UNKNOWN': <TopAbs_State.TopAbs_UNKNOWN: 3>}
    pass
TopAbs_COMPOUND: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_COMPOUND: 0>
TopAbs_COMPSOLID: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_COMPSOLID: 1>
TopAbs_EDGE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_EDGE: 6>
TopAbs_EXTERNAL: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_EXTERNAL: 3>
TopAbs_FACE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_FACE: 4>
TopAbs_FORWARD: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_FORWARD: 0>
TopAbs_IN: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_IN: 0>
TopAbs_INTERNAL: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_INTERNAL: 2>
TopAbs_ON: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_ON: 2>
TopAbs_OUT: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_OUT: 1>
TopAbs_REVERSED: OCP.TopAbs.TopAbs_Orientation # value = <TopAbs_Orientation.TopAbs_REVERSED: 1>
TopAbs_SHAPE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_SHAPE: 8>
TopAbs_SHELL: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_SHELL: 3>
TopAbs_SOLID: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_SOLID: 2>
TopAbs_UNKNOWN: OCP.TopAbs.TopAbs_State # value = <TopAbs_State.TopAbs_UNKNOWN: 3>
TopAbs_VERTEX: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_VERTEX: 7>
TopAbs_WIRE: OCP.TopAbs.TopAbs_ShapeEnum # value = <TopAbs_ShapeEnum.TopAbs_WIRE: 5>