CardPileView.rtf

This is CardPileView.rtf in view mode; [Download] [Up]

CardSet Release 2.1
Modified by Mark Trombino for use with NEXTVegas.

CardPileView

Inherits From: View : Responder : Object

Conforms To: NXDraggingSource (Informal)
NXDraggingDestination

Declared In: CardPileView.h

Class Description

Instances of this class provide a visual representation of a pile of cards. CardPileView uses CardPile as the underlying representation, but adds a visual aspect and user interaction. Users can click on CardPileViews and drag cards from one view to another. The decisions on when this is allowed and what happens as a result are left to the CardPileView's delegate.

Dragging cards between applications is disabled by default. It can be enabled by subclassing and overriding draggingSourceOperationMaskForLocal:.

Notifying the CardPileView Object's Delegate

The logic of a card game is primarily implemented through the delegate mechanism. The delegate has the option of implementing the following methods:

clickedCard:in:
doubleClickedCard:in:
draggedPile:from:
canAcceptPile:from:in:
acceptPile:in:
removedPile:from:
getOffset::

Knowing the sequence in which these delegate messages are sent is critical in using the CardSet objects to create card games. If there is no delegate (or the delegate does not implement the above methods) the cards on a pile may not be dragged, flipped, or have cards dropped on them.

When the user single clicks on a CardPileView, the message clickedCard:aCard in:aCardPileView is sent to the delegate. Note that the parameter aCard will be nil if the pile was empty, or if the user clicked in an area of the pile where there is no Card displayed. This message is sent even if the user keeps holding down the mouse button (ie. dragging) after clicking.

If the user holds down the mouse button, and is pointing at a Card, the delegate receives the message draggedPile:aCardPile from:aCardPileView. aCardPile is a temporary pile containing the Card that the user clicked on. The delegate may add additional cards to this pile, if desired. This would typically be done in games where the user can click on a card part-way down a deck, and drag that card and all the cards above it. The delegate is responsible for adding the cards above the clicked card to aCardPile.

If draggedPile:from: returns YES, CardPileView performs the dragging animation with the cards on the temporary CardPile. If the user releases the dragged pile on any CardPileView (other than the source pile), that CardPileView's delegate receives the canAcceptPile:dropPile from:sender in:cardPileView message, where dropPile is the pile that wants to be dropped, cardPileView is the pile receiving the cards, and sender is the CardPileView that the cards were dragged from If this method returns NO, the dragged cards return to the source pile.

If a CardPileView agrees to accept some dragged cards, they are automatically added to that pile. Then the delegate receives the acceptPile:dropPile in:self message, which lets the pile know which cards were added to it. Note that the dropped cards are, at this point, on both the original pile (where the cards were dragged from), and on the pile that they have been dropped on.

The cards are now removed from the original CardPileView, and its delegate receives the removePile:aCardPile from:aCardPileView message.

The getOffset:: message allows the delegate to control the amount of stagger that the deck has when it draws.

Instance Variables

float xOffset, yOffset;
id cardPile;
id dragCardPile;
BOOL useDragCardPile;
id delegate;
int delegateFlags;
int tag;
NXColor backgroundColor;
float backgroundGray;
BOOL drawOutline;
BOOL coversOthers;
id coverPile1;
id coverPile2;
id coverPile3;
id coverPile4;
id beneath;

xOffset, yOffset The current drawing offset between cards.

cardPile The CardPile holding all the cards.

dragCardPile Used internally for dragging cards.

useDragCardPile Used internally for dragging cards.

delegate The object's delegate.

delegateFlags Used internally.

tag The pile's tag.

backgroundColor Background color.

backgroundGray Background color on 2-bit monochrome displays.

drawOutline Controls display of CardPileView outline.

coversOthers YES if this pile overlaps other piles.

coverPile1 A CardPileView overlapped by this pile.

coverPile2 A CardPileView overlapped by this pile.

coverPile3 A CardPileView overlapped by this pile.

coverPile4 A CardPileView overlapped by this pile.

beneath NXImage used internally.

Adopted Protocols

NXDraggingSource (Informal) - draggingSourceOperationMaskForLocal:
- draggedImage:beganAt:
- draggedImage:endedAt:deposited:

NXDraggingDestination - prepareForDragOperation:
- draggingEntered:
- performDragOperation:

Method Types

Initializing the class + initialize

Creating and freeing � free
� initFrame:

Managing related objects - cardPile
� delegate
� setDelegate:

Displaying the CardPileView - backgroundColor
� drawSelf::
� setBackgroundColor:
� setCardSize:
� setDrawOutline:
� setUseShoe:
� willDrawOutline

Overlapping CardPileViews - pileCovered:
� pileCoveredBy:
� resetBacking:
� setCoverPile:to:
� setCoversOthers:

Responder methods - mouseDown:

Utility methods - drawDragCard:
� findCardAt:thePoint
� getRect:forCard:
� setTag:
� tag

Class Methods

initialize
+ initialize

Initializes the class object. Returns self.