LOFixturePaletteEntry Class Reference

A palette entry is a names set of ranges. More...

#import <LOFixturePaletteEntry.h>

Public Member Functions
(id)	- initWithName:
	Iniilise the palette entry with a name and no entries.
(id)	- initWithXML:withinFixture:
	Initilise the palette entry from the XML Element.
(NSXMLElement *)	- XML
	Return the palette entry defintion as an XML element.
(NSString *)	- name
	Get the name of palette entry.
(void)	- setName:
	Set the name of palette entry.
(LOFixturePaletteData *)	- data
	Get the assocaited data for this entry.
(void)	- setData:
	Set the associated data for this entry.
(NSArray *)	- ranges
	Get the ranges.
(void)	- addRange:
	Add a range into the palette entry.
(unsigned)	- count
	Get the number of ranges in the palette entry.
(LOFixtureRange *)	- rangeAtIndex:
	Get a range at a specific index.
Protected Attributes
NSString *	name
NSMutableArray *	ranges
	Array of LOFixtureRange.
LOFixturePaletteData *	data
	Assocaited palette data, such as a colour definition.

---

Detailed Description

A palette entry is a names set of ranges.

---

Member Function Documentation

- (void) addRange:

(LOFixtureRange *)

aRange

Add a range into the palette entry.

See also:

ranges:

- rangeAtIndex:

- (unsigned) count

Get the number of ranges in the palette entry.

- (LOFixturePaletteData *) data

Get the assocaited data for this entry.

See also:

- setData:

- (id) initWithName:

(NSString *)

theName

Iniilise the palette entry with a name and no entries.

- (id) initWithXML:		(NSXMLElement *)	XMLElement
withinFixture:		(LOFixture *)	theFixture

Initilise the palette entry from the XML Element.

- (NSString *) name

Get the name of palette entry.

See also:

- setName:

- (LOFixtureRange *) rangeAtIndex:

(int)

index

Get a range at a specific index.

Parameters:

index

The index (zero indexed)

See also:

ranges:

- addRange:

- (NSArray *) ranges

Get the ranges.

Returns:

an array of LOFixtureRange

See also:

- addRange:

- count:

- rangeAtIndex:

- (void) setData:

(LOFixturePaletteData *)

theData

Set the associated data for this entry.

See also:

data:

- (void) setName:

(NSString *)

aName

Set the name of palette entry.

See also:

name:

- (NSXMLElement *) XML

Return the palette entry defintion as an XML element.

 <entry name="name">
  <range base="name" offset="x" type="block|proportional|single" start="x" end="x" [startName="name"] [endName="name"]/>
  ...
  <data>
   ...
  </data>
 </entry>   

---

The documentation for this class was generated from the following files:

• LOFixturePaletteEntry.h
• LOFixturePaletteEntry.m