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

freestyle/predicates/__init__.pyi

@@ -1,22 +1,31 @@
-import sys
 import typing
 import freestyle.types
 
 GenericType = typing.TypeVar("GenericType")
 
-class AndBP1D: ...
-class AndUP1D: ...
+class AndBP1D:
+    """ """
+
+    ...
+
+class AndUP1D:
+    """ """
+
+    ...
 
 class ContourUP1D:
     """Class hierarchy: `freestyle.types.UnaryPredicate1D` > `ContourUP1D`"""
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
-        """Returns true if the Interface1D is a contour. An Interface1D is a contour if it is bordered by a different shape on each of its sides.
-
-        :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True if the Interface1D is a contour, false otherwise.
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the Interface1D is a contour. An Interface1D is a
+        contour if it is bordered by a different shape on each of its sides.
+
+                :param inter: An Interface1D object.
+                :type inter: freestyle.types.Interface1D
+                :return: True if the Interface1D is a contour, false otherwise.
+                :rtype: bool
         """
         ...
 
@@ -26,20 +35,25 @@ class DensityLowerThanUP1D:
     def __init__(self, threshold: float, sigma: float = 2.0):
         """Builds a DensityLowerThanUP1D object.
 
-        :param threshold: The value of the threshold density. Any Interface1D having a density lower than this threshold will match.
-        :type threshold: float
-        :param sigma: The sigma value defining the density evaluation window size used in the `freestyle.functions.DensityF0D` functor.
-        :type sigma: float
+                :param threshold: The value of the threshold density. Any Interface1D
+        having a density lower than this threshold will match.
+                :type threshold: float
+                :param sigma: The sigma value defining the density evaluation window
+        size used in the `freestyle.functions.DensityF0D` functor.
+                :type sigma: float
         """
         ...
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
-        """Returns true if the density evaluated for the Interface1D is less than a user-defined density value.
-
-        :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True if the density is lower than a threshold.
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the density evaluated for the Interface1D is less
+        than a user-defined density value.
+
+                :param inter: An Interface1D object.
+                :type inter: freestyle.types.Interface1D
+                :return: True if the density is lower than a threshold.
+                :rtype: bool
         """
         ...
 
@@ -54,13 +68,16 @@ class EqualToChainingTimeStampUP1D:
         """
         ...
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
-        """Returns true if the Interface1D's time stamp is equal to a certain user-defined value.
-
-        :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True if the time stamp is equal to a user-defined value.
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the Interface1D's time stamp is equal to a certain
+        user-defined value.
+
+                :param inter: An Interface1D object.
+                :type inter: freestyle.types.Interface1D
+                :return: True if the time stamp is equal to a user-defined value.
+                :rtype: bool
         """
         ...
 
@@ -75,26 +92,34 @@ class EqualToTimeStampUP1D:
         """
         ...
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
-        """Returns true if the Interface1D's time stamp is equal to a certain user-defined value.
-
-        :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True if the time stamp is equal to a user-defined value.
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the Interface1D's time stamp is equal to a certain
+        user-defined value.
+
+                :param inter: An Interface1D object.
+                :type inter: freestyle.types.Interface1D
+                :return: True if the time stamp is equal to a user-defined value.
+                :rtype: bool
         """
         ...
 
 class ExternalContourUP1D:
     """Class hierarchy: `freestyle.types.UnaryPredicate1D` > `ExternalContourUP1D`"""
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
-        """Returns true if the Interface1D is an external contour. An Interface1D is an external contour if it is bordered by no shape on one of its sides.
-
-        :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True if the Interface1D is an external contour, false otherwise.
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the Interface1D is an external contour.
+        An Interface1D is an external contour if it is bordered by no shape on
+        one of its sides.
+
+                :param inter: An Interface1D object.
+                :type inter: freestyle.types.Interface1D
+                :return: True if the Interface1D is an external contour, false
+        otherwise.
+                :rtype: bool
         """
         ...
 
