https://github.com/stkent/PolygonDrawingUtil

A compact Android utility for constructing and drawing rounded regular polygons.
https://github.com/stkent/PolygonDrawingUtil

android android-ui android-view drawing geometry polygons

Last synced: 3 months ago
JSON representation

A compact Android utility for constructing and drawing rounded regular polygons.

• Host: GitHub
• URL: https://github.com/stkent/PolygonDrawingUtil
• Owner: stkent
• License: apache-2.0
• Archived: true
• Created: 2017-04-15T17:15:35.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-26T08:57:09.000Z (about 5 years ago)
• Last Synced: 2024-06-16T06:37:48.871Z (5 months ago)
• Topics: android, android-ui, android-view, drawing, geometry, polygons
• Language: Java
• Homepage:
• Size: 1.74 MB
• Stars: 821
• Watchers: 14
• Forks: 95
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-android-ui - PolygonDrawingUtil - 在canvas上绘制规则多边形 (其他)

README

        
# PolygonDrawingUtil

 [![Download](https://api.bintray.com/packages/stkent/android-libraries/PolygonDrawingUtil/images/download.svg)](https://bintray.com/stkent/android-libraries/PolygonDrawingUtil/_latestVersion) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-PolygonDrawingUtil-green.svg?style=flat)](https://android-arsenal.com/details/1/5597)

A compact Android utility for constructing and drawing rounded regular polygons.

Consumers can specify:

- number of sides (≥ 3);

- center coordinates;

- outer radius (center to vertex);

- corner rounding radius;

- polygon rotation;

- (optional) fill/stroke [`Paint`](https://developer.android.com/reference/android/graphics/Paint.html);

- (optional) target [`Path`](https://developer.android.com/reference/android/graphics/Path) instance.

# Demo

![](assets/demo.gif)

This video was captured using the sample application in this repository. It provides convenient controls for exploring `PolygonDrawingUtil`'s capabilities.

# Getting Started

1. Specify PolygonDrawingUtil as a dependency in your `build.gradle` file:

    ```groovy

    dependencies {

      implementation "com.stkent:polygondrawingutil:1.2.0"

    }

    ```

2. Create a new `PolygonDrawingUtil` instance and assign it to a property in your custom view class:

    ```kotlin

    private val polygonDrawingUtil = PolygonDrawingUtil()

    ```

3. Call `polygonDrawUtil.drawPolygon` in your `onDraw` method:

    ```kotlin

    override fun onDraw(canvas: Canvas) {

        super.onDraw(canvas)

        polygonDrawingUtil.drawPolygon(

            canvas,

            numberOfSides,

            centerX,

            centerY,

            polygonRadius,

            cornerRadius,

            rotation,

            polygonPaint

        )

    }

    ```

    Alternately, you can supply your own `Path` instance and ask `PolygonDrawingUtil` to fill it with a polygon:

    ```kotlin

    private val myPath = Path()

    polygonDrawingUtil.constructPolygonPath(

        myPath,

        numberOfSides,

        centerX,

        centerY,

        polygonRadius,

        cornerRadius,

        rotation

    )

    ```

    This allows you to perform post-processing on the `Path` before drawing to a `Canvas`.

# License

	Copyright 2019 Stuart Kent

	Licensed under the Apache License, Version 2.0 (the "License");

	you may not use this file except in compliance with the License.

	You may obtain a copy of the License at

	   http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software

	distributed under the License is distributed on an "AS IS" BASIS,

	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

	See the License for the specific language governing permissions and

	limitations under the License.