poverlap

Name	poverlap JSON
Version	1.0.0 JSON
	download
home_page
Summary	Point Overlapping With Any 2D Shape
upload_time	2023-10-05 10:49:22
maintainer
docs_url	None
author
requires_python	>=3.9
license	Copyright (c) <2025> <Tooraj - booleansfunction@Gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	point overlapping collide 2d overlap 2d collide collision overlap point overlap point collide
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # **POVERLAP**


POverlap or Point Overlap is pure python library For Check Overlapping or Colliding 2D Point With Any 2D Shape. And Work Everywhere.

# Installation

Install library like other library use `pip` package manager.

```bash
pip install poverlap
```

```shell
py -m pip install poverlap
```

## Usage

First Importing `poverlap` Package

```python
import poverlap
```

then use any function you needed

```python
point_a = (10, 200)
point_b = (30, 100)

pdp: float = poverlap.point_distance(point_a, point_b)

pop: bool = poverlap.point_point(point_a, point_b)
pop_area: bool = poverlap.point_point_add_area(point_a, point_b, 5.5)

```

## Some Detail

All Overlapping Point Algorithm in One File and Any File Fully NoDepended Can Use One File From `poverlap` in your app without need anything else.

__TypeAliases Mean:__
```python
# in point_point.py
T_X: TypeAlias = int | float
T_Y: TypeAlias = int | float
T_POINT: TypeAlias = tuple[T_X, T_Y], list[T_X, T_Y]

# added in point_line.py
T_LINE: TypeAlias = tuple[T_POINT, T_POINT], list[T_POINT, T_POINT]

# added in point_rectangle.py
T_W: TypeAlias = int | float
T_H: TypeAlias = int | float
T_POSITION: TypeAlias = T_POINT
T_SIZE: TypeAlias = tuple[T_W, T_H], list[T_W, T_H]

# added in point_circle.py
T_RADIUS: TypeAlias = int |float

# added in point_polygon.py
T_POLYGON: TypeAlias = tuple[T_POSITION], list[T_POSITION]
```

Some of Function Name Ended With `_add_area()` like `point_point_add_area()` this means u can Use for Bigger or Some Bigger and Smaller Area for Detection Overlapping.


[SourceCode](https://github.com/IRTJ/poverlap)

## License


[MIT](https://github.com/IRTJ/poverlap/blob/main/License)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "poverlap",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "point,overlapping,collide,2d overlap,2d collide,collision,overlap,point overlap,point collide",
    "author": "",
    "author_email": "Tooraj <booleansfunction@Gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e8/2d/477f715a009a8f1c2c2651c0ae35854babf3e63553fa7c5d348bcbc9a6d1/poverlap-1.0.0.tar.gz",
    "platform": null,
    "description": "# **POVERLAP**\r\n\r\n\r\nPOverlap or Point Overlap is pure python library For Check Overlapping or Colliding 2D Point With Any 2D Shape. And Work Everywhere.\r\n\r\n# Installation\r\n\r\nInstall library like other library use `pip` package manager.\r\n\r\n```bash\r\npip install poverlap\r\n```\r\n\r\n```shell\r\npy -m pip install poverlap\r\n```\r\n\r\n## Usage\r\n\r\nFirst Importing `poverlap` Package\r\n\r\n```python\r\nimport poverlap\r\n```\r\n\r\nthen use any function you needed\r\n\r\n```python\r\npoint_a = (10, 200)\r\npoint_b = (30, 100)\r\n\r\npdp: float = poverlap.point_distance(point_a, point_b)\r\n\r\npop: bool = poverlap.point_point(point_a, point_b)\r\npop_area: bool = poverlap.point_point_add_area(point_a, point_b, 5.5)\r\n\r\n```\r\n\r\n## Some Detail\r\n\r\nAll Overlapping Point Algorithm in One File and Any File Fully NoDepended Can Use One File From `poverlap` in your app without need anything else.\r\n\r\n__TypeAliases Mean:__\r\n```python\r\n# in point_point.py\r\nT_X: TypeAlias = int | float\r\nT_Y: TypeAlias = int | float\r\nT_POINT: TypeAlias = tuple[T_X, T_Y], list[T_X, T_Y]\r\n\r\n# added in point_line.py\r\nT_LINE: TypeAlias = tuple[T_POINT, T_POINT], list[T_POINT, T_POINT]\r\n\r\n# added in point_rectangle.py\r\nT_W: TypeAlias = int | float\r\nT_H: TypeAlias = int | float\r\nT_POSITION: TypeAlias = T_POINT\r\nT_SIZE: TypeAlias = tuple[T_W, T_H], list[T_W, T_H]\r\n\r\n# added in point_circle.py\r\nT_RADIUS: TypeAlias = int |float\r\n\r\n# added in point_polygon.py\r\nT_POLYGON: TypeAlias = tuple[T_POSITION], list[T_POSITION]\r\n```\r\n\r\nSome of Function Name Ended With `_add_area()` like `point_point_add_area()` this means u can Use for Bigger or Some Bigger and Smaller Area for Detection Overlapping.\r\n\r\n\r\n[SourceCode](https://github.com/IRTJ/poverlap)\r\n\r\n## License\r\n\r\n\r\n[MIT](https://github.com/IRTJ/poverlap/blob/main/License)\r\n",
    "bugtrack_url": null,
    "license": "Copyright (c) <2025> <Tooraj - booleansfunction@Gmail.com>  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Point Overlapping With Any 2D Shape",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/IRTJ/poverlap",
        "Source": "https://github.com/IRTJ/poverlap"
    },
    "split_keywords": [
        "point",
        "overlapping",
        "collide",
        "2d overlap",
        "2d collide",
        "collision",
        "overlap",
        "point overlap",
        "point collide"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3dade75ff4e0c55ca11287ebe1e8e46beba43d12b74b2d9340399da78f31b1d1",
                "md5": "02fdb1ab7611ebab18c709eae6490d5e",
                "sha256": "ab55daa1f8efc0f59c66f9c9dc302ed9e06b804e6c2be8ca7c6808bcd1db89fb"
            },
            "downloads": -1,
            "filename": "poverlap-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "02fdb1ab7611ebab18c709eae6490d5e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 8185,
            "upload_time": "2023-10-05T10:49:20",
            "upload_time_iso_8601": "2023-10-05T10:49:20.807580Z",
            "url": "https://files.pythonhosted.org/packages/3d/ad/e75ff4e0c55ca11287ebe1e8e46beba43d12b74b2d9340399da78f31b1d1/poverlap-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e82d477f715a009a8f1c2c2651c0ae35854babf3e63553fa7c5d348bcbc9a6d1",
                "md5": "c590ce1ac22fba0c95da6580a448879f",
                "sha256": "206ec36b80b30696def5b7aed9f207240ed1790e8bad0deb662c14cb2e67e03d"
            },
            "downloads": -1,
            "filename": "poverlap-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c590ce1ac22fba0c95da6580a448879f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 6897,
            "upload_time": "2023-10-05T10:49:22",
            "upload_time_iso_8601": "2023-10-05T10:49:22.784662Z",
            "url": "https://files.pythonhosted.org/packages/e8/2d/477f715a009a8f1c2c2651c0ae35854babf3e63553fa7c5d348bcbc9a6d1/poverlap-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-05 10:49:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "IRTJ",
    "github_project": "poverlap",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "poverlap"
}