bradhowes/Joystick

Additional Properties

Here are some additional configurable features of the JoyStickView:

* [handleConstraint](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L39) -- optional `CGRect` which constrains where the handle can move. See the playground for an example.
* [baseImage](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L116) -- a UIImage to use for the base of the joystick.
* [handleImage](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L119) -- a UIImage to use for the handle of the joystick.
* [baseAlpha](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L83) -- opacity of the base of the joystick.
* [handleAlpha](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L90) -- opacity of the handle of the joystick.
* [handleTintColor](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L96) -- optional tint color applied to the joystick image.
* [handleSizeRatio](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L100) -- scaling applied to the joystick handle's image. Note that default is `0.85` due to
  historical reasons.
* [enableDoubleTapForFrameReset](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L123) -- if `movable` is true, allow user to double-tap on view to move base to original
  location.
* [handlePositionMode](https://github.com/bradhowes/Joystick/blob/main/Sources/JoyStickView/JoyStickView.swift#L146) -- when set to `.absolute` (default) the handle will move to the initial (constrained) press location. When set to `.relative` the handle will move only after the touch moves.

# Releases

* v3.2.0 -- Offer code as Swift package in addition to CocoaPod packaging
* v3.1.1 -- Added `handlePositionMode` property to control how handle movements are reported. Default behavior
  is `.absolute`. New `.relative` mode offers finer control at initial touch (thanks to [Michael Tyson](https://github.com/michaeltyson))
* v3.1.0 -- Added `tappedBlock` property (thanks to [Michael Tyson](https://github.com/michaeltyson))
* v3.0.2 -- Fixed too much scaling in `scaleHandleImageView`
* v3.0.1 -- Added support for Obj-C monitor blocks
* v3.0.0 -- Swift 5 (no code changes, only Xcode configury)
* v2.1.2 -- Swift 4.2

# Code

The Xcode workspace contains three components:

- a framework called [JoyStickView](https://github.com/bradhowes/Joystick/tree/master/JoyStickView) (when using CocoaPods `import BRHJoyStickView` instead of `import JoyStickView`)
- a simple iOS application called [JoyStickViewApp](https://github.com/bradhowes/Joystick/tree/master/JoyStickViewApp)
- a playground called [JoyStickView Playground](https://github.com/bradhowes/Joystick/tree/master/JoyStickView%20Playground.playground/Contents.swift)

Both the playground and the app rely on the framework for the JoyStickView UIView.

> :warning: **NOTE**: due to the plumbing for CocoaPods, when editing in Xcode open the workspace **JoyStickView.xcworkspace** instead of the project **JoyStickView.xcodeproj**.

The Xcode playground code sets up the display environemnt and installs two joysticks, one that is fixed (green)
and the other that is movable (yellow). Both joysticks report out their positions in two labels, one for angles and
the other for displacement.

The [JoyStickView.swift](https://github.com/bradhowes/Joystick/tree/master/Sources/JoyStickView/JoyStickView.swift) file defines the joystick view and behavior.
It resides inside the JoyStickView Swift package, and in the BRHJoyStickView framework in CocoaPods. There you will also find a file called
[CoreGraphics+Additions.swift](https://github.com/bradhowes/Joystick/tree/master/Sources/JoyStickView/CoreGraphics+Additions.swift) that contains various
extensions to some CoreGraphics structs that allow for some simplified mathematical expressions in the [JoyStickView](https://github.com/bradhowes/Joystick) code.

By default the [JoyStickView](https://github.com/bradhowes/Joystick/tree/master/Sources/JoyStickView/JoyStickView.swift) class uses two image assets found in the
[Assets](https://github.com/bradhowes/Joystick/tree/master/Sources/JoyStickView/Resources/Assets.xcassets) container.
folder:

* DefaultBase — the image to use for the base of the joystick
* DefaultHandle — the image to use for the handle of the joystick. **Note**: this will be tinted with the `handleTintColor` setting

Both exist in three resolutions for the various iOS devices out today. They were generated using the great [Opacity](http://likethought.com/opacity/) app. The
Opacity documents are included in this repository in the [Resources](https://github.com/bradhowes/Joystick/tree/master/JoyStickViewApp/Resources) directory for
the `JoyStickViewApp` demonstration app.

To use your own images, simple set `baseImage` and/or `handleImage` attributes with the `UIImage` you wish to use.

# Documentation

Please see the [code documentation](https://bradhowes.github.io/Joystick/) for additional information.

# CocoaPods

There is a simple [CocoaPods](https://cocoapods.org) spec file available so you can add the code and resources
by adding "BRHJoyStickView" to your `Podfile` file and import with `import BRHJoyStickView`. Currently everything more or less works, except for the fact
that pointing to image resources via Interface Builder (IB) will result in invalid UImage results because the files won't be
found where IB was able to find them. The only solution is to manually locate those files and set them in your
view loading code. Something like the following should help:

```swift
extension Bundle {

    /**
     Locate an inner Bundle generated from CocoaPod packaging.

     - parameter name: the name of the inner resource bundle. This should match the "s.resource_bundle" key or
       one of the "s.resoruce_bundles" keys from the podspec file that defines the CocoPod.
     - returns: the resource Bundle or `self` if resource bundle was not found
    */
    func podResource(name: String) -> Bundle {
        guard let bundleUrl = self.url(forResource: name, withExtension: "bundle") else { return self }
        return Bundle(url: bundleUrl) ?? self
    }
}
```

In your setup code, you then will need to do something like so:

```swift
    override func viewDidLoad() {
        super.viewDidLoad()
        let bundle = Bundle(for: JoyStickView.self).podResource(name: "BRHJoyStickView")
        joystick.baseImage = UIImage(named: "FancyBase", in: bundle, compatibleWith: nil)
        joystick.handleImage = UIImage(named: "FancyHandle", in: bundle, compatibleWith: nil)
    }
```

The `podResource` method attempts to locate a named inner bundle, defaulting to the original bundle if not found. The
`viewDidLoad` code will then use the right `bundle` object in the UIImage constructors.

Package Metadata

Repository: bradhowes/Joystick

Homepage: https://bradhowes.github.io/Joystick/index.html

Stars: 63

Forks: 20

Open issues: 0

Default branch: main

Primary language: swift

License: MIT

Topics: arcade-controller, cocoapods, ios, joystick, swift, swift-package, swift-playgrounds, uiimageview

README: README.md