# YXWaveView

**Repository Path**: yourtion/YXWaveView

## Basic Information

- **Project Name**: YXWaveView
- **Description**: 类似百度外卖的头像波浪效果
- **Primary Language**: Swift
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-03-01
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# YXWaveView [中文说明](README_CN.md)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Version](https://img.shields.io/cocoapods/v/YXWaveView.svg?style=flat)](http://cocoapods.org/pods/YXWaveView)
[![License](https://img.shields.io/cocoapods/l/YXWaveView.svg?style=flat)](http://cocoapods.org/pods/YXWaveView)
[![Platform](https://img.shields.io/cocoapods/p/YXWaveView.svg?style=flat)](http://cocoapods.org/pods/YXWaveView)

A water wave animation view with a over view float.

## ScreenShot 

![ScreenShot](ScreenShot.gif)

## Installl

#### CocoaPod

`Podfile` add this:

```
platform :ios, '8.0'

pod 'YXWaveView'
```

Run `pod install`

#### Carthage

```
github "yourtion/YXWaveView"
```

## How to use

```swift
// Init
let frame = CGRect(x: 0, y: 0, width: self.view.bounds.size.width, height: 200)
let waterView = YXWaveView(frame: frame, color: UIColor.white)

// Add OverView
waterView.addOverView(overView)

// Start
waterView.start()

// Stop
waterView.stop()
```


### Settings

```swift
// real wave color
waterView.realWaveColor = UIColor.blue

// mask wave color
waterView.maskWaveColor = UIColor.black

// wave speed (default: 0.6)
waterView.waveSpeed = 0.5

// wave height (default: 5)
waterView.waveHeight = 6

// wave curvature (default: 1.5)
waterView.waveCurvature = 1.2
```

Lookup [Demo](YXWaveViewDemo/ViewController.swift) so see detail.