fake-bpy-module 20240210__py3-none-any.whl → 20240326__py3-none-any.whl

freestyle/chainingiterators/__init__.pyi

@@ -1,64 +1,109 @@
-import sys
 import typing
 import freestyle.types
 
 GenericType = typing.TypeVar("GenericType")
 
 class ChainPredicateIterator:
-    """Class hierarchy: `freestyle.types.Iterator` > `freestyle.types.ViewEdgeIterator` > `freestyle.types.ChainingIterator` > `ChainPredicateIterator` A "generic" user-controlled ViewEdge iterator. This iterator is in particular built from a unary predicate and a binary predicate. First, the unary predicate is evaluated for all potential next ViewEdges in order to only keep the ones respecting a certain constraint. Then, the binary predicate is evaluated on the current ViewEdge together with each ViewEdge of the previous selection. The first ViewEdge respecting both the unary predicate and the binary predicate is kept as the next one. If none of the potential next ViewEdge respects these two predicates, None is returned."""
+    """Class hierarchy: `freestyle.types.Iterator` >
+    `freestyle.types.ViewEdgeIterator` >
+    `freestyle.types.ChainingIterator` >
+    `ChainPredicateIterator`A "generic" user-controlled ViewEdge iterator. This iterator is in
+    particular built from a unary predicate and a binary predicate.
+    First, the unary predicate is evaluated for all potential next
+    ViewEdges in order to only keep the ones respecting a certain
+    constraint. Then, the binary predicate is evaluated on the current
+    ViewEdge together with each ViewEdge of the previous selection. The
+    first ViewEdge respecting both the unary predicate and the binary
+    predicate is kept as the next one. If none of the potential next
+    ViewEdge respects these two predicates, None is returned.
+    """
 
     def __init__(
         self,
-        upred: "freestyle.types.UnaryPredicate1D",
-        bpred: "freestyle.types.BinaryPredicate1D",
+        upred: freestyle.types.UnaryPredicate1D,
+        bpred: freestyle.types.BinaryPredicate1D,
         restrict_to_selection: bool = True,
         restrict_to_unvisited: bool = True,
-        begin: typing.Optional["freestyle.types.ViewEdge"] = None,
+        begin=None,
         orientation: bool = True,
     ):
-        """__init__(brother) Builds a ChainPredicateIterator from a unary predicate, a binary predicate, a starting ViewEdge and its orientation or using the copy constructor.
+        """Builds a ChainPredicateIterator from a unary predicate, a binary
+        predicate, a starting ViewEdge and its orientation or using the copy constructor.
+
+                :param upred: The unary predicate that the next ViewEdge must satisfy.
+                :type upred: freestyle.types.UnaryPredicate1D
+                :param bpred: The binary predicate that the next ViewEdge must
+        satisfy together with the actual pointed ViewEdge.
+                :type bpred: freestyle.types.BinaryPredicate1D
+                :param restrict_to_selection: Indicates whether to force the chaining
+        to stay within the set of selected ViewEdges or not.
+                :type restrict_to_selection: bool
+                :param restrict_to_unvisited: Indicates whether a ViewEdge that has
+        already been chained must be ignored ot not.
+                :type restrict_to_unvisited: bool
+                :param begin: The ViewEdge from where to start the iteration.
+                :param orientation: If true, we'll look for the next ViewEdge among
+        the ViewEdges that surround the ending ViewVertex of begin. If
+        false, we'll search over the ViewEdges surrounding the ending
+        ViewVertex of begin.
+                :type orientation: bool
+        """
+        ...
+
+    def __init__(self, brother: ChainPredicateIterator):
+        """Builds a ChainPredicateIterator from a unary predicate, a binary
+        predicate, a starting ViewEdge and its orientation or using the copy constructor.
 
