"""
This module contains helper functions used for Freestyle style module
writing.

freestyle.utils.ContextFunctions.rst

:maxdepth: 1
:caption: Submodules

"""

import typing
import collections.abc
import typing_extensions
import numpy.typing as npt
import bpy.types
import freestyle.types

from . import ContextFunctions as ContextFunctions

class BoundingBox:
    """Object representing a bounding box consisting out of 2 2D vectors"""

    def inside(self, other) -> None:
        """True if self inside other, False otherwise

        :param other:
        """

    @classmethod
    def from_sequence(cls, sequence) -> None:
        """BoundingBox from sequence of 2D or 3D Vector objects

        :param sequence:
        """

class StrokeCollector:
    """Collects and Stores stroke objects"""

    def shade(self, stroke) -> None:
        """

        :param stroke:
        """

def angle_x_normal(it) -> None:
    """unsigned angle between a Points normal and the X axis, in radians"""

def bound(lower, x, higher) -> None:
    """Returns x bounded by a maximum and minimum value. Equivalent to:
    return min(max(x, lower), higher)

    """

def bounding_box(stroke) -> None:
    """Returns the maximum and minimum coordinates (the bounding box) of the strokes vertices"""

def curvature_from_stroke_vertex(svert) -> None:
    """The 3D curvature of an stroke vertex underlying geometry
    The result is None or in the range [-inf, inf]

    """

def find_matching_vertex(id, it) -> None:
    """Finds the matching vertex, or returns None."""

def getCurrentScene() -> bpy.types.Scene:
    """Returns the current scene.

    :return: The current scene.
    """

def get_chain_length(ve, orientation) -> None:
    """Returns the 2d length of a given ViewEdge."""

def get_object_name(stroke) -> None:
    """Returns the name of the object that this stroke is drawn on."""

def get_strokes() -> None:
    """Get all strokes that are currently available"""

def get_test_stroke() -> None:
    """Returns a static stroke object for testing"""

def integrate(
    func: freestyle.types.UnaryFunction0D,
    it: freestyle.types.Interface0DIterator,
    it_end: freestyle.types.Interface0DIterator,
    integration_type: freestyle.types.IntegrationType,
) -> float:
    """Returns a single value from a set of values evaluated at each 0D
    element of this 1D element.

        :param func: The UnaryFunction0D used to compute a value at each
    Interface0D.
        :param it: The Interface0DIterator used to iterate over the 0D
    elements of this 1D element. The integration will occur over
    the 0D elements starting from the one pointed by it.
        :param it_end: The Interface0DIterator pointing the end of the 0D
    elements of the 1D element.
        :param integration_type: The integration method used to compute a
    single value from a set of values.
        :return: The single value obtained for the 1D element. The return
    value type is float if func is of the `UnaryFunction0DDouble`
    or `UnaryFunction0DFloat` type, and int if func is of the
    `UnaryFunction0DUnsigned` type.
    """

def is_poly_clockwise(stroke) -> None:
    """True if the stroke is orientated in a clockwise way, False otherwise"""

def iter_distance_along_stroke(stroke) -> None:
    """Yields the absolute distance along the stroke up to the current vertex."""

def iter_distance_from_camera(stroke, range_min, range_max, normfac) -> None:
    """Yields the distance to the camera relative to the maximum
    possible distance for every stroke vertex, constrained by
    given minimum and maximum values.

    """

def iter_distance_from_object(stroke, location, range_min, range_max, normfac) -> None:
    """yields the distance to the given object relative to the maximum
    possible distance for every stroke vertex, constrained by
    given minimum and maximum values.

    """

def iter_material_value(stroke, func, attribute) -> None:
    """Yields a specific material attribute from the vertex underlying material."""

def iter_t2d_along_stroke(stroke) -> None:
    """Yields the progress along the stroke."""

def material_from_fedge(fe) -> None:
    """get the diffuse RGBA color from an FEdge"""

def normal_at_I0D(it) -> None:
    """Normal at an Interface0D object. In contrast to Normal2DF0D this
    function uses the actual data instead of underlying Fedge objects.

    """

def pairwise(iterable, types={Stroke, StrokeVertexIterator}) -> None:
    """Yields a tuple containing the previous and current object"""

def rgb_to_bw(r, g, b) -> None:
    """Method to convert rgb to a bw intensity value."""

def simplify(points, tolerance) -> None:
    """Simplifies a set of points"""

def stroke_curvature(it) -> None:
    """Compute the 2D curvature at the stroke vertex pointed by the iterator it.
    K = 1 / R
    where R is the radius of the circle going through the current vertex and its neighbors

    """

def stroke_normal(stroke) -> None:
    """Compute the 2D normal at the stroke vertex pointed by the iterator
    it.  It is noted that Normal2DF0D computes normals based on
    underlying FEdges instead, which is inappropriate for strokes when
    they have already been modified by stroke geometry modifiers.The returned normals are dynamic: they update when the
    vertex position (and therefore the vertex normal) changes.
    for use in geometry modifiers it is advised to
    cast this generator function to a tuple or list

    """

def tripplewise(iterable) -> None:
    """Yields a tuple containing the current object and its immediate neighbors"""