WHPlayingCardImageKit

A swift package to make 52 playing card images for a given scale factor.

Requirements

• iOS 10.0+
• macOS 10.11+

Features

• The card images can be created scaled.
• A card back image can be created scaled.
• All card images can be created in the background.
• The package is cross platform.

Installation

To install the WHPlayingCardImageKit package, use the following guidelines of Apple to add package dependency to your Xcode project.

To add a package dependency to your Xcode project, select File > Add Packages and enter its repository URL. You can also navigate to your target’s General pane, and in the “Frameworks, Libraries, and Embedded Content” section, click the + button, select Add Other, and choose Add Package Dependency.

You can also navigate to your project’s pane, select “Package Dependencies”, click the + button, enter the repository URL into the Search field, and choose Add Package Dependency.

Usage examples

Create one card image

import SpriteKit
import WHPlayingCardImageKit
import WHCrossPlatformKit

func createCardImageQS() -> WHImage {
    let defaultCardSize = CardImageAtlas.cardImageAtlasDefaultCardSize
    let scaleFactor:CGFloat = 2.5
    let fullCardImageMaker = FullCardImageMaker(defaultCardSize: defaultCardSize, scaleFactor: scaleFactor)
    let cardImageQS = fullCardImageMaker.makeCardImageFor(rank: .queen, suit: .spades)
    return cardImageQS
}

Create a pinochle deck and its card images

import SpriteKit
import WHPlayingCardImageKit
import WHCrossPlatformKit

func createPinochleDeck() -> [Card] {
    var pinochleDeck:[Card] = []
    let pinochleRanks:[Rank] = [.nine, .jack, .queen, .king, .ten, .ace]
    for packId in 0 ..< 2 {
        for suit in Suit.all4Suits {
            for rank in pinochleRanks {
                let card = Card(rank: rank, suit: suit, packId: packId)
                pinochleDeck.append(card)
            }
        }
    }
    return pinochleDeck
}

// Create an atlas of card images keyed by card name.
// Note only 24 images are created.
// The same card from different packs can share the same common card image.
func createPinochleCardImageAtlas(pinochleDeck: [Card], scaleFactor: CGFloat) -> Dictionary<String, WHImage> {
    var pinochleCardImageAtlas:[String: WHImage] = [:]
    let defaultCardSize = CardImageAtlas.cardImageAtlasDefaultCardSize
    let fullCardImageMaker = FullCardImageMaker(defaultCardSize: defaultCardSize, scaleFactor: scaleFactor)
    for card in pinochleDeck {
        if card.packId == 0 {
            let cardImage = fullCardImageMaker.makeCardImageFor(rank: card.rank, suit: card.suit)
            pinochleCardImageAtlas[card.name] = cardImage
        }
    }
    return pinochleCardImageAtlas
}

Create one card back image

import SpriteKit
import WHPlayingCardImageKit
import WHPlayingCardKit
import WHCrossPlatformKit

// Note: Cards can share the same card back image.
func createCardBackImage(cardSize: CGSize) -> WHImage {
    let cardBackImage = CardBackImage.makeCardBackImage(cardSize: cardSize, fillColor: .blue, backgroundColor: .white)
    return cardBackImage
}

Load card images in the background

import SpriteKit
import WHCrossPlatformKit
import WHPlayingCardImageKit

class GameViewController: NSViewController {

    @IBOutlet weak var mainView:SKView!
    
    var isUseFullCardImage = false // Note: will obtain value from settings

    override func viewDidLoad() {
        super.viewDidLoad()
        mainView.showsFPS = true
        mainView.showsNodeCount = true

        setViewFrameSize()

        let isUseFullCardImage = true // Note: should obtain value from settings

        let gameSceneSize = view.frame.size
        let defaultCardSize = CardImageAtlas.cardImageAtlasDefaultCardSize
        let gameSceneScaler = GameSceneScaler(size: gameSceneSize, defaultCardSize: defaultCardSize)
        let gameScene = GameScene(size: gameSceneSize, gameSceneScaler: gameSceneScaler, isUseFullCardImage: isUseFullCardImage)

        do {
            let cards = gameScene.deck
            let defaultCardSize = gameSceneScaler.defaultCardSize
            let scaleFactor = gameSceneScaler.scaleFactor
            gameScene.cardImageAtlas.backgroundLoadCardImages(cards: cards, defaultCardSize: defaultCardSize, scaleFactor: scaleFactor)
        }

        // Present the scene
        mainView.presentScene(gameScene)
    }
}

extension GameViewController {

    fileprivate func setViewFrameSize() {
        let screenSize = NSScreen.getScreenSize()
        ...
    }
}

Documentation

You can create the current documentation for this package in Xcode by selecting ‘Build Documentation’ from the ‘Product’ menu item.