Light Forge Wiki - New pages [en]

Sample Addons

2013-05-09T23:22:47Z

Chris Monson: /* Lamps On */

=Select Children=

This script will get a list of all the groups that you currently have selected and then it will select all of their child groups and deselect the parent.

<syntaxhighlight lang="python">
#called when the addon is selected in the addon's menu
def onExecute():
#get list of selected groups
groupList = api.groups.getSelectedGroups()

if groupList != None:
for group in groupList:
selectChildren(group)

#select all the children for a given group
def selectChildren(groupPath):
childCount = api.groups.getChildCount(groupPath)

if childCount > 0:
api.groups.deselectGroup(groupPath)

for i in range(0, childCount):
#build the group path for the next group
newPath = groupPath
if len(newPath) == 0:
newPath = str(i)
else:
newPath = newPath + "," + str(i)
#select group
api.groups.selectGroup(newPath)
</syntaxhighlight>

=Lamps On=
This addon allows you to specify a list of profile names and the value that the lamp channel must be assigned to in order to strike the lamp for that particular fixture. This addon runs automatically on startup asking if you'd like to turn the lamps on.

This example is a little more complicated, utilizing file operations for saving and loading settings, asynchronous processing, as well as using Windows Forms for dialog boxes to adjust the addon's settings in Lightforge. The bulk of the code is devoted to setting up the forms and laying out controls for the dialog boxes.

<syntaxhighlight lang=python>
import clr
clr.AddReference("System.Drawing")
clr.AddReference("System.Windows.Forms")
from System.Drawing import Point
from System.Windows.Forms import Application, Button, ListView, ListViewItem, View, Form, ContextMenu, TextBox, NumericUpDown, Label
from System.Windows.Forms import MessageBox, MessageBoxButtons
from System.Windows.Forms import FormBorderStyle, DialogResult

profilesAndValues = []

#called when the script is loaded
def onInitialize():
load()

#called when the script settings are edited in the script settings dialog
def onEdit():
dlg = LampOnDialog()
if dlg.ShowDialog() == DialogResult.OK:
save()

#executes asyncronously when clicked from the Lightforge interface
def onExecuteAsync():
onStartupAsync()

#called as Lightforge is starting up
def onStartupAsync():
global profilesAndValues
if MessageBox.Show("Would you like to turn lamps on?", "Lamp Startup", MessageBoxButtons.YesNo) == DialogResult.Yes:
print("")
print("Turning Lamps On")

#find profiles that match those in our profilesAndValues list and set values appropriately
findProfiles("", profilesAndValues)

#wait 5 seconds to allow the fixtures to process the command
print("Waiting...")
api.wait(5)

#release the rig to remove the changes we made
print("Releasing Fixtures")
api.groups.releaseGroup("")

#Search through rig to find the specified profiles and assign them the given values
def findProfiles(groupPath, profileList):
currentPath = groupPath

#step through all children of the current group
for i in range(0, api.groups.getChildCount(currentPath)):
#build the group path for the next group
if len(currentPath) == 0:
currentPath = str(i)
else:
currentPath = groupPath + "," + str(i)

found = False

#step through all the profiles we've listed to see if this fixture's profile matches any of them
for prf in profileList:
if prf[0] in api.groups.getProfileName(currentPath):
#set the value of this fixture to the value in the profile list
api.groups.setAttribute(api.attributeTypes.lamp, int(prf[1]) * 256, currentPath)
found = True

#call this function on the tested group to work recursively through the groups
if found == False and api.groups.getChildCount(currentPath) > 0:
findProfiles(currentPath, profileList)

#Save settings to file
def save():
global profilesAndValues
strOutput = ""
for prf in profilesAndValues:
strOutput += prf[0] + ";" + str(prf[1]) + "\n"

f = open(addon.getDirectory() + "Lamps On.settings", "w+")
f.write(strOutput)
f.close()

#Load settings in from file
def load():
global profilesAndValues
profilesAndValues = []
try:
f = open(addon.getDirectory() + "Lamps On.settings", "r+")
for line in f:
profilesAndValues.append(line.rstrip().split(';'))
f.close()
except:
pass

#Dialog box for assigning values to profiles
class LampOnDialog(Form):