@@ -102,44 +127,46 @@ class FalseBP1D:
     """Class hierarchy: `freestyle.types.BinaryPredicate1D` > `FalseBP1D`"""
 
     def __call__(
-        self,
-        inter1: "freestyle.types.Interface1D",
-        inter2: "freestyle.types.Interface1D",
-    ) -> bool:
+        self, inter1: freestyle.types.Interface1D, inter2: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
         """Always returns false.
 
         :param inter1: The first Interface1D object.
-        :type inter1: 'freestyle.types.Interface1D'
+        :type inter1: freestyle.types.Interface1D
         :param inter2: The second Interface1D object.
-        :type inter2: 'freestyle.types.Interface1D'
-        :rtype: bool
+        :type inter2: freestyle.types.Interface1D
         :return: False.
+        :rtype: bool
         """
         ...
 
 class FalseUP0D:
     """Class hierarchy: `freestyle.types.UnaryPredicate0D` > `FalseUP0D`"""
 
-    def __call__(self, it: "freestyle.types.Interface0DIterator") -> bool:
+    def __call__(
+        self, it: freestyle.types.Interface0DIterator
+    ) -> freestyle.types.Interface0DIterator:
         """Always returns false.
 
         :param it: An Interface0DIterator object.
-        :type it: 'freestyle.types.Interface0DIterator'
-        :rtype: bool
+        :type it: freestyle.types.Interface0DIterator
         :return: False.
+        :rtype: bool
         """
         ...
 
 class FalseUP1D:
     """Class hierarchy: `freestyle.types.UnaryPredicate1D` > `FalseUP1D`"""
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
         """Always returns false.
 
         :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
+        :type inter: freestyle.types.Interface1D
         :return: False.
+        :rtype: bool
         """
         ...
 
@@ -147,18 +174,17 @@ class Length2DBP1D:
     """Class hierarchy: `freestyle.types.BinaryPredicate1D` > `Length2DBP1D`"""
 
     def __call__(
-        self,
-        inter1: "freestyle.types.Interface1D",
-        inter2: "freestyle.types.Interface1D",
-    ) -> bool:
-        """Returns true if the 2D length of inter1 is less than the 2D length of inter2.
-
-        :param inter1: The first Interface1D object.
-        :type inter1: 'freestyle.types.Interface1D'
-        :param inter2: The second Interface1D object.
-        :type inter2: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True or false.
+        self, inter1: freestyle.types.Interface1D, inter2: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the 2D length of inter1 is less than the 2D length
+        of inter2.
+
+                :param inter1: The first Interface1D object.
+                :type inter1: freestyle.types.Interface1D
+                :param inter2: The second Interface1D object.
+                :type inter2: freestyle.types.Interface1D
+                :return: True or false.
+                :rtype: bool
         """
         ...
 
@@ -167,12 +193,35 @@ class MaterialBP1D:
 
     ...
 
-class NotBP1D: ...
-class NotUP1D: ...
-class ObjectNamesUP1D: ...
-class OrBP1D: ...
-class OrUP1D: ...
-class QuantitativeInvisibilityRangeUP1D: ...
+class NotBP1D:
+    """ """
+
+    ...
+
+class NotUP1D:
+    """ """
+
+    ...
+
+class ObjectNamesUP1D:
+    """ """
+
+    ...
+
+class OrBP1D:
+    """ """
+
+    ...
+
+class OrUP1D:
+    """ """
+
+    ...
+
+class QuantitativeInvisibilityRangeUP1D:
+    """ """
+
+    ...
 
 class QuantitativeInvisibilityUP1D:
     """Class hierarchy: `freestyle.types.UnaryPredicate1D` > `QuantitativeInvisibilityUP1D`"""