-        :param upred: The unary predicate that the next ViewEdge must satisfy.
-        :type upred: 'freestyle.types.UnaryPredicate1D'
-        :param bpred: The binary predicate that the next ViewEdge must satisfy together with the actual pointed ViewEdge.
-        :type bpred: 'freestyle.types.BinaryPredicate1D'
-        :param restrict_to_selection: Indicates whether to force the chaining to stay within the set of selected ViewEdges or not.
-        :type restrict_to_selection: bool
-        :param restrict_to_unvisited: Indicates whether a ViewEdge that has already been chained must be ignored ot not.
-        :type restrict_to_unvisited: bool
-        :param begin: The ViewEdge from where to start the iteration.
-        :type begin: typing.Optional['freestyle.types.ViewEdge']
-        :param orientation: If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin. If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin.
-        :type orientation: bool
-        :param brother: A ChainPredicateIterator object.
-        :type brother: 'ChainPredicateIterator'
+                :param brother: A ChainPredicateIterator object.
+                :type brother: ChainPredicateIterator
         """
         ...
 
 class ChainSilhouetteIterator:
-    """Class hierarchy: `freestyle.types.Iterator` > `freestyle.types.ViewEdgeIterator` > `freestyle.types.ChainingIterator` > `ChainSilhouetteIterator` A ViewEdge Iterator used to follow ViewEdges the most naturally. For example, it will follow visible ViewEdges of same nature. As soon, as the nature or the visibility changes, the iteration stops (by setting the pointed ViewEdge to 0). In the case of an iteration over a set of ViewEdge that are both Silhouette and Crease, there will be a precedence of the silhouette over the crease criterion."""
+    """Class hierarchy: `freestyle.types.Iterator` >
+    `freestyle.types.ViewEdgeIterator` >
+    `freestyle.types.ChainingIterator` >
+    `ChainSilhouetteIterator`A ViewEdge Iterator used to follow ViewEdges the most naturally. For
+    example, it will follow visible ViewEdges of same nature. As soon, as
+    the nature or the visibility changes, the iteration stops (by setting
+    the pointed ViewEdge to 0). In the case of an iteration over a set of
+    ViewEdge that are both Silhouette and Crease, there will be a
+    precedence of the silhouette over the crease criterion.
+    """
 
     def __init__(
-        self,
-        restrict_to_selection: bool = True,
-        begin: typing.Optional["freestyle.types.ViewEdge"] = None,
-        orientation: bool = True,
+        self, restrict_to_selection: bool = True, begin=None, orientation: bool = True
     ):
-        """__init__(brother) Builds a ChainSilhouetteIterator from the first ViewEdge used for iteration and its orientation or the copy constructor.
+        """Builds a ChainSilhouetteIterator from the first ViewEdge used for
+        iteration and its orientation or the copy constructor.
+
+                :param restrict_to_selection: Indicates whether to force the chaining
+        to stay within the set of selected ViewEdges or not.
+                :type restrict_to_selection: bool
+                :param begin: The ViewEdge from where to start the iteration.
+                :param orientation: If true, we'll look for the next ViewEdge among
+        the ViewEdges that surround the ending ViewVertex of begin. If
+        false, we'll search over the ViewEdges surrounding the ending
+        ViewVertex of begin.
+                :type orientation: bool
+        """
+        ...
 
-        :param restrict_to_selection: Indicates whether to force the chaining to stay within the set of selected ViewEdges or not.
-        :type restrict_to_selection: bool
-        :param begin: The ViewEdge from where to start the iteration.
-        :type begin: typing.Optional['freestyle.types.ViewEdge']
-        :param orientation: If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin. If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin.
-        :type orientation: bool
-        :param brother: A ChainSilhouetteIterator object.
-        :type brother: 'ChainSilhouetteIterator'
+    def __init__(self, brother: ChainSilhouetteIterator):
+        """Builds a ChainSilhouetteIterator from the first ViewEdge used for
+        iteration and its orientation or the copy constructor.
+
+                :param brother: A ChainSilhouetteIterator object.
+                :type brother: ChainSilhouetteIterator
         """
         ...
 
 class pyChainSilhouetteGenericIterator:
-    """Natural chaining iterator that follows the edges of the same nature following the topology of objects, with decreasing priority for silhouettes, then borders, then suggestive contours, then all other edge types."""
+    """Natural chaining iterator that follows the edges of the same nature
+    following the topology of objects, with decreasing priority for
+    silhouettes, then borders, then suggestive contours, then all other
+    edge types.
+    """
 
     def __init__(self, stayInSelection: bool = True, stayInUnvisited: bool = True):
         """Builds a pyChainSilhouetteGenericIterator object.
@@ -70,37 +115,83 @@ class pyChainSilhouetteGenericIterator:
         """
         ...
 
-    def init(self): ...
-    def traverse(self, iter): ...
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pyChainSilhouetteIterator:
-    """Natural chaining iterator that follows the edges of the same nature following the topology of objects, with decreasing priority for silhouettes, then borders, then suggestive contours, then all other edge types. A ViewEdge is only chained once."""
+    """Natural chaining iterator that follows the edges of the same nature
+    following the topology of objects, with decreasing priority for
+    silhouettes, then borders, then suggestive contours, then all other edge
+    types.  A ViewEdge is only chained once.
+    """
+
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
 
-    def init(self): ...
-    def traverse(self, iter): ...
+        :param iter:
+        """
+        ...
 
 class pyExternalContourChainingIterator:
     """Chains by external contour"""
 
-    def checkViewEdge(self, ve, orientation): ...
-    def init(self): ...
-    def traverse(self, iter): ...
+    def checkViewEdge(self, ve, orientation):
+        """
+
+        :param ve:
+        :param orientation:
+        """
+        ...
+
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pyFillOcclusionsAbsoluteAndRelativeChainingIterator:
-    """Chaining iterator that fills small occlusions regardless of the selection."""
+    """Chaining iterator that fills small occlusions regardless of the
+    selection.
+    """
 
     def __init__(self, percent: float, l: float):
         """Builds a pyFillOcclusionsAbsoluteAndRelativeChainingIterator object.
 