def __init__(self):
global profilesAndValues
self.Text = 'Lamp On Settings'
self.FormBorderStyle = FormBorderStyle.FixedDialog
self.MinimizeBox = False
self.MaximizeBox = False

margin = 10

#Cancel Button
btnCancel = Button()
btnCancel.Text = "Cancel"
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))
btnCancel.Click += self.clickCancel
self.Controls.Add(btnCancel)

#Ok Button
btnOk = Button()
btnOk.Text = "Ok"
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))
btnOk.Click += self.clickOk
self.Controls.Add(btnOk)

#List Box
self.lstProfiles = ListView()
self.lstProfiles.Location = Point(margin, margin)
self.lstProfiles.Width = self.ClientRectangle.Width - (margin * 2)
self.lstProfiles.Height = btnOk.Top - (margin * 2)
self.Controls.Add(self.lstProfiles)
self.lstProfiles.View = View.Details
self.lstProfiles.Columns.Add("Profile")
self.lstProfiles.Columns.Add("Value")
self.lstProfiles.Columns[0].Width = self.lstProfiles.Width * 0.7
self.refreshList()

#Context Menu
listContext = ContextMenu()
listContext.MenuItems.Add("Add Profile")
listContext.MenuItems[0].Click += self.addProfile
listContext.MenuItems.Add("Edit")
listContext.MenuItems[1].Click += self.editProfile
listContext.MenuItems.Add("Remove")
listContext.MenuItems[2].Click += self.removeProfile
self.lstProfiles.ContextMenu = listContext

#reload the profilesAndValues data into the ListView control
def refreshList(self):
global profilesAndValues
self.lstProfiles.Items.Clear()
for prf in profilesAndValues:
lvItem = ListViewItem(prf[0])
lvItem.SubItems.Add(str(prf[1]))
self.lstProfiles.Items.Add(lvItem)

#handle Ok button click
def clickOk(self, sender, args):
self.DialogResult = DialogResult.OK
self.Close

#handle Cancel button click
def clickCancel(self, sender, args):
self.DialogResult = DialogResult.Cancel
self.Close

#add profile called from the context menu
def addProfile(self, sender, args):
global profilesAndValues
dlg = ProfileValueDialog("",0)
if dlg.ShowDialog() == DialogResult.OK:
profilesAndValues.append([dlg.profile,dlg.value])
self.refreshList()

#remove profile called from the context menu
def removeProfile(self, sender, args):
global profilesAndValues
if self.lstProfiles.SelectedIndices.Count > 0:
profilesAndValues.pop(self.lstProfiles.SelectedIndices[0])
self.refreshList()

#edit profile called from the context menu
def editProfile(self, sender, args):
global profilesAndValues
if self.lstProfiles.SelectedIndices.Count > 0:
index = self.lstProfiles.SelectedIndices[0]
dlg = ProfileValueDialog(profilesAndValues[index][0],profilesAndValues[index][1])
if dlg.ShowDialog() == DialogResult.OK:
profilesAndValues[index] = [dlg.profile,dlg.value]
self.refreshList()

#Dialog box for assigning values to profiles
class ProfileValueDialog(Form):

profile = ""
value = 0

def __init__(self, profileName, lampValue):
global profilesAndValues
self.Text = 'Profile Value Dialog'
self.FormBorderStyle = FormBorderStyle.FixedDialog
self.MinimizeBox = False
self.MaximizeBox = False

margin = 10

self.Width = 350
self.Height = 150

#Label
lblPrompt = Label()
lblPrompt.Text = "Enter profile name and 8 bit value for lamp on."
lblPrompt.Location = Point(margin, margin)
lblPrompt.Width = self.Width
self.Controls.Add(lblPrompt)

#Text Box
self.txtProfile = TextBox()
self.txtProfile.Location = Point(margin, margin * 4)
self.txtProfile.Text = profileName
self.txtProfile.Width = 200
self.Controls.Add(self.txtProfile)

#NumericUpDown
self.numValue = NumericUpDown()
self.numValue.Maximum = 255
self.numValue.Value = lampValue
self.numValue.Location = Point(self.txtProfile.Right + margin, self.txtProfile.Top)
self.numValue.Width = (self.Width - margin) - (self.txtProfile.Right + (margin * 3))
self.Controls.Add(self.numValue)

