LOLightCue.h

00001 /*
00002  *
00003  * Copyright (c) 2006, Michael Swan <michaelswan@mac.com>
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without 
00007  * modification, are permitted provided that the following conditions are met:
00008  *
00009  * 1. Redistributions of source code must retain the above copyright notice,
00010  *    this list of conditions and the following disclaimer.
00011  *
00012  * 2. Redistributions in binary form must reproduce the above copyright notice,
00013  *    this list of conditions and the following disclaimer in the documentation
00014  *    and/or other materials provided with the distribution.
00015  *
00016  * 3. Neither the name of the usbdmx.com web site nor the names of its 
00017  *    contributors may be used to endorse or promote products derived from this
00018  *    software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
00021  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
00022  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
00023  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
00024  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
00025  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
00026  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
00029  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030  * POSSIBILITY OF SUCH DAMAGE.
00031  *
00032  * $Id: LOChannel.h 88 2006-08-13 15:02:12Z ben.suffolk $
00033  *
00034  */
00035 
00036 #import <Cocoa/Cocoa.h>
00037 
00038 @class LOScene;
00039 @class LOCueManager;
00040 
00041 #define LOCueDidUpdateTrackingModeNotification @"LOCueDidUpdateTrackingModeNotification"
00042 #define LOCueDidUpdateNumberNotification @"LOCueDidUpdateNumberNotification"
00043 #define LOCueDidUpdateSceneNotification @"LOCueDidUpdateSceneNotification"
00044 #define LOCueDidUpdateNotification @"LOCueDidUpdateNotification"
00045 
00046 
00052 @interface LOLightCue : NSObject <NSCoding>
00053 {
00054         float           cueNumber;     
00055         float           cueUpTime;     
00056         float           cueDownTime;   
00057         float           cueLink;       
00058         float           cueFollow;     
00059  BOOL   isTracking;      
00060         NSString        *cueName;
00061         NSString        *cueComment;
00062         LOScene         *scene;      
00063  LOCueManager *cueManager; 
00064 }
00065 
00066 
00079 - (id)init;
00080 
00081 
00095 - (id)initWithCueManager:(LOCueManager *)theManager;
00096 
00097 
00111 - (id)initWithCueManagerForName:(NSString *)theName;
00112 
00113 
00121 - (id)initWithXML:(NSXMLElement *)XMLElement andCueManager:(LOCueManager *)theManager;
00122 
00123 
00142 - (NSXMLElement *)XML;
00143 
00144 
00145 //setters
00151 - (void) setScene:(LOScene *)aScene;
00152 
00158 - (void) setCueName:(NSString *)aName;
00159 
00172 - (BOOL) setCueNumber:(float)aNumber;
00173 
00179 - (void) setCueUpTime:(float)anUpTime; 
00180 
00186 - (void) setCueDownTime:(float)aDownTime;
00187 
00193 - (void) setCueLink:(float)aLink;
00194 
00200 - (void) setCueFollow:(float)aFollow;
00201 
00207 - (void) setCueComment:(NSString *)aComment;
00208 
00209 
00210 //getters
00216 - (LOScene *) scene;
00217 
00218 
00224 - (LOCueManager *)cueManager;
00225 
00226 
00232 - (float) cueNumber;
00233 
00239 - (NSString *) cueName;
00240 
00246 - (float) cueUpTime;
00247 
00253 - (float) cueDownTime;
00254 
00260 - (float) cueLink;
00261 
00267 - (float) cueFollow;
00268 
00274 - (NSString *) cueComment;
00275 
00276 
00284 - (BOOL)isTracking;
00285 
00286 
00299 - (void)setTracking:(BOOL)tracking;
00300 
00301 
00302 @end