-        :param percent: The maximal length of the occluded part as a percentage of the total chain length.
-        :type percent: float
-        :param l: Absolute length.
-        :type l: float
+                :param percent: The maximal length of the occluded part as a
+        percentage of the total chain length.
+                :type percent: float
+                :param l: Absolute length.
+                :type l: float
         """
         ...
 
-    def init(self): ...
-    def traverse(self, iter): ...
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pyFillOcclusionsAbsoluteChainingIterator:
     """Chaining iterator that fills small occlusions"""
@@ -113,8 +204,16 @@ class pyFillOcclusionsAbsoluteChainingIterator:
         """
         ...
 
-    def init(self): ...
-    def traverse(self, iter): ...
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pyFillOcclusionsRelativeChainingIterator:
     """Chaining iterator that fills small occlusions"""
@@ -122,32 +221,56 @@ class pyFillOcclusionsRelativeChainingIterator:
     def __init__(self, percent: float):
         """Builds a pyFillOcclusionsRelativeChainingIterator object.
 
-        :param percent: The maximal length of the occluded part, expressed in a percentage of the total chain length.
-        :type percent: float
+                :param percent: The maximal length of the occluded part, expressed
+        in a percentage of the total chain length.
+                :type percent: float
         """
         ...
 
-    def init(self): ...
-    def traverse(self, iter): ...
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pyFillQi0AbsoluteAndRelativeChainingIterator:
-    """Chaining iterator that fills small occlusions regardless of the selection."""
+    """Chaining iterator that fills small occlusions regardless of the
+    selection.
+    """
 
     def __init__(self, percent: float, l: float):
         """Builds a pyFillQi0AbsoluteAndRelativeChainingIterator object.
 
-        :param percent: The maximal length of the occluded part as a percentage of the total chain length.
-        :type percent: float
-        :param l: Absolute length.
-        :type l: float
+                :param percent: The maximal length of the occluded part as a
+        percentage of the total chain length.
+                :type percent: float
+                :param l: Absolute length.
+                :type l: float
         """
         ...
 
-    def init(self): ...
-    def traverse(self, iter): ...
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pyNoIdChainSilhouetteIterator:
-    """Natural chaining iterator that follows the edges of the same nature following the topology of objects, with decreasing priority for silhouettes, then borders, then suggestive contours, then all other edge types. It won't chain the same ViewEdge twice."""
+    """Natural chaining iterator that follows the edges of the same nature
+    following the topology of objects, with decreasing priority for
+    silhouettes, then borders, then suggestive contours, then all other edge
+    types.  It won't chain the same ViewEdge twice.
+    """
 
     def __init__(self, stayInSelection: bool = True):
         """Builds a pyNoIdChainSilhouetteIterator object.
@@ -157,11 +280,21 @@ class pyNoIdChainSilhouetteIterator:
         """
         ...
 
-    def init(self): ...
-    def traverse(self, iter): ...
+    def init(self):
+        """ """
+        ...
+
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pySketchyChainSilhouetteIterator:
-    """Natural chaining iterator with a sketchy multiple touch. It chains the same ViewEdge multiple times to achieve a sketchy effect."""
+    """Natural chaining iterator with a sketchy multiple touch.  It chains the
+    same ViewEdge multiple times to achieve a sketchy effect.
+    """
 
     def __init__(self, nRounds: int = 3, stayInSelection: bool = True):
         """Builds a pySketchyChainSilhouetteIterator object.
@@ -173,15 +306,38 @@ class pySketchyChainSilhouetteIterator:
         """
         ...
 
-    def init(self): ...
+    def init(self):
+        """ """
+        ...
+
     def make_sketchy(self, ve):
-        """Creates the sketchy effect by causing the chain to run from the start again. (loop over itself again)"""
+        """Creates the sketchy effect by causing the chain to run from
+        the start again. (loop over itself again)
+
+                :param ve:
+        """
         ...
 
-    def traverse(self, iter): ...
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...
 
 class pySketchyChainingIterator:
-    """Chaining iterator designed for sketchy style. It chains the same ViewEdge several times in order to produce multiple strokes per ViewEdge."""
+    """Chaining iterator designed for sketchy style. It chains the same
+    ViewEdge several times in order to produce multiple strokes per
+    ViewEdge.
+    """
+
+    def init(self):
+        """ """
+        ...
 
-    def init(self): ...
-    def traverse(self, iter): ...
+    def traverse(self, iter):
+        """
+
+        :param iter:
+        """
+        ...