LOFixtureAttribute.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: LOFixtureAttribute.h 258 2010-06-07 09:35:39Z ben.suffolk $
00033  *
00034  */
00035 
00036 #import <Cocoa/Cocoa.h>
00037 
00038 
00039 @class LOFixture;
00040 @class LOFixtureRange;
00041 @class LOFixtureBaseAddress;
00042 
00043 
00044 typedef enum LOFixtureAttributeType
00045               {
00046               LOFixtureAttributeTypeProportional = 0,
00047               LOFixtureAttributeTypeIntensity,
00048               LOFixtureAttributeTypePalette,
00049               LOFixtureAttributeTypeMovement,
00050               LOFixtureAttributeTypeColorMix,
00051               LOFixtureAttributeTypeColorWheel
00052               } LOFixtureAttributeType;
00053 
00054 
00055 typedef enum LOFixtureAttributeIndex
00056               {
00057                LOFixtureAttributeIndexUnknown = -1,  
00058                LOFixtureAttributeIndexIntensity,     
00059                LOFixtureAttributeIndexColorMix,
00060                LOFixtureAttributeIndexSize           
00061               } LOFixtureAttributeIndex;
00062 
00063 
00064 
00075 @interface LOFixtureAttribute : NSObject
00076 {
00077  NSString *name;
00078  LOFixtureAttributeType type;
00079  LOFixtureAttributeIndex fixtureAttributeIndex;
00080  
00081  LOFixture *fixture; 
00082  LOFixtureRange *dependantRange; 
00083 }
00084 
00085 
00091 - (id)initWithName:(NSString *)aName andType:(LOFixtureAttributeType)aType;
00092 
00093 
00099 - (id)initWithXML:(NSXMLElement *)XMLElement withinFixture:(LOFixture *)theFixture;
00100 
00101 
00107 + (id)attributeFromXML:(NSXMLElement *)XMLElement  withinFixture:(LOFixture *)theFixture;
00108 
00109 
00115 - (NSXMLElement *)XML;
00116 
00117 
00126 - (NSString *)name;
00127 
00128 
00136 - (void)setName:(NSString *)aName;
00137 
00138 
00146 - (LOFixtureAttributeType)type;
00147 
00148 
00158 - (LOFixtureAttributeIndex)fixtureAttributeIndex;
00159 
00160 
00170 - (void)setFixtureAttributeIndex:(LOFixtureAttributeIndex)anIndex;
00171 
00172 
00178 - (void)setFixture:(LOFixture *)aFixture;
00179 
00180 
00188 - (void)setDepends:(LOFixtureRange *)theDependantRange;
00189 
00190 
00201 - (BOOL)updateOutputWithObject:(id)anObject;
00202 
00203 
00204 
00217 - (BOOL)updateOutputToValue:(unsigned)theValue;
00218 
00219 
00220 @end
00221 
00222 
00223 
00224 
00225 
00226 
00227 
00228 
00229 
00230 
00231 
00232 
00233 
00234 
00235 
00236 
00237 
00238 
00239 
00240 
00241 
00242 
00243