LOFixture.h

00001 /*
00002  *
00003  * Copyright (c) 2006, Ben Suffolk <ben@usbdmx.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: LOFixture.h 258 2010-06-07 09:35:39Z ben.suffolk $
00033  *
00034  */
00035 
00036 #import <Cocoa/Cocoa.h>
00037 #import "LOFixtureAttribute.h"
00038 #import "LOColorMixFixtureAttribute.h"
00039 
00040 @class LOFixtureBaseAddress;
00041 @class LOSoftPatch;
00042 @class LOProportionalFixtureAttribute;
00043 @class LOAttributePalette;
00044 
00051 @interface LOFixture : NSObject
00052 {
00053  NSString *name;
00054  NSString *manufacturer;
00055  NSString *comment;
00056  NSMutableArray *baseAddresses;
00057  NSMutableArray *attributes;
00058  LOSoftPatch *softPatch;
00059  
00060  LOFixtureAttribute *attributesByIndex[LOFixtureAttributeIndexSize]; 
00061 }
00062 
00063 
00069 - (id)init;
00070 
00071 
00081 - (id)initWithName:(NSString *)aName andManufacturer:(NSString *)aManufacturer;
00082  
00083  
00091 - (id)initWithXML:(NSXMLElement *)XMLElement;
00092 
00093 
00099 - (NSXMLElement *)XML;
00100 
00101 
00109 - (NSString *)name;
00110 
00111 
00119 - (void)setName:(NSString *)aName;
00120 
00121 
00129 - (NSString *)manufacturer;
00130 
00131 
00139 - (void)setManufacturer:(NSString *)newManufacturer;
00140 
00141 
00149 - (NSString *)comment;
00150 
00151 
00159 - (void)setComment:(NSString *)newComments;
00160 
00161 
00171 - (NSArray *)baseAddresses;
00172 
00173 
00185 - (void)addBaseAddress:(LOFixtureBaseAddress *)aBaseAddress;
00186 
00187 
00199 - (NSArray *)attributes;
00200 
00201 
00211 - (LOFixtureAttribute *)attributeForType:(LOFixtureAttributeType)type;
00212 
00213 
00223 - (NSArray *)attributesForType:(LOFixtureAttributeType)type;
00224 
00225 
00233 - (void)addAttribute:(LOFixtureAttribute *)anAttribute;
00234 
00235  
00249 - (BOOL)setSoftPatch:(LOSoftPatch *)thePatch;
00250  
00251 
00259 - (LOSoftPatch *)softPatch;
00260 
00261 
00276 - (void)updateIntensityValue:(unsigned char)theValue;
00277 
00278 
00287 - (void)applyAttributePalette:(LOAttributePalette *)palette;
00288 
00289 
00290 @end
00291 
00292 
00293 
00294 
00295 
00296 
00297 
00298 
00299 
00300 
00301 
00302 
00303 
00304 
00305 
00306 
00307 
00308 
00309 
00310 
00311 
00312 
00313 
00314