GeekGameBoard: An Objective-C repository from cherifya

#GeekGameBoard

Originally by Jens Alfke
Git port by Cherif Yaya

GeekGameBoard is an example of using Core Animation to present the user interface of a board or card game. It implements a small framework for implementing such games, with domain-specific classes like "Grid" and "Piece", and examples of several game definitions built on top of the framework.

Some of the generally-useful Core Animation techniques illustrated are:

Hit testing
Dragging CALayers with the mouse
Loading images from files and setting them as layer contents
3D "card-flip" animations

##History

I wrote GeekGameBoard in 2007 while at Apple, which published it as sample code. Apple's sample code license allows unrestricted use of the source code, requiring only that you keep their copyright notice in an unmodified distribution.

I am no longer employed by Apple. To encourage further development of this framework, in March 2008 I created this open source project (under a BSD license) based on a slightly-evolved version of the published sample code.

1.0: Original Apple sample code release (12/19/2007)
2.0: First open source release. (Major version number bumped to avoid conflict with any future Apple revisions.) No longer requires garbage collection. Fixed some memory leaks of CG objects. Fixed a bug when advancing to the 8th row in the Checkers game. (3/7/2008)

##Project Description

####Important Classes

A Bit is a moveable object in a game, either a __Card __ or a Piece.
A BitHolder is a container for Bits; they can be dragged into and/or out of it. Typical BitHolders are GridCells (the squares/hexes in a board), __Deck__s or __Stack__s of cards, and __Dispenser__s (supplies of new pieces.)
A Grid is a regular arrangement of GridCells; rectangular and hex grids are implemented.
BoardView is the NSView whose layer hosts all of the above. It also tracks mouse events so the user can drag Bits.
Game represents the rules of a particular game. It sets up the pieces/cards/grids that make up the game, decides which moves are legal, keeps track of whose turn it is, and decides when someone's won.
Player is a passive object that represents one of the players in a Game.

####Class Hierarchy

(Underlined classes are from external frameworks; italic classes are abstract.)

CALayer
	Bit
		Card
			PlayingCard
		DraggedStack
		Piece
			DiscPiece
	BitHolder*
		GridCell
			Hex
			Square
				GoSquare
		Deck
		Dispenser
		Stack
	Grid
		HexGrid
		RectGrid

NSView
	BoardView

NSObject
	Game
		TicTacToeGame (etc...)
	Player

*BitHolder is actually both a protocol, and a class that implements the protocol. I've combined them here, for simplicity.

####Related Information

Apple's original GeekGameBoard sample code
Core Animation Programming Guide
Quartz 2D Programming Guide: Creating Images
Quartz 2D Programming Guide: Patterns
Quartz 2D Programming Guide: Paths

cherifya/GeekGameBoard