Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pqpo committed Aug 8, 2017
1 parent 5763a1d commit 48e0333
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SmartCropper

简单易用的智能图片裁剪库,适用于身份证,名片,文档等照片的裁剪。 欢迎 start,follow
简单易用的智能图片裁剪库,适用于身份证,名片,文档等照片的裁剪。 欢迎 start,fork

## 支持特性

Expand Down Expand Up @@ -34,18 +34,16 @@
可以直接依赖 aar 文件夹下的 aar 文件,也可以 clone 项目,将 smartcropperlib 作为 Android 模块导入。之后有需要的话可以上传到仓库。
另外根目录 libs 目录下是编译好的 native library,如果引入项目不想编译,可以直接使用。

注意:**不要混淆**
注意:由于使用了 JNI, 所以**不要混淆**

## 使用

### 1. 布局:
```xml
<me.pqpo.smartcropperlib.view.CropImageView
android:id="@+id/iv_crop"
android:layout_width="match_parent"
android:layout_margin="20dp"
android:layout_height="0dp"
android:layout_weight="1"/>
android:layout_width="match_parent"
android:layout_height="match_parent" />
```

### 2. 智能选区:
Expand All @@ -58,10 +56,10 @@ Point[] points = SmartCropper.scan(selectedBitmap);
### 3. 设置给 CropImageView 展示

```java
ivCrop.setCropPoints(points);
ivCrop.setImageBitmap(selectedBitmap);
ivCrop.setImageBitmap(selectedBitmap);
ivCrop.setCropPoints(points);
```
将选区顶点,需要显示的图片设置给 CropImageView 显示图片,绘制选区。
将选区顶点,需要显示的图片设置给 CropImageView 显示图片,绘制选区。 先设置图片再设置选区顶点。如果设置的顶点无效会默认使用包裹整个图片的顶点。

### 3. 裁剪:

Expand All @@ -74,14 +72,14 @@ Bitmap crop = ivCrop.crop();

### SmartCropper 类:

#### 1. 扫描边框,大图下会比较耗时
#### 1. 扫描边框,大图下会比较耗时,注意在子线程操作

```java
public static Point[] scan(Bitmap srcBmp)
```
返回值为大小为4的 Point 数组,表示选区边框的四个顶点,依次为左上,右上,右下,左下。

#### 2. 根据边框顶点裁剪,大图下会比较耗时
#### 2. 根据边框顶点裁剪,大图下会比较耗时,注意在子线程操作

```java
public static Bitmap crop(Bitmap srcBmp, Point[] cropPoints)
Expand All @@ -91,8 +89,9 @@ public static Bitmap crop(Bitmap srcBmp, Point[] cropPoints)

#### 1. 设置裁剪边框锚点
```java
public void setCropPoints(Point[] cropPoints)
```
public void setCropPoints(Point[] cropPoints)
```
cropPoints 的大小必须为4,依次为左上,右上,右下,左下,**顶点的坐标是基于设置图片的大小,而非 View 的大小**

#### 2. 设置选区外的透明度
```java
Expand All @@ -113,7 +112,7 @@ public void setLineColor(int lineColor)
public void setLineWidth(int lineWidth)
```

#### 6. 根据用户选区裁剪图片
#### 6. 根据用户选区裁剪图片,大图下会比较耗时,注意在子线程操作

```java
public Bitmap crop()
Expand All @@ -125,11 +124,13 @@ public Bitmap crop()
public Bitmap crop(Point[] points)
```

## Futures
## TODOS

1. 优化智能选区算法
2. CropImageView 选区放大镜效果
3. ...
2. ~~优化点排序算法~~
3. CropImageView 选区放大镜效果
4. CropImageView xml属性配置
5. ...

---
如有问题可联系:pqponet#gmail.com, 也可提 ISSUE。
Expand Down

0 comments on commit 48e0333

Please sign in to comment.