# TouchVisualizer

**Repository Path**: mirrors/TouchVisualizer

## Basic Information

- **Project Name**: TouchVisualizer
- **Description**: TouchVisualizer 是一个轻量型触摸可视化库，能将你触摸屏幕过程显示出来
- **Primary Language**: Swift
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/touchvisualizer
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-01-18
- **Last Updated**: 2025-11-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ![TouchVisualizer](misc/logo2.png)

[![Version](https://img.shields.io/cocoapods/v/TouchVisualizer.svg?style=flat)](http://cocoadocs.org/docsets/TouchVisualizer) [![License](https://img.shields.io/cocoapods/l/TouchVisualizer.svg?style=flat)](http://cocoadocs.org/docsets/TouchVisualizer) [![Platform](https://img.shields.io/cocoapods/p/TouchVisualizer.svg?style=flat)](http://cocoadocs.org/docsets/TouchVisualizer)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/morizotter/TouchVisualizer)
[![Circle CI](https://circleci.com/gh/morizotter/TouchVisualizer/tree/master.svg?style=shield&circle-token=b7eb2e179731634bcac95d1e4f8e90b837b092e3)](https://circleci.com/gh/morizotter/TouchVisualizer/tree/master) [![Join the chat at https://gitter.im/morizotter/TouchVisualizer](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/morizotter/TouchVisualizer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

TouchVisualizer is a lightweight pure Swift implementation for visualising touches on the screen.

## Features

- Works with just **a single line of code**!
- Supports multiple fingers.
- Supports multiple `UIWindow`'s.
- Displays touch radius (finger size).
- Displays touch duration.
- Customise the finger-points image and colour.
- Supports iPhone and iPad in both portrait and landscape mode.

## How it looks

### Portrait:

![one](misc/one.gif)

### Landscape:

![two](misc/two.gif)

### Robots:

![three](misc/three.gif)

### In-app implementation:

![four](misc/four.gif)

It's fun!

## Runtime Requirements

- Swift 4.0
- Xcode 9.2
- iOS9.0 or later

TouchVisualizer works with Swift 5.2 from version 4.0.0.

## Installation and Setup

**Note:** Embedded frameworks require a minimum deployment target of iOS 9.0.

**Information:** To use TouchVisualizer with a project targeting iOS 8.0 or lower, you must include the `TouchVisualizer.swift` source file directly in your project.

### Installing with CocoaPods

[CocoaPods](http://cocoapods.org) is a centralised dependency manager that automates the process of adding libraries to your Cocoa application. You can install it with the following command:

```bash
$ gem update
$ gem install cocoapods
$ pods --version
```

To integrate TouchVisualizer into your Xcode project using CocoaPods, specify it in your `Podfile` and run `pod install`.

```bash
platform :ios, '9.0'
use_frameworks!
pod "TouchVisualizer", '~> 4.0'
```

### Installing with Carthage

Carthage is a decentralised dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with [Homebrew](http://brew.sh/) using the following command:

```bash
$ brew update
$ brew install carthage
```

To integrate TouchVisualizer into your Xcode project using Carthage, specify it in your `Cartfile`:

```ogdl
github "morizotter/TouchVisualizer" "4.0.0"
```

### Manual Installation

To install TouchVisualizer without a dependency manager, please add all of the files in `/Pod` to your Xcode Project.

## Usage

To start using TouchVisualizer, write the following line wherever you want to start visualising:

```swift
import TouchVisualizer
```

Then invoke visualisation, by calling:

```swift
Visualizer.start()
```

and stop the presentation like this:

```swift
Visualizer.stop()
```

Get touch locations by this:

```swift
Visualizer.getTouches()
```

It is really simple, isn't it?

## Customisation

TouchVisualizer also has the ability to customize your touch events. Here is an example of what can be customized:

```swift
var config = Configuration()
config.color = UIColor.redColor()
config.image = UIImage(named: "YOUR-IMAGE")
config.showsTimer = true
config.showsTouchRadius = true
config.showsLog = true
Visualizer.start(config)
```

### Configuration properties

| name             | type      | description                                                                                                                | default       |
| :--------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ |
| color            | `UIColor` | Color of touch point and text.                                                                                             | default color |
| image            | `UIImage` | Touch point image. If rendering mode is set to `UIImageRenderingModeAlwaysTemplate`, the image is filled with color above. | circle image  |
| defaultSize      | `CGSize`  | Default size of touch point.                                                                                               | 60 x 60px     |
| showsTimer       | `Bool`    | Shows touch duration.                                                                                                      | false         |
| showsTouchRadius | `Bool`    | Shows touch radius by scaling touch point. It doesn't work on simulator.                                                   | false         |
| showsLog         | `Bool`    | Shows log.                                                                                                                 | false         |

## Documentation

### Peripheral

- [How to take an iOS screen movie](misc/take_a_movie.md)

### Presentation

- [TouchVisualizer Demo movie #potatotips // Speaker Deck](https://speakerdeck.com/morizotter/touchvisualizer-demo-movie-number-potatotips) @potatotips May 13 2015

## Contributing

Please file issues or submit pull requests for anything you’d like to see! We're waiting! :)

## Licensing

TouchVisualizer is released under the MIT license. Go read the LICENSE file for more information.

#### Miscellaneous

There is a similar _touch visualization_ library called [COSTouchVisualizer](https://github.com/conopsys/COSTouchVisualizer), which is written in Objective-C. [COSTouchVisualizer](https://github.com/conopsys/COSTouchVisualizer) supports earlier versions of iOS and is more mature. If TouchVisualizer isn't enough for you, try that!