#Cancel Button
btnCancel = Button()
btnCancel.Text = "Cancel"
btnCancel.Location = Point(self.ClientRectangle.Right - (btnCancel.Width + margin), self.ClientRectangle.Bottom - (btnCancel.Height + margin))
btnCancel.Click += self.clickCancel
self.Controls.Add(btnCancel)

#Ok Button
btnOk = Button()
btnOk.Text = "Ok"
btnOk.Location = Point(btnCancel.Left - (btnOk.Width + margin), self.ClientRectangle.Bottom - (btnOk.Height + margin))
btnOk.Click += self.clickOk
self.Controls.Add(btnOk)

def clickOk(self, sender, args):
self.profile = self.txtProfile.Text
self.value = self.numValue.Value
self.DialogResult = DialogResult.OK
self.Close

def clickCancel(self, sender, args):
self.DialogResult = DialogResult.Cancel
self.Close
</syntaxhighlight>

Addon

2013-05-09T20:34:17Z

Chris Monson: /* getDirectory() */

=Methods=

==getDirectory()==
'''getDirectory() As String'''

This function returns the path of the current addon's folder.

Usage:
<syntaxhighlight lang=python>
path = addon.getDirectory()
print(path)
</syntaxhighlight>

Addons

2013-05-09T20:31:00Z

Chris Monson: /* API */

=Introduction=
The Lightforge API allows you to create new tools, new input and output methods, automate complex operations, and much more.

