Source/BitHolder.h
author Jens Alfke <jens@mooseyard.com>
Thu Jul 17 13:29:04 2008 -0700 (2008-07-17)
changeset 19 3b750982ff39
parent 10 6c78cc6bd7a6
permissions -rw-r--r--
Don't load Checkers sound files till a game is displayed on a board; this speeds up launch.
     1 /*  This code is based on Apple's "GeekGameBoard" sample code, version 1.0.
     2     http://developer.apple.com/samplecode/GeekGameBoard/
     3     Copyright © 2007 Apple Inc. Copyright © 2008 Jens Alfke. All Rights Reserved.
     4 
     5     Redistribution and use in source and binary forms, with or without modification, are permitted
     6     provided that the following conditions are met:
     7 
     8     * Redistributions of source code must retain the above copyright notice, this list of conditions
     9       and the following disclaimer.
    10     * Redistributions in binary form must reproduce the above copyright notice, this list of
    11       conditions and the following disclaimer in the documentation and/or other materials provided
    12       with the distribution.
    13 
    14     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
    15     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 
    16     FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRI-
    17     BUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    18     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
    19     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
    20     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
    21     THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    22 */
    23 #import "GGBLayer.h"
    24 @class Bit;
    25 
    26 
    27 /** Protocol for a layer that acts as a container for Bits. */
    28 @protocol BitHolder <NSObject>
    29 
    30 /** Current Bit, or nil if empty */
    31 @property (retain) Bit* bit;
    32 
    33 /** Sets current Bit to nil, triggering its "destroy" animation */
    34 - (void) destroyBit;
    35 
    36 /** Conveniences for comparing self.bit with nil */
    37 @property (readonly, getter=isEmpty) BOOL empty;
    38 
    39 /** BitHolders will be highlighted while the target of a drag operation */
    40 @property BOOL highlighted;
    41 
    42 /** An uninterpreted integer that the Game can use for its own purposes. */
    43 @property NSInteger tag;
    44 
    45 
    46 /** Tests whether the bit is allowed to be dragged out of me.
    47     Returns the input bit, or possibly a different Bit to drag instead, or nil if not allowed.
    48     Either -cancelDragBit: or -draggedBit:to: must be called next. */
    49 - (Bit*) canDragBit: (Bit*)bit;
    50 
    51 /** Cancels a pending drag (begun by -canDragBit:). */
    52 - (void) cancelDragBit: (Bit*)bit;
    53 
    54 /** Called after a drag finishes. */
    55 - (void) draggedBit: (Bit*)bit to: (id<BitHolder>)dst;
    56 
    57 
    58 /** Tests whether the bit is allowed to be dropped into me.
    59     Either -willNotDropBit: or -dropBit:atPoint: must be called next. */
    60 - (BOOL) canDropBit: (Bit*)bit atPoint: (CGPoint)point;
    61 
    62 /** Cancels a pending drop (after -canDropBit:atPoint: was already called.) */
    63 - (void) willNotDropBit: (Bit*)bit;
    64 
    65 /** Finishes a drop. */
    66 - (BOOL) dropBit: (Bit*)bit atPoint: (CGPoint)point;
    67 
    68 @end
    69 
    70 
    71 /** A basic implementation of the BitHolder protocol. */
    72 @interface BitHolder : GGBLayer <BitHolder>
    73 {
    74     @protected
    75     Bit *_bit;
    76     BOOL _highlighted;
    77     NSInteger _tag;
    78 }
    79 
    80 @end