LOLightCue Class Reference

A simple storage class for light cues. More...

#import <LOLightCue.h>

Public Member Functions
(id)	- init
	Initilise with the default cue manager.
(id)	- initWithCueManager:
	Initilise with a specific cue manager.
(id)	- initWithCueManagerForName:
	Initilise with the cue manager for a given name.
(id)	- initWithXML:andCueManager:
	Initilise with an XML Element.
(NSXMLElement *)	- XML
	Get the Scene details as XML.
(void)	- setScene:
	Sets the scene which holds the channel levels.
(void)	- setCueName:
	Sets the cue name.
(BOOL)	- setCueNumber:
	Sets the cue number.
(void)	- setCueUpTime:
	Sets the up fade time for the cue.
(void)	- setCueDownTime:
	Sets the down fade time for the cue.
(void)	- setCueLink:
	Sets the cue number the cue links to nil = no link.
(void)	- setCueFollow:
	Sets delay before next cue auto fires nil = no follow.
(void)	- setCueComment:
	Sets the comments field.
(LOScene *)	- scene
	returns the scene which holds the channel levels
(LOCueManager *)	- cueManager
	Get the cue manager.
(float)	- cueNumber
	retrive the cue number
(NSString *)	- cueName
	retrive the cue name
(float)	- cueUpTime
	retrive the cue up fade time
(float)	- cueDownTime
	retrive the cue down fade time
(float)	- cueLink
	retrive the cue number that cue links to
(float)	- cueFollow
	retrive the cue follow time if any
(NSString *)	- cueComment
	retrive the cue comments
(BOOL)	- isTracking
	Check to see if a cue is a tracking cue.
(void)	- setTracking:
	Set is a cue is a tracking cue.
Protected Attributes
float	cueNumber
	The actual cue number.
float	cueUpTime
	Seconds for this cue to fade in.
float	cueDownTime
	Seconds to fade out the previous cue.
float	cueLink
	Optional next cue (used to skip other cues).
float	cueFollow
	Optional number of seconds before the next cue automatically runs (starting when this cue is complete).
BOOL	isTracking
	True if the cue is a tracking cue.
NSString *	cueName
NSString *	cueComment
LOScene *	scene
	The scene associated with the cue.
LOCueManager *	cueManager
	The cue manager that this cue is using.

---

Detailed Description

A simple storage class for light cues.

---

Member Function Documentation

- (NSString *) cueComment

retrive the cue comments

- (float) cueDownTime

retrive the cue down fade time

- (float) cueFollow

retrive the cue follow time if any

- (float) cueLink

retrive the cue number that cue links to

- (LOCueManager *) cueManager

Get the cue manager.

- (NSString *) cueName

retrive the cue name

- (float) cueNumber

retrive the cue number

- (float) cueUpTime

retrive the cue up fade time

- (id) init

Initilise with the default cue manager.

After initilisation the cueNumber will be auto set by the cue manager but can be changed.

See also:

- initWithCueManager:

- initWithCueManagerForName:

- setCueNumber:

- (id) initWithCueManager:

(LOCueManager *)

theManager

Initilise with a specific cue manager.

After initilisation the cueNumber will be auto set by the cue manager but can be changed.

Parameters:

theManager

The cue manager, or nil to use the default cue manager

See also:

- initWithCueManagerForName:

- setCueNumber:

- (id) initWithCueManagerForName:

(NSString *)

theName

Initilise with the cue manager for a given name.

After initilisation the cueNumber will be auto set by the cue manager but can be changed.

Parameters:

theName

The name of the cue manager, or nil to use the default cue manager

See also:

- initWithCueManager:

- setCueNumber:

- (id) initWithXML:		(NSXMLElement *)	XMLElement
andCueManager:		(LOCueManager *)	theManager

Initilise with an XML Element.

See also:

- XML:

- (BOOL) isTracking

Check to see if a cue is a tracking cue.

See also:

- setTracking:

- (LOScene *) scene

returns the scene which holds the channel levels

- (void) setCueComment:

(NSString *)

aComment

Sets the comments field.

- (void) setCueDownTime:

(float)

aDownTime

Sets the down fade time for the cue.

- (void) setCueFollow:

(float)

aFollow

Sets delay before next cue auto fires nil = no follow.

- (void) setCueLink:

(float)

aLink

Sets the cue number the cue links to nil = no link.

- (void) setCueName:

(NSString *)

aName

Sets the cue name.

- (BOOL) setCueNumber:

(float)

aNumber

Sets the cue number.

If you try and set the cue number to a cue numebr that already exists in the cue manager being used by this cue then NO will be returned and the cue will be removed from the cue manager.

Returns:

YES if the cue number could be set.

- (void) setCueUpTime:

(float)

anUpTime

Sets the up fade time for the cue.

- (void) setScene:

(LOScene *)

aScene

Sets the scene which holds the channel levels.

- (void) setTracking:

(BOOL)

tracking

Set is a cue is a tracking cue.

The default state of a cue willd ependon the default tracking mode for its CueManager.

Posts a LOCueDidUpdateTrackingModeNotification when complete

Parameters:

tracking

YES if the cue is a traacking cue.

See also:

isTracking

- (NSXMLElement *) XML

Get the Scene details as XML.

 <cue number="x.xxx" name="">
  <up time="x.xxx"/>
  <down time="x.xxx">
  <link cue="x.xxx"/>
  <follow time="x.xxx"/>
  <comment> comment string </comment>
  <scene number="x"/>
 </cue>

Returns:

The XML Representation of the scene

---

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

• LOLightCue.h
• LOLightCue.m