Lightforge addons are written in IronPython. IronPython is an open-source implementation of the Python programming language which is tightly integrated with the .NET Framework. It allows you to use both .Net and Python libraries and allows very tight integration between Lightforge and addons. For more information on IronPython you can visit [http://www.ironpython.net www.ironpython.net]. For more information on Python in general you can visit [http://www.python.org/doc/ www.python.org/doc/].

==Your First Addon==
To create an addon go to Addon Menu and click Addon Settings. You will find a button labeled Addon Folder. Clicking this will open up the Lightforge addon folder.

In this folder create a new folder named "Hello World".

Open the Hello World folder and create a new file named base.py. Open this file with your preferred Python editor, or Notepad if you have none.

Type the code:

<syntaxhighlight lang="python">
def onExecute():
print("Hello World!")
</syntaxhighlight>
Save the script, and return to Lightforge.

In the Addon Settings dialog click "Reload Addons", and if all went well, your addon will appear.

Click the check box next to the Hello World addon to enable it, then close the Addon Settings Dialog.

In the Addon menu the Hello World addon should be visible. Clicking on it will run the addon.

Now in the Window menu click "Console", this will open up the python console and you should see the text "Hello World!"

Congratulations! You've made an addon!

==Where To Go From Here==
I would suggest investigating the [[API]] and seeing what all there is to do. Also be sure to check out the [[Sample Addons]].

=Addon Structure=
The file structure of a Lightforge addon is very simple. It consists of a folder with at least one required script file named base.py, and optionally a xml file named addonInfo.xml.

==base.py==
This is the entry point for your addon. It's the script file that Lightforge interacts with directly.

==addonInfo.xml==
This xml file gives Lightforge additional information about your addon. This info will appear in the Addon Settings panel.

The addonInfo.xml file can contain the following information:

===Author===
The author of the addon.
===Version===
The current version number.
===Website===
A website associated with this addon.
===Support===
An email address or website for providing addon support.

===XML Structure===
<syntaxhighlight lang="python">
<addonInfo>
<author>Visual Sorcery</author>
<version>1.0.0</version>
<website>http://www.visualsorcery.com/</website>
<support>support@visualsorcery.com</support>
</addonInfo>
</syntaxhighlight>

=Classes=
==API==
This class contains all access for working with Lightforge.

[[API]]

==Addon==
This class gives you access to information about your addon.

[[Addon]]

=Sample Addons=
On this page you can find sample code for learning how to create addons.
[[Sample Addons]]

Api.cues

2013-05-07T21:43:00Z

Chris Monson:

=Methods=

==getCuelistCount==
'''getCuelistCount() As Integer'''

Returns the number of cuelists in this show.

Usage:
<syntaxhighlight lang=python>
cuelistCount = api.cues.getCuelistCount()
print(cuelistCount)
</syntaxhighlight>

==getCuelistLength==
'''getCuelistLength() As Double'''

Returns the length of the current cuelist in seconds or beats

Usage:
<syntaxhighlight lang=python>
cuelistLength = api.cues.getCuelistLength()
print(cuelistLength)
</syntaxhighlight>

==getCuelistIndex==
'''getCuelistIndex() As Integer'''

Returns the index of the current cuelist.

Usage:
<syntaxhighlight lang=python>
index = api.cues.getCuelistIndex()
print(index)
</syntaxhighlight>

==selectCuelist==
'''selectCuelist(index As Integer)'''

Changes to a different cuelist.

Usage:
<syntaxhighlight lang=python>
api.cues.selectCuelist(2)
print(api.cues.getCuelistIndex())
</syntaxhighlight>

Api.scriptDirectory

2013-05-07T21:36:37Z

Chris Monson: Created page with "=scriptDirectory= Contains the path of the script directory Usage: print(api.scriptDirectory)"

=scriptDirectory=

Contains the path of the script directory

Usage:
print(api.scriptDirectory)

Api.output

2013-05-06T23:29:54Z

Chris Monson:

=Methods=

==getDMX==
'''getDMX(universe As Integer) As Byte()'''

Returns a byte array containing all current dmx data for the specified universe. If the specified universe doesn't exist this function returns null.

Usage:
<syntaxhighlight lang=python>
dmxValues = api.output.getDMX(0)
print(dmxValues[42])
</syntaxhighlight>

==getUniverseCount==
'''getUniverseCount() as Integer'''

Returns the number of DMX universes in the current show.

Usage:
<syntaxhighlight lang=python>
universeCount = api.output.getUniverseCount()
print(universeCount)
</syntaxhighlight>

Api.attributeTypes

2013-05-06T22:46:34Z

Chris Monson:

<syntaxhighlight lang=vbnet>
Enum AttributeTypes
intensity
pan
tilt
colorRed
colorGreen
colorBlue
colorWheel_Secondary
strobe
gobo
gobo_Rotate
gobo_Secondary
prism
prism_Rotate
focus
beam
zoom
iris
frost
shutter
pan_Tilt_Speed
lamp
macro
control
</syntaxhighlight>

Api.groups

2013-05-06T22:34:16Z

Chris Monson: /* Methods */

=Information=

==Group Paths==
A group path is a method for specifying a group in the group hierarchy. It is defined by use of a string.

An empty string ("") will specify the main group.

To specify a child of the main group you use that child's index number ex. "1"

Note: the indexes are 0 based so fixture 1 in a group is 0, fixture 2 is 1, etc.

To specify a child of a child, you use a comma, and the index of the next child you want to select ex. "1,3"

You can continue in this fashion throughout the group hierarchy. If you are looking at something nested deeply it may look like "1,3,0,2,4".

=Methods=

==getAttribute==

'''getAttribute(attribute As [[api.attributeTypes]], groupPath As String) As Integer'''

Returns the value for a specified attribute on a specified group
Returns -1 if the group can't be found

Usage:
<syntaxhighlight lang=python>
print(api.groups.getAttribute(api.attributeTypes.intensity, "0,0"))
</syntaxhighlight>

==getChildCount==
'''getChildCount(groupPath As String) As Integer'''

Returns the number of children in a group
Returns -1 if the group can't be found

Usage:
<syntaxhighlight lang=python>
print(api.groups.getChildCount("0,0"))
</syntaxhighlight>

==getName==
'''getName(groupPath As String) As String'''

Returns the name of the requested group
Returns -1 if the group can't be found

Usage:
<syntaxhighlight lang=python>
print(api.groups.getName("1,1"))
</syntaxhighlight>

==getProfileName==
'''getProfileName(groupPath As String) As String'''

Returns the name of the profile in use by the specified group. If this group is not a fixture and does not have a profile this function will return -1.

Usage:
<syntaxhighlight lang=python>
print(api.groups.getProfileName("1,0,3"))
</syntaxhighlight>

==getSelectedGroups==
'''getSelectedGroups() As String[]'''

Returns a list of group paths for all selected groups. If there are no groups selected then null is returned.

Usage:
<syntaxhighlight lang=python>
groupList = api.groups.getSelectedGroups()
for group in groupList:
print(group)
</syntaxhighlight>

==releaseAttribute==
'''releaseAttribute(attribute As [[api.attributeTypes]], groupPath As String)'''

Releases the specified attribute on the specified group.

Usage:
<syntaxhighlight lang=python>
api.groups.releaseAttribute(api.attributeTypes.intensity, "0,1")
</syntaxhighlight>

==releaseGroup==
'''releaseGroup(groupPath As String)'''

Releases the all attributes on the specified group.

Usage:
<syntaxhighlight lang=python>
api.groups.releaseGroup("1,0")
</syntaxhighlight>

==setAttribute==
'''setAttribute(attribute As [[api.attributeTypes]], value As Integer, groupPath As String)'''

Sets the value of an attribute on a specified group.

Usage:
<syntaxhighlight lang=python>
api.groups.setAttribute(api.attributeTypes.intensity, 65535, "1,1")
</syntaxhighlight>

==selectGroup==
'''selectGroup(groupPath As String)'''

Sets the given group as selected.

Usage:
<syntaxhighlight lang=python>
api.groups.selectGroup("0,1,1,2")
</syntaxhighlight>

==deselectGroup==
'''deselectGroup(groupPath As String)'''

Deselects the given group.

Usage:
<syntaxhighlight lang=python>
api.groups.deselectGroup("0,1,1,2")
</syntaxhighlight>

==clearSelection==
'''clearSelection()'''

Deselects all selected groups.

Usage:
<syntaxhighlight lang=python>
api.groups.clearSelection()
</syntaxhighlight>

API

2013-05-06T22:23:34Z

Chris Monson: /* getBPM */

=Types=

==api.attributeTypes==
[[api.attributeTypes]]

=Classes=

==api.cues==
Used for working with cues.

[[api.cues]]

==api.groups==
Used for working with groups.

[[api.groups]]

==api.output==
Used for getting information about DMX output.

[[api.output]]

=Methods=

==getTime==
'''getTime() As Double'''

Gets the current playback position.

Usage:
<syntaxhighlight lang=python>
print(api.getTime())
</syntaxhighlight>

==setTime==
'''setTime(time As Double)'''

Sets the current playback position to the specified time.

Usage:
<syntaxhighlight lang=python>
api.setTime(36.5)
print(api.getTime())
</syntaxhighlight>

==getBPM==
'''getBPM() As Double'''

Gets the BPM of the current cuelist

Usage:
<syntaxhighlight lang=python>
print(api.getBPM())
</syntaxhighlight>

==wait==
'''wait(seconds As Double)'''

Causes execution to wait for the specified number of seconds.

Usage:
<syntaxhighlight lang=python>
api.wait(3.5)
</syntaxhighlight>

==isPlaying==
'''isPlaying() As Boolean'''

Checks to see if the timeline is currently playing back.

Usage:
<syntaxhighlight lang=python>
if(api.isPlaying()):
api.stopPlayback()
</syntaxhighlight>

==startPlayback==
'''startPlayback()'''

Starts timeline playback.

Usage:
<syntaxhighlight lang=python>
if(api.isPlaying() == False):
api.startPlayback()
</syntaxhighlight>

==stopPlayback==
'''stopPlayback()'''

Stops timeline playback.

Usage:
<syntaxhighlight lang=python>
if(api.isPlaying()):
api.stopPlayback()
</syntaxhighlight>

==NextCue==
'''nextCue()'''

Advances timeline to the next cue.

Usage:
<syntaxhighlight lang=python>
api.nextCue()
</syntaxhighlight>

==PreviousCue==
'''previousCue()'''

Moves timeline to the previous cue.

Usage:
<syntaxhighlight lang=python>
api.previousCue()
</syntaxhighlight>

=Event Handling=

==onInitialize==
Called when the script is loaded.

Usage:
<syntaxhighlight lang=python>
def onInitialize():
print("Script Loaded")
</syntaxhighlight>

==onDispose==
Called when the script is being disposed by either it being disabled, or by Lightforge closing.

Usage:
<syntaxhighlight lang=python>
def onDispose():
print("Addon Disposing")
</syntaxhighlight>

==onEdit==
Called when the script settings are being edited. Editing a script's settings from the Script Settings Dialog is only possible if this function is implemented in your code.

Usage:
<syntaxhighlight lang=python>
def onEdit():
print("Settings Edit")
</syntaxhighlight>

==onExecute==
Called when this script is specifically executed.

Usage:
<syntaxhighlight lang=python>
def onExecute():
print("Script Executed")
</syntaxhighlight>

==onExecuteAsync==
Called when this script is specifically executed. Code run from this function is executed asynchronously.

Usage:
<syntaxhighlight lang=python>
def onExecuteAsync():
print("Script Executed Asynchronously")
</syntaxhighlight>

==onStartup==
Called when Lightforge starts up.

Usage:
<syntaxhighlight lang=python>
def onStartup():
print("Lightforge Started")
</syntaxhighlight>

==onStartupAsync==
Called when Lightforge starts up. Code run from this function is executed asynchronously.

Usage:
<syntaxhighlight lang=python>
def onStartupAsync():
print("Lightforge Started (Async)")
</syntaxhighlight>

==onPlaybackStart==
Called when timeline playback has started.

Usage:
<syntaxhighlight lang=python>
def onPlaybackStart():
print("Playback Started")
</syntaxhighlight>

==onPlaybackStop==
Called when timeline playback has stopped

Usage:
<syntaxhighlight lang=python>
def onPlaybackStop():
print("Playback Stopped")
</syntaxhighlight>

==onFrameChange==
Called on every frame change during playback, scrubbing, and time changes.

Usage:
<syntaxhighlight lang=python>
def onFrameChange(seconds As Double):
print("Frame Changed " + seconds)
</syntaxhighlight>

==onShutdown==
Called when Lightforge is shutting down.

Usage:
<syntaxhighlight lang=python>
def onShutdown():
print("Lightforge Shutdown")
</syntaxhighlight>

==onCuelistChange==
Called when the current cuelist has been changed.

Usage:
<syntaxhighlight lang=python>
def onCuelistChange():
print("Cue List Changed")
</syntaxhighlight>

==onShowLoaded==
Called when a new show has been loaded.

Usage:
<syntaxhighlight lang=python>
def onShowLoaded():
print("Show Loaded")
</syntaxhighlight>

Show Controls Panel

2013-02-27T07:07:28Z

Chris Monson: Created page with "The Show Controls Panel gives you various functions used to create and run your show. ==Previous Cue== Moves playback time to the start time of the previous cue. ==Play Back..."

The Show Controls Panel gives you various functions used to create and run your show.

==Previous Cue==
Moves playback time to the start time of the previous cue.

==Play Backward/Pause==
Starts playing backward from the current position. If currently playing backwards then pause.

==Play/Pause==
Starts playing forward from the current position. If currently playing forward then pause.

==Pause==
Pauses playback.

==Next Cue==
Moves playback time to the start time of the next cue.

==Add Audio==
Adds an audio file to the timeline.

==Add Cue==
Creates a cue from all the held values in groups.

==Update Cue==
Opens a dialog prompting you to either:

'''Update Selected Cue'''
Add the held values to the current tracking data in the cue.

'''Overwrite Selected Cue'''
Overwrite the tracking data in the cue with the held values in the groups panel.

==Delete==
Deletes the selected cues or audio files.

==Crossfade==
Toggles crossfading on intensity presets, palettes, and showlist changes.

==Keyboard Shortcuts==
Play/Pause - '''Space Bar'''

Play Backwards - '''Backspace'''

Skip to Next Cue - '''Right Arrow'''

Go to Previous Cue - '''Left Arrow'''

Show List Panel

2013-02-27T06:54:45Z

Chris Monson: /* Rearranging Cuelists= */

The Show List panel allows you to create multiple cuelists and move between them in a single show.

==Adding a Cuelist==
To add a new cuelist, right click on an area of the show list panel that doesn't contain a cuelist, then select "New" from the menu.

==Deleting a Cuelist==
To delete a cuelist, right click on it and select delete.

==Clearing All Cuelists==
To clear all cuelists, right click on the show list panel and select "Clear All"

==Renaming a Cuelist==
To rename a cue right click on it and select "Rename"

==Rearranging Cuelists==
To rearrange cuelists, click and drag them to the position you'd like them to occupy.

Timeline Panel

2013-02-27T05:16:47Z

Chris Monson: /* Command Markers */

The timeline panel is your main work space for working with cue timings, audio synchronization and midi show control.

==Time Scales==
===Time===
The default time scale in Lightforge is "Time". This measures your progression through time in hours, minutes, and seconds.

===Beats===
The Beats time scale allows you to specify a tempo (beats per minute), and number of beats per measure. You can then record your cues and set your timings to this time scale. Adjusting your tempo will automatically scale the playback of your cues and effects to the new tempo. You can enable beats mode by clicking on the "Beats" toggle button in the time section of the Timeline panel. Once selected you can adjust your tempo by clicking the "bpm" button below the "Beats" button

==Cues==
===Important Concepts===
By default, cues in Lightforge function in a tracking system. What this means is that for each cue you create the only thing that is being saved is the changes since your last cue. In short, if you turn a light on, it stays on until you tell it to turn off in a later cue. It's important to understand this because there are various positive and potentially negative ramifications to this approach.

'''The Positive:'''
If you forgot to add something into your show and it's supposed to be in every cue, all you have to do is add it to the first cue, and it will track through the rest of your cues until it's told to do otherwise.

'''The Negative:'''
If you want to add something to a single cue you will need to remove it in the following cue otherwise it will continue tracking throughout the rest of your show.

In general the tracking approach creates simpler shows, with less to manage. Instead of having to look through every channel on a cue to make an adjustment you only need to deal with what has been changed in that particular cue.

===Cue Length===
The length of a cue is adjusted by clicking and dragging on either the left or right edge of a cue.

===Fade In===
You can adjust your fade in time by clicking and dragging on the upper left corner of a cue.

===Fade Out===
You can adjust your fade out time by clicking and dragging on the upper right corner of a cue.

===Moving Cues===
To rearrange a cue, click on the middle of the cue and drag it to where you would like it to go. When you release the cue all other cues will snap into position around it.

===Nesting===
You can nest cues inside one another by dragging a cue below another cue.

===Subdivide===
Subdivide takes an existing cue, and creates two nested cues inside of itself. You can subdivide a cue by right clicking on it and selecting subdivide.

===Collapse===
Collapse flattens the nested structure of the selected cue. You can collapse a cue by right clicking on it and selecting collapse.

===Load Held Values===
Double clicking a cue will copy the cue values back onto the rig in the state they were saved in.

==Cue Types==
===Hold===
When playback reaches a cue set as a hold cue playback will stop and wait for the user to start the next cue
===Follow===
When playback reaches a follow cue it continues playback.
===Tracking===
This is the default cue type, it uses the tracking system to combine the changes made in this cue with changes made in previous cues.
===Non-Tracking===
Non-Tracking cues take a snapshot of the overall look created by all cues at this point in time. A non-tracking cue will maintain it's values regardless of changes made to cues before it.

==Audio==
The audio track allows you to load in audio files for synchronizing cues to music. Audio files are manipulated in the same manner as cues with the exception of there being no fade ins or outs on audio tracks. Audio tracks do not rescale on changing of tempo in beats mode.

==Command Markers==
Command markers allow you to execute commands as playback passes a certain point in time.

===Positioning Modes===
Command markers have two different positioning modes. These are chosen individually on markers by right clicking the marker and checking or unchecking “Relative”.

====Relative Positioning====
When set to relative (default), changes in cue timings will automatically shift marker positions with the cues.
====Absolute Positioning====
When set to absolute, cue timing will not affect markers.

===Command Marker Types===

====Go To Time====
Goes to the specified time and continues playback.
====Pause====
Pauses at the marker time.

====Midi Show Control====
Executes a [[Midi Show Control]] command.

==Keyboard And Mouse Shortcuts==

Move Timeline - '''Middle Mouse Drag''' or '''M + Left Mouse Drag'''

Zoom - '''Mouse Wheel''' or '''+''' and '''-'''

Return to Start - '''Home'''

Go To End - '''End'''

Play/Pause - '''Space Bar'''

Play Backwards - '''Backspace'''

Skip to Next Cue - '''Right Arrow'''

Go to Previous Cue - '''Left Arrow'''

Toggle Follow/Hold - '''F'''

Toggle Tracking/Non-Tracking - '''T'''

Subdivide - '''S'''

Delete Cues/Audio - '''Delete'''

Select All - '''CTRL + A'''

Select None - ''' CTRL + D'''

Profile Node System

2013-02-24T18:04:32Z

Chris Monson: /* Node Types */

The Profile Node System is a means of translating Lightforge's input values into values compatible with whatever lighting fixtures you may be using.

==Nodes==
A node is a container that executes predefined function on the data passing through it's inputs and outputs (called pins). A node system works by allowing you to feed a flow of information from one node to the next in order to make adjustments to the data flowing through the system.

A simple example of this is to calculate 3 + 6. You can calculate this with the following node setup:

[Value Node @ 3]
\
\
[Add Node]----[Output = 9]
/
/
[Value Node @ 6]

The value of 3 flows from the top value node into the add node. The value of 6 flows from the bottom value node into the add node. The add node adds Input 1 + Input 2, and the resulting value of 9 flows out the add node.

==Pins==

==Pin Formats==
Each pin has a defined format type that it can accept. The formats may change based on what is connected to certain pins in the node. Pin types include the following.

===8 Bit===
8 Bit pins give you a 0 to 255 range of whole values.

===16 Bit===
16 Bit pins give you a 0 to 65535 range of whole values

===Decimal===
Decimal pins are a 64-bit (8-byte) double-precision floating-point numbers ranging in value from -1.79769313486231570E+308 through -4.94065645841246544E-324 for negative values and from 4.94065645841246544E-324 through 1.79769313486231570E+308 for positive values.

===Color===
Color Pins accept and output a 24bit RGB color structure.

===Auto Detect===
Auto Detect pins will turn into whatever format type you connect to them.

==Working With Nodes==

===Adding Nodes===
To add a node right click on an empty area of the canvas and select the type of node you would like to add.

===Moving Nodes===
To move a node click and drag it to the position you'd like it to be.

===Deleting Nodes===
To delete a node right click on it and press delete on the context menu.

===Connecting Nodes===
To connect node inputs and outputs click and drag from the output of the first node to the input of the second. Multiple connections can be made from one output, but only one connection can go to any input.

===Disconnecting Nodes===
To disconnect a node connection click on the input that the connection is on and drag it off the pin and release it.

==Node Types==

DMX Channel

2013-02-24T17:42:41Z

Chris Monson: Created page with "A DMX Channel is a value used to control lighting systems via the DMX Lighting Protocol. Each DMX channel has a value range of 0 to 255."

A DMX Channel is a value used to control lighting systems via the [[DMX]] Lighting Protocol. Each DMX channel has a value range of 0 to 255.

DMX Universe

2013-02-24T17:39:12Z

Chris Monson:

A DMX universe represents 512 discrete [[DMX Channel]]s that lighting fixtures can be addressed to. If you are using traditional DMX, a DMX Universe is equivalent to one DMX output. In Lightforge you can create as many universes as you would like through the [[Settings Menu]].

Fixture Dialog

2013-02-24T17:21:50Z

Chris Monson: /* Address */

The Fixture Dialog is used to patch lighting fixtures to channels and give you the ability to control them.

==Profiles==
A profile is a system used to convert the information that you input into Lightforge into something that you lighting fixtures can process. There are two methods of creating profiles in Lightforge, node profiles, and scripted profiles.

===Creating Profiles===

[[Profile Node System]]

[[Profile Python Scripting]]

==Name==
The name is used to define what your fixture will be labeled throughout Lightforge.

==Universe==
This is the [[DMX Universe]] that your fixture will be assigned to.

==Address==
This is the [[DMX Channel]] that your fixture will be assigned to.

==Use Multiple Addresses==
This allows you to add multiple addresses or ranges or addresses to a single Lightforge fixture. This is useful for situations where you have multiple real fixtures that you would like to be assigned to a single fixture in Lightforge.

==Count==
The count option gives you the ability to add multiple sequentially addressed lighting fixtures of the same type.

==Offset==
This gives you the option to leave a specified number of empty channels between the sequential fixtures specified in "Count".

==Channel Panel==
The Channel Panel shows how the addresses the selected [[DMX Universe]] are being used.

'''Color Coding:'''

'''White:''' Addresses that are available.

'''Gray:''' Addresses that are taken by other fixtures.

'''Cyan:''' The addresses that your current selection is occupying.

'''Red:''' Addresses that can't be patched because of overlapping channels.