Example

====== Patch - Park fixtures 1 thru 100000======

^ by: | Sebastian Beutel, july 2020 |
^ idea: | Yenz Nyholm, see https://www.facebook.com/groups/Avolites/permalink/1931175330348025/ |
^ description: | Parks/unparks fixtures 1 ~ 100000 |

{{tag>park fixtures}}

**From Titan v15 on ClearAll() requires two parameters, see [[macros:function:programmer.editor.clearall|]].\\ Simply change the relevant line(s) to ''Programmer.Editor.ClearAll(false, false)''.**
==== functions ====
  * [[:macros:function:Menu.Stack.PushOrReloadMenu]]
  * [[:macros:function:Menu.InjectInput]]
  * [[:macros:function:Programmer.Editor.Selection.GetSelectedHandles]]
  * [[:macros:function:Handles.SetSourceHandleRangeFromHandles]]
  * [[:macros:function:Patch.Repatch.SetDmxAddressesFromSelectedFixture]]
  * [[:macros:function:Patch.Repatch.ParkSelectedFixtures]]
  * [[:macros:function:Patch.Repatch.UnParkSelectedFixtures]]
  * [[:macros:function:Handles.ClearSelection]]
  * [[:macros:function:Programmer.Editor.ClearAll]]

==== affected properties ====
  * [[:macros:property:Windows.PatchView.Handles]]
  * [[:macros:property:Patch.Repatch.SelectedFixtureHandles]]

>The repatch menu does not actually use the PatchSelection, it has its own property Patch.Repatch.SelectedFixtureHandles.
 
===== Code =====
<code xml ParkFixtures1Thru100000.xml>
<?xml version="1.0" encoding="utf-8" ?>
<avolites.macros>

<!-- 
  Sebastian Beutel, July 2020
  idea by Yenz Nyholm
  see https://www.facebook.com/groups/Avolites/permalink/1931175330348025/
-->
	 
 
<macro id="Avolites.Macros.ParkFixturesOneThru100000" name="Park Fixtures 1 Thru 100000">
  <description>Parks fixtures 1 ~ 100000.</description>
  <sequence>
    <step pause="0.001">Menu.Stack.PushOrReloadMenu("Primary", "Expert.Root.Program")</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","Channel","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",1)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","KeypadThrough","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",1)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","KeypadEnter","",0)</step>
    <step pause="0.01">Programmer.Editor.Selection.GetSelectedHandles("Windows.PatchView.Handles")</step>
    <step pause="0.01">Handles.SetSourceHandleRangeFromHandles(Windows.PatchView.Handles, true)</step>
    <step pause="0.01">Patch.Repatch.SetDmxAddressesFromSelectedFixture()</step>
    <step pause="0.01">Patch.Repatch.ParkSelectedFixtures()</step>
    <step pause="0.01">Handles.ClearSelection()</step>
    <step pause="0.01">Programmer.Editor.ClearAll()</step>
  </sequence>
</macro> 

<macro id="Avolites.Macros.UnparkFixturesOneThru100000" name="Unpark Fixtures 1 Thru 100000">
  <description>Unparks fixtures 1 ~ 100000.</description>
  <sequence>
    <step pause="0.001">Menu.Stack.PushOrReloadMenu("Primary", "Expert.Root.Program")</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","Channel","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",1)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","KeypadThrough","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",1)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","NumericKeys","",0)</step>
    <step pause="0.001">Menu.InjectInput("OnButtonDown","KeypadEnter","",0)</step>
    <step pause="0.01">Programmer.Editor.Selection.GetSelectedHandles("Windows.PatchView.Handles")</step>
    <step pause="0.01">Handles.SetSourceHandleRangeFromHandles(Windows.PatchView.Handles, true)</step>
    <step pause="0.01">Patch.Repatch.SetDmxAddressesFromSelectedFixture()</step>
    <step pause="0.01">Patch.Repatch.UnParkSelectedFixtures(true)</step>
    <step pause="0.01">Handles.ClearSelection()</step>
    <step pause="0.01">Programmer.Editor.ClearAll()</step>
  </sequence>
</macro>

</avolites.macros>
</code>

Here, the  '' pause="0.01" '' seems to be required - if there is no pause, always the previously for repatching selected fixtures will be parked, and if there aren't any an exception is thrown.

===== Explanation =====

This explains the functional steps within the sequence. For all the other XML details please refer to [[:macros:formats_and_syntax#xml_format|Formats and syntax]]

The first part simply emulates fixture selection by syntax, like ''1 THRO 100000'':
  * ''Menu.Stack.PushOrReloadMenu("Primary", "Expert.Root.Program")'' makes sure we are in the root menu
  * the ''Menu.InjectInput(..)'' commands emulate the button presses ''Fixture'' ''1'' ''THRO'' ''1'' ''0'' ''0'' ''0'' ''0'' ''0'' ''Enter''
This way the fixtures 1 ~ 100000 are selected.

The following code is taken from [[macros:example:parkselectedfixtures|]]
  * The first line retrieves the current selection and stores it in a menu property, it is not important which one just that it is the correct type. 
  * From that we then set the source handle selection (this is the same selection that is used for copy, move, set legend etc.). 
  * The third line copies the source handle selection to the Repatch property (and initialises other properties used in the repatch menu). 
  * The forth line performs the Park operation and 
  * the last line clears the source handle selection once you are done.

===== How to use it =====

  * [[:macros:deploying|make this macro available]]
  * When needed, select some fixtures and apply this macro in order to park these fixtures.


~~DISCUSSION~~