# encoding: utf-8
# module vtkmodules.vtkCommonDataModel
# from C:\Users\xukai\Downloads\发票2\venv\Lib\site-packages\vtkmodules\vtkCommonDataModel.cp311-win_amd64.pyd
# by generator 1.147
# no doc

# imports
import vtkmodules.vtkCommonCore as __vtkmodules_vtkCommonCore
import vtkmodules.vtkCommonMath as __vtkmodules_vtkCommonMath
import vtkmodules.vtkCommonTransforms as __vtkmodules_vtkCommonTransforms


from .vtkIncrementalPointLocator import vtkIncrementalPointLocator

class vtkPointLocator(vtkIncrementalPointLocator):
    """
    vtkPointLocator - quickly locate points in 3-space
    
    Superclass: vtkIncrementalPointLocator
    
    vtkPointLocator is a spatial search object to quickly locate points
    in 3D. vtkPointLocator works by dividing a specified region of space
    into a regular array of "rectangular" buckets, and then keeping a
    list of points that lie in each bucket. Typical operation involves
    giving a position in 3D and finding the closest point.
    
    vtkPointLocator has two distinct methods of interaction. In the first
    method, you supply it with a dataset, and it operates on the points
    in the dataset. In the second method, you supply it with an array of
    points, and the object operates on the array.
    
    @warning
    Many other types of spatial locators have been developed such as
    octrees and kd-trees. These are often more efficient for the
    operations described here.
    
    @warning
    Frequently vtkStaticPointLocator is used in lieu of vtkPointLocator.
    They are very similar in terms of algorithmic approach, however
    vtkStaticCellLocator is threaded and is typically much faster for a
    large number of points (on the order of 3-5x faster). For small
    numbers of points, vtkPointLocator is just as fast as
    vtkStaticPointLocator.
    
    @sa
    vtkCellPicker vtkPointPicker vtkStaticPointLocator
    """
    def BuildLocator(self): # real signature unknown; restored from __doc__
        """
        BuildLocator(self) -> None
        C++: void BuildLocator() override;
        
        Build the locator from the input dataset. This will NOT do
        anything if UseExistingSearchStructure is on.
        """
        pass

    def FindClosestInsertedPoint(self, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        FindClosestInsertedPoint(self, x:(float, float, float)) -> int
        C++: vtkIdType FindClosestInsertedPoint(const double x[3])
            override;
        
        Given a position x, return the id of the point closest to it.
        This method is used when performing incremental point insertion.
        Note that -1 indicates that no point was found. This method is
        thread safe if BuildLocator() is directly or indirectly called
        from a single thread first.
        """
        pass

    def FindClosestNPoints(self, N, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        FindClosestNPoints(self, N:int, x:(float, float, float),
            result:vtkIdList) -> None
        C++: void FindClosestNPoints(int N, const double x[3],
            vtkIdList *result) override;
        
        Find the closest N points to a position. This returns the closest
        N points to a position. A faster method could be created that
        returned N close points to a position, but necessarily the exact
        N closest. The returned points are sorted from closest to
        farthest. These methods are thread safe if BuildLocator() is
        directly or indirectly called from a single thread first.
        """
        pass

    def FindClosestPoint(self, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        FindClosestPoint(self, x:(float, float, float)) -> int
        C++: vtkIdType FindClosestPoint(const double x[3]) override;
        FindClosestPoint(self, x:float, y:float, z:float) -> int
        C++: vtkIdType FindClosestPoint(double x, double y, double z)
        
        Given a position x, return the id of the point closest to it.
        Alternative method requires separate x-y-z values. These methods
        are thread safe if BuildLocator() is directly or indirectly
        called from a single thread first.
        """
        pass

    def FindClosestPointWithinRadius(self, radius, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        FindClosestPointWithinRadius(self, radius:float, x:(float, float,
            float), dist2:float) -> int
        C++: vtkIdType FindClosestPointWithinRadius(double radius,
            const double x[3], double &dist2) override;
        FindClosestPointWithinRadius(self, radius:float, x:(float, float,
            float), inputDataLength:float, dist2:float) -> int
        C++: virtual vtkIdType FindClosestPointWithinRadius(double radius,
             const double x[3], double inputDataLength, double &dist2)
        
        Given a position x and a radius r, return the id of the point
        closest to the point in that radius. These methods are thread
        safe if BuildLocator() is directly or indirectly called from a
        single thread first. dist2 returns the squared distance to the
        point.
        """
        pass

    def FindDistributedPoints(self, N, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        FindDistributedPoints(self, N:int, x:(float, float, float),
            result:vtkIdList, M:int) -> None
        C++: virtual void FindDistributedPoints(int N, const double x[3],
            vtkIdList *result, int M)
        FindDistributedPoints(self, N:int, x:float, y:float, z:float,
            result:vtkIdList, M:int) -> None
        C++: virtual void FindDistributedPoints(int N, double x, double y,
             double z, vtkIdList *result, int M)
        
        Find the closest points to a position such that each octant of
        space around the position contains at least N points. Loosely
        limit the search to a maximum number of points evaluated, M.
        These methods are thread safe if BuildLocator() is directly or
        indirectly called from a single thread first.
        """
        pass

    def FindPointsWithinRadius(self, R, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        FindPointsWithinRadius(self, R:float, x:(float, float, float),
            result:vtkIdList) -> None
        C++: void FindPointsWithinRadius(double R, const double x[3],
            vtkIdList *result) override;
        
        Find all points within a specified radius R of position x. The
        result is not sorted in any specific manner. These methods are
        thread safe if BuildLocator() is directly or indirectly called
        from a single thread first.
        """
        pass

    def ForceBuildLocator(self): # real signature unknown; restored from __doc__
        """
        ForceBuildLocator(self) -> None
        C++: void ForceBuildLocator() override;
        
        Build the locator from the input dataset (even if
        UseExistingSearchStructure is on).
        
        This function is not pure virtual to maintain backwards
        compatibility.
        """
        pass

    def FreeSearchStructure(self): # real signature unknown; restored from __doc__
        """
        FreeSearchStructure(self) -> None
        C++: void FreeSearchStructure() override;
        
        Free the memory required for the spatial data structure.
        """
        pass

    def GenerateRepresentation(self, level, pd): # real signature unknown; restored from __doc__
        """
        GenerateRepresentation(self, level:int, pd:vtkPolyData) -> None
        C++: void GenerateRepresentation(int level, vtkPolyData *pd)
            override;
        
        Method to build a representation at a particular level. Note that
        the method GetLevel() returns the maximum number of levels
        available for the tree. You must provide a vtkPolyData object
        into which to place the data.
        """
        pass

    def GetDivisions(self): # real signature unknown; restored from __doc__
        """
        GetDivisions(self) -> (int, int, int)
        C++: virtual int *GetDivisions()
        """
        pass

    def GetNumberOfGenerationsFromBase(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBase(self, type:str) -> int
        C++: vtkIdType GetNumberOfGenerationsFromBase(const char *type)
            override;
        
        Given the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def GetNumberOfGenerationsFromBaseType(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBaseType(type:str) -> int
        C++: static vtkIdType GetNumberOfGenerationsFromBaseType(
            const char *type)
        
        Given a the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def GetNumberOfPointsPerBucket(self): # real signature unknown; restored from __doc__
        """
        GetNumberOfPointsPerBucket(self) -> int
        C++: virtual int GetNumberOfPointsPerBucket()
        """
        return 0

    def GetNumberOfPointsPerBucketMaxValue(self): # real signature unknown; restored from __doc__
        """
        GetNumberOfPointsPerBucketMaxValue(self) -> int
        C++: virtual int GetNumberOfPointsPerBucketMaxValue()
        """
        return 0

    def GetNumberOfPointsPerBucketMinValue(self): # real signature unknown; restored from __doc__
        """
        GetNumberOfPointsPerBucketMinValue(self) -> int
        C++: virtual int GetNumberOfPointsPerBucketMinValue()
        """
        return 0

    def GetPoints(self): # real signature unknown; restored from __doc__
        """
        GetPoints(self) -> vtkPoints
        C++: virtual vtkPoints *GetPoints()
        
        Provide an accessor to the points.
        """
        pass

    def GetPointsInBucket(self, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        GetPointsInBucket(self, x:(float, float, float), ijk:[int, int,
            int]) -> vtkIdList
        C++: virtual vtkIdList *GetPointsInBucket(const double x[3],
            int ijk[3])
        
        Given a position x, return the list of points in the bucket that
        contains the point. It is possible that nullptr is returned. The
        user provides an ijk array that is the indices into the locator.
        This method is thread safe.
        """
        pass

    def Initialize(self): # real signature unknown; restored from __doc__
        """
        Initialize(self) -> None
        C++: void Initialize() override;
        
        See vtkLocator interface documentation. These methods are not
        thread safe.
        """
        pass

    def InitPointInsertion(self, newPts, bounds, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        InitPointInsertion(self, newPts:vtkPoints, bounds:(float, float,
            float, float, float, float)) -> int
        C++: int InitPointInsertion(vtkPoints *newPts,
            const double bounds[6]) override;
        InitPointInsertion(self, newPts:vtkPoints, bounds:(float, float,
            float, float, float, float), estNumPts:int) -> int
        C++: int InitPointInsertion(vtkPoints *newPts,
            const double bounds[6], vtkIdType estNumPts) override;
        
        Initialize the point insertion process. The newPts is an object
        representing point coordinates into which incremental insertion
        methods place their data. Bounds are the box that the points lie
        in. Not thread safe.
        """
        pass

    def InsertNextPoint(self, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        InsertNextPoint(self, x:(float, float, float)) -> int
        C++: vtkIdType InsertNextPoint(const double x[3]) override;
        
        Incrementally insert a point into search structure. The method
        returns the insertion location (i.e., point id). You should use
        the method IsInsertedPoint() to see whether this point has
        already been inserted (that is, if you desire to prevent
        duplicate points). Before using this method you must make sure
        that newPts have been supplied, the bounds has been set properly,
        and that divs are properly set. (See InitPointInsertion().) Not
        thread safe.
        """
        pass

    def InsertPoint(self, ptId, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        InsertPoint(self, ptId:int, x:(float, float, float)) -> None
        C++: void InsertPoint(vtkIdType ptId, const double x[3]) override;
        
        Incrementally insert a point into search structure with a
        particular index value. You should use the method
        IsInsertedPoint() to see whether this point has already been
        inserted (that is, if you desire to prevent duplicate points).
        Before using this method you must make sure that newPts have been
        supplied, the bounds has been set properly, and that divs are
        properly set. (See InitPointInsertion().) Not thread safe.
        """
        pass

    def InsertUniquePoint(self, x, *args, **kwargs): # real signature unknown; NOTE: unreliably restored from __doc__ 
        """
        InsertUniquePoint(self, x:(float, float, float), ptId:int) -> int
        C++: int InsertUniquePoint(const double x[3], vtkIdType &ptId)
            override;
        
        Determine whether point given by x[3] has been inserted into
        points list. Return 0 if point was already in the list, otherwise
        return 1. If the point was not in the list, it will be ADDED.  In
        either case, the id of the point (newly inserted or not) is
        returned in the ptId argument. Note this combines the
        functionality of IsInsertedPoint() followed by a call to
        InsertNextPoint(). This method is not thread safe.
        """
        pass

    def IsA(self, type): # real signature unknown; restored from __doc__
        """
        IsA(self, type:str) -> int
        C++: vtkTypeBool IsA(const char *type) override;
        
        Return 1 if this class is the same type of (or a subclass of) the
        named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def IsInsertedPoint(self, x, y, z): # real signature unknown; restored from __doc__
        """
        IsInsertedPoint(self, x:float, y:float, z:float) -> int
        C++: vtkIdType IsInsertedPoint(double x, double y, double z)
            override;
        IsInsertedPoint(self, x:(float, float, float)) -> int
        C++: vtkIdType IsInsertedPoint(const double x[3]) override;
        
        Determine whether point given by x[3] has been inserted into
        points list. Return id of previously inserted point if this is
        true, otherwise return
        -1. This method is thread safe.
        """
        return 0

    def IsTypeOf(self, type): # real signature unknown; restored from __doc__
        """
        IsTypeOf(type:str) -> int
        C++: static vtkTypeBool IsTypeOf(const char *type)
        
        Return 1 if this class type is the same type of (or a subclass
        of) the named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def NewInstance(self): # real signature unknown; restored from __doc__
        """
        NewInstance(self) -> vtkPointLocator
        C++: vtkPointLocator *NewInstance()
        """
        return vtkPointLocator

    def SafeDownCast(self, o): # real signature unknown; restored from __doc__
        """
        SafeDownCast(o:vtkObjectBase) -> vtkPointLocator
        C++: static vtkPointLocator *SafeDownCast(vtkObjectBase *o)
        """
        return vtkPointLocator

    def SetDivisions(self, _arg1, _arg2, _arg3): # real signature unknown; restored from __doc__
        """
        SetDivisions(self, _arg1:int, _arg2:int, _arg3:int) -> None
        C++: virtual void SetDivisions(int _arg1, int _arg2, int _arg3)
        SetDivisions(self, _arg:(int, int, int)) -> None
        C++: virtual void SetDivisions(const int _arg[3])
        
        Set the number of divisions in x-y-z directions.
        """
        pass

    def SetNumberOfPointsPerBucket(self, _arg): # real signature unknown; restored from __doc__
        """
        SetNumberOfPointsPerBucket(self, _arg:int) -> None
        C++: virtual void SetNumberOfPointsPerBucket(int _arg)
        
        Specify the average number of points in each bucket.
        """
        pass

    def __delattr__(self, *args, **kwargs): # real signature unknown
        """ Implement delattr(self, name). """
        pass

    def __getattribute__(self, *args, **kwargs): # real signature unknown
        """ Return getattr(self, name). """
        pass

    def __init__(self, *args, **kwargs): # real signature unknown
        pass

    @staticmethod # known case of __new__
    def __new__(*args, **kwargs): # real signature unknown
        """ Create and return a new object.  See help(type) for accurate signature. """
        pass

    def __repr__(self, *args, **kwargs): # real signature unknown
        """ Return repr(self). """
        pass

    def __setattr__(self, *args, **kwargs): # real signature unknown
        """ Implement setattr(self, name, value). """
        pass

    def __str__(self, *args, **kwargs): # real signature unknown
        """ Return str(self). """
        pass

    __this__ = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """Pointer to the C++ object."""


    __dict__ = None # (!) real value is 'mappingproxy({\'__vtkname__\': \'vtkPointLocator\', \'IsTypeOf\': <method \'IsTypeOf\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'IsA\': <method \'IsA\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'SafeDownCast\': <method \'SafeDownCast\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'NewInstance\': <method \'NewInstance\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetNumberOfGenerationsFromBaseType\': <method \'GetNumberOfGenerationsFromBaseType\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetNumberOfGenerationsFromBase\': <method \'GetNumberOfGenerationsFromBase\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'SetDivisions\': <method \'SetDivisions\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetDivisions\': <method \'GetDivisions\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'SetNumberOfPointsPerBucket\': <method \'SetNumberOfPointsPerBucket\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetNumberOfPointsPerBucketMinValue\': <method \'GetNumberOfPointsPerBucketMinValue\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetNumberOfPointsPerBucketMaxValue\': <method \'GetNumberOfPointsPerBucketMaxValue\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetNumberOfPointsPerBucket\': <method \'GetNumberOfPointsPerBucket\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'FindClosestPoint\': <method \'FindClosestPoint\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'FindClosestPointWithinRadius\': <method \'FindClosestPointWithinRadius\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'InitPointInsertion\': <method \'InitPointInsertion\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'InsertPoint\': <method \'InsertPoint\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'InsertNextPoint\': <method \'InsertNextPoint\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'IsInsertedPoint\': <method \'IsInsertedPoint\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'InsertUniquePoint\': <method \'InsertUniquePoint\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'FindClosestInsertedPoint\': <method \'FindClosestInsertedPoint\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'FindClosestNPoints\': <method \'FindClosestNPoints\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'FindDistributedPoints\': <method \'FindDistributedPoints\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'FindPointsWithinRadius\': <method \'FindPointsWithinRadius\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetPointsInBucket\': <method \'GetPointsInBucket\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GetPoints\': <method \'GetPoints\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'Initialize\': <method \'Initialize\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'FreeSearchStructure\': <method \'FreeSearchStructure\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'BuildLocator\': <method \'BuildLocator\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'ForceBuildLocator\': <method \'ForceBuildLocator\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'GenerateRepresentation\': <method \'GenerateRepresentation\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__new__\': <built-in method __new__ of type object at 0x00007FF81D6417A0>, \'__repr__\': <slot wrapper \'__repr__\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__str__\': <slot wrapper \'__str__\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__getattribute__\': <slot wrapper \'__getattribute__\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__setattr__\': <slot wrapper \'__setattr__\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__delattr__\': <slot wrapper \'__delattr__\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__dict__\': <attribute \'__dict__\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__this__\': <attribute \'__this__\' of \'vtkmodules.vtkCommonDataModel.vtkPointLocator\' objects>, \'__doc__\': \'vtkPointLocator - quickly locate points in 3-space\\n\\nSuperclass: vtkIncrementalPointLocator\\n\\nvtkPointLocator is a spatial search object to quickly locate points\\nin 3D. vtkPointLocator works by dividing a specified region of space\\ninto a regular array of "rectangular" buckets, and then keeping a\\nlist of points that lie in each bucket. Typical operation involves\\ngiving a position in 3D and finding the closest point.\\n\\nvtkPointLocator has two distinct methods of interaction. In the first\\nmethod, you supply it with a dataset, and it operates on the points\\nin the dataset. In the second method, you supply it with an array of\\npoints, and the object operates on the array.\\n\\n@warning\\nMany other types of spatial locators have been developed such as\\noctrees and kd-trees. These are often more efficient for the\\noperations described here.\\n\\n@warning\\nFrequently vtkStaticPointLocator is used in lieu of vtkPointLocator.\\nThey are very similar in terms of algorithmic approach, however\\nvtkStaticCellLocator is threaded and is typically much faster for a\\nlarge number of points (on the order of 3-5x faster). For small\\nnumbers of points, vtkPointLocator is just as fast as\\nvtkStaticPointLocator.\\n\\n@sa\\nvtkCellPicker vtkPointPicker vtkStaticPointLocator\\n\\n\'})'
    __vtkname__ = 'vtkPointLocator'