@@ -180,18 +229,25 @@ class QuantitativeInvisibilityUP1D:
     def __init__(self, qi: int = 0):
         """Builds a QuantitativeInvisibilityUP1D object.
 
-        :param qi: The Quantitative Invisibility you want the Interface1D to have.
-        :type qi: int
+                :param qi: The Quantitative Invisibility you want the Interface1D to
+        have.
+                :type qi: int
         """
         ...
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
-        """Returns true if the Quantitative Invisibility evaluated at an Interface1D, using the `freestyle.functions.QuantitativeInvisibilityF1D` functor, equals a certain user-defined value.
-
-        :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True if Quantitative Invisibility equals a user-defined value.
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the Quantitative Invisibility evaluated at an
+        Interface1D, using the
+        `freestyle.functions.QuantitativeInvisibilityF1D` functor,
+        equals a certain user-defined value.
+
+                :param inter: An Interface1D object.
+                :type inter: freestyle.types.Interface1D
+                :return: True if Quantitative Invisibility equals a user-defined
+        value.
+                :rtype: bool
         """
         ...
 
@@ -199,18 +255,16 @@ class SameShapeIdBP1D:
     """Class hierarchy: `freestyle.types.BinaryPredicate1D` > `SameShapeIdBP1D`"""
 
     def __call__(
-        self,
-        inter1: "freestyle.types.Interface1D",
-        inter2: "freestyle.types.Interface1D",
-    ) -> bool:
+        self, inter1: freestyle.types.Interface1D, inter2: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
         """Returns true if inter1 and inter2 belong to the same shape.
 
         :param inter1: The first Interface1D object.
-        :type inter1: 'freestyle.types.Interface1D'
+        :type inter1: freestyle.types.Interface1D
         :param inter2: The second Interface1D object.
-        :type inter2: 'freestyle.types.Interface1D'
-        :rtype: bool
+        :type inter2: freestyle.types.Interface1D
         :return: True or false.
+        :rtype: bool
         """
         ...
 
@@ -227,13 +281,17 @@ class ShapeUP1D:
         """
         ...
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
-        """Returns true if the shape to which the Interface1D belongs to has the same `freestyle.types.Id` as the one specified by the user.
-
-        :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True if Interface1D belongs to the shape of the user-specified Id.
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the shape to which the Interface1D belongs to has the
+        same `freestyle.types.Id` as the one specified by the user.
+
+                :param inter: An Interface1D object.
+                :type inter: freestyle.types.Interface1D
+                :return: True if Interface1D belongs to the shape of the
+        user-specified Id.
+                :rtype: bool
         """
         ...
 
@@ -241,44 +299,46 @@ class TrueBP1D:
     """Class hierarchy: `freestyle.types.BinaryPredicate1D` > `TrueBP1D`"""
 
     def __call__(
-        self,
-        inter1: "freestyle.types.Interface1D",
-        inter2: "freestyle.types.Interface1D",
-    ) -> bool:
+        self, inter1: freestyle.types.Interface1D, inter2: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
         """Always returns true.
 
         :param inter1: The first Interface1D object.
-        :type inter1: 'freestyle.types.Interface1D'
+        :type inter1: freestyle.types.Interface1D
         :param inter2: The second Interface1D object.
-        :type inter2: 'freestyle.types.Interface1D'
-        :rtype: bool
+        :type inter2: freestyle.types.Interface1D
         :return: True.
+        :rtype: bool
         """
         ...
 
 class TrueUP0D:
     """Class hierarchy: `freestyle.types.UnaryPredicate0D` > `TrueUP0D`"""
 
-    def __call__(self, it: "freestyle.types.Interface0DIterator") -> bool:
+    def __call__(
+        self, it: freestyle.types.Interface0DIterator
+    ) -> freestyle.types.Interface0DIterator:
         """Always returns true.
 
         :param it: An Interface0DIterator object.
-        :type it: 'freestyle.types.Interface0DIterator'
-        :rtype: bool
+        :type it: freestyle.types.Interface0DIterator
         :return: True.
+        :rtype: bool
         """
         ...
 
 class TrueUP1D:
     """Class hierarchy: `freestyle.types.UnaryPredicate1D` > `TrueUP1D`"""
 
-    def __call__(self, inter: "freestyle.types.Interface1D") -> bool:
+    def __call__(
+        self, inter: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
         """Always returns true.
 
         :param inter: An Interface1D object.
-        :type inter: 'freestyle.types.Interface1D'
-        :rtype: bool
+        :type inter: freestyle.types.Interface1D
         :return: True.
+        :rtype: bool
         """
         ...
 
@@ -288,33 +348,37 @@ class ViewMapGradientNormBP1D:
     def __init__(
         self,
         level: int,
-        integration_type: "freestyle.types.IntegrationType" = "IntegrationType.MEAN",
+        integration_type: freestyle.types.IntegrationType = None,
         sampling: float = 2.0,
     ):
         """Builds a ViewMapGradientNormBP1D object.
 
-        :param level: The level of the pyramid from which the pixel must be read.
-        :type level: int
-        :param integration_type: The integration method used to compute a single value from a set of values.
-        :type integration_type: 'freestyle.types.IntegrationType'
-        :param sampling: GetViewMapGradientNormF0D is evaluated at each sample point and the result is obtained by combining the resulting values into a single one, following the method specified by integration_type.
-        :type sampling: float
+                :param level: The level of the pyramid from which the pixel must be
+        read.
+                :type level: int
+                :param integration_type: The integration method used to compute a single value
+        from a set of values.
+                :type integration_type: freestyle.types.IntegrationType
+                :param sampling: The resolution used to sample the chain:
+        GetViewMapGradientNormF0D is evaluated at each sample point and
+        the result is obtained by combining the resulting values into a
+        single one, following the method specified by integration_type.
+                :type sampling: float
         """
         ...
 
     def __call__(
-        self,
-        inter1: "freestyle.types.Interface1D",
-        inter2: "freestyle.types.Interface1D",
-    ) -> bool:
-        """Returns true if the evaluation of the Gradient norm Function is higher for inter1 than for inter2.
-
-        :param inter1: The first Interface1D object.
-        :type inter1: 'freestyle.types.Interface1D'
-        :param inter2: The second Interface1D object.
-        :type inter2: 'freestyle.types.Interface1D'
-        :rtype: bool
-        :return: True or false.
+        self, inter1: freestyle.types.Interface1D, inter2: freestyle.types.Interface1D
+    ) -> freestyle.types.Interface1D:
+        """Returns true if the evaluation of the Gradient norm Function is
+        higher for inter1 than for inter2.
+
+                :param inter1: The first Interface1D object.
+                :type inter1: freestyle.types.Interface1D
+                :param inter2: The second Interface1D object.
+                :type inter2: freestyle.types.Interface1D
+                :return: True or false.
+                :rtype: bool
         """
         ...
 
@@ -336,47 +400,195 @@ class WithinImageBoundaryUP1D:
         ...
 
     def __call__(self, inter):
-        """Returns true if the Interface1D intersects with image boundary."""
+        """Returns true if the Interface1D intersects with image boundary.
+
+        :param inter:
+        """
         ...
 
 class pyBackTVertexUP0D:
-    """Check whether an Interface0DIterator references a TVertex and is the one that is hidden (inferred from the context)."""
-
-    ...
-
-class pyClosedCurveUP1D: ...
-class pyDensityFunctorUP1D: ...
-class pyDensityUP1D: ...
-class pyDensityVariableSigmaUP1D: ...
-class pyHighDensityAnisotropyUP1D: ...
-class pyHighDirectionalViewMapDensityUP1D: ...
-class pyHighSteerableViewMapDensityUP1D: ...
-class pyHighViewMapDensityUP1D: ...
-class pyHighViewMapGradientNormUP1D: ...
-class pyHigherCurvature2DAngleUP0D: ...
-class pyHigherLengthUP1D: ...
-class pyHigherNumberOfTurnsUP1D: ...
-class pyIsInOccludersListUP1D: ...
-class pyIsOccludedByIdListUP1D: ...
-class pyIsOccludedByItselfUP1D: ...
-class pyIsOccludedByUP1D: ...
-class pyLengthBP1D: ...
-class pyLowDirectionalViewMapDensityUP1D: ...
-class pyLowSteerableViewMapDensityUP1D: ...
-class pyNFirstUP1D: ...
-class pyNatureBP1D: ...
-class pyNatureUP1D: ...
-class pyParameterUP0D: ...
-class pyParameterUP0DGoodOne: ...
-class pyProjectedXBP1D: ...
-class pyProjectedYBP1D: ...
-class pyShapeIdListUP1D: ...
-class pyShapeIdUP1D: ...
-class pyShuffleBP1D: ...
-class pySilhouetteFirstBP1D: ...
-class pyUEqualsUP0D: ...
-class pyVertexNatureUP0D: ...
-class pyViewMapGradientNormBP1D: ...
-class pyZBP1D: ...
-class pyZDiscontinuityBP1D: ...
-class pyZSmallerUP1D: ...
+    """Check whether an Interface0DIterator references a TVertex and is
+    the one that is hidden (inferred from the context).
+    """
+
+    ...
+
+class pyClosedCurveUP1D:
+    """ """
+
+    ...
+
+class pyDensityFunctorUP1D:
+    """ """
+
+    ...
+
+class pyDensityUP1D:
+    """ """
+
+    ...
+
+class pyDensityVariableSigmaUP1D:
+    """ """
+
+    ...
+
+class pyHighDensityAnisotropyUP1D:
+    """ """
+
+    ...
+
+class pyHighDirectionalViewMapDensityUP1D:
+    """ """
+
+    ...
+
+class pyHighSteerableViewMapDensityUP1D:
+    """ """
+
+    ...
+
+class pyHighViewMapDensityUP1D:
+    """ """
+
+    ...
+
+class pyHighViewMapGradientNormUP1D:
+    """ """
+
+    ...
+
+class pyHigherCurvature2DAngleUP0D:
+    """ """
+
+    ...
+
+class pyHigherLengthUP1D:
+    """ """
+
+    ...
+
+class pyHigherNumberOfTurnsUP1D:
+    """ """
+
+    ...
+
+class pyIsInOccludersListUP1D:
+    """ """
+
+    ...
+
+class pyIsOccludedByIdListUP1D:
+    """ """
+
+    ...
+
+class pyIsOccludedByItselfUP1D:
+    """ """
+
+    ...
+
+class pyIsOccludedByUP1D:
+    """ """
+
+    ...
+
+class pyLengthBP1D:
+    """ """
+
+    ...
+
+class pyLowDirectionalViewMapDensityUP1D:
+    """ """
+
+    ...
+
+class pyLowSteerableViewMapDensityUP1D:
+    """ """
+
+    ...
+
+class pyNFirstUP1D:
+    """ """
+
+    ...
+
+class pyNatureBP1D:
+    """ """
+
+    ...
+
+class pyNatureUP1D:
+    """ """
+
+    ...
+
+class pyParameterUP0D:
+    """ """
+
+    ...
+
+class pyParameterUP0DGoodOne:
+    """ """
+
+    ...
+
+class pyProjectedXBP1D:
+    """ """
+
+    ...
+
+class pyProjectedYBP1D:
+    """ """
+
+    ...
+
+class pyShapeIdListUP1D:
+    """ """
+
+    ...
+
+class pyShapeIdUP1D:
+    """ """
+
+    ...
+
+class pyShuffleBP1D:
+    """ """
+
+    ...
+
+class pySilhouetteFirstBP1D:
+    """ """
+
+    ...
+
+class pyUEqualsUP0D:
+    """ """
+
+    ...
+
+class pyVertexNatureUP0D:
+    """ """
+
+    ...
+
+class pyViewMapGradientNormBP1D:
+    """ """
+
+    ...
+
+class pyZBP1D:
+    """ """
+
+    ...
+
+class pyZDiscontinuityBP1D:
+    """ """
+
+    ...
+
+class pyZSmallerUP1D:
+    """ """
+
+    ...