Hooks

Hooks 1. Definition Hooks are predefined methods that are used to link a script to the project. You decide when what code is executed. E.g. code that is written in the procedure _OnExpandSlideshow_ is executed just before the presentation playback. Hooks do not need to be defined, the script engine knows these specific methods and reacts accordingly. All hooks have as a parameter the current SlideShow object (http://support.aquasoft.de/154180-ISlideShowObject) of type ISlideShowObject. So can t...

OnConfigureShader 1. Definition Is called by the IShader (http://support.aquasoft.de/837005-IShader) object before each (!) frame. 2. Method procedure OnConfigureShader(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject); const Progress: Float); 3. Example procedure OnConfigureShader(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject); const Progress: Float); begin var Shader = SlideShowObject as IShader; Shader.SetParamF...

OnCreateContextMenu 1. Definition When right clicking on an object in the timeline / storyboard / image list, i.e. when creating the context menu. This hook should be used to generate specific context menu items. These are JSON (https://de.wikipedia.org/wiki/JSON) formatted. The specified Hook is a scripting method that is to be executed when clicking. 2. Method function OnCreateContextMenu(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject)): string; 3. Ex...

OnDesignerChanged 1. Definition This hook is called when changes are made to a SlideShow object, that will take effect in the Layout designer. Based on the type of change the script can update the internal data. 2. Method function OnDesignerChanged(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject); Context: IDesignerContext (http://support.aquasoft.de/951366-IDesignerContext); UpdateInfo: IDesignerUpdate (http://support.aquasoft.de/866758-IDesignerUpdate)):...

OnExpandSlideShow 1. Definition Called before the playback of the presentation to expand the components of the project. 2. Method procedure OnExpandSlideShow(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject));

OnGetContainerChild 1. Definition This hook is called when a Blackbox object is dragged into the timeline and an object or a Blackbox effect is deleted. 2. Method function OnGetContainerChild(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject)): string; 3. Parameters SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject) 4. Return value The return value is a string of the form 'x.y.z'. x, y and z are integers greater than or...

OnInitDesigner 1. Definition This hook is called from the Layout designer when the object is to be displayed in the Layout designer. Scripts should implement this hook if you want to customize the appearance of an object in the Layout designer. 2. Method procedure OnInitDesigner(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject); Context: IDesignerContext (http://support.aquasoft.de/951366-IDesignerContext)) 3. Parameters SlideShowObject: ISlideShowObject...

OnInsertPreset 1. Definition This hook is executed when inserting an object from the Toolbox before the object was created in the Timeline or Storyboard. If the function returns TRUE, then the object will be permanently inserted. 2. Method function OnInsertPreset(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject)): Boolean;

Render 1. Definition The hook is executed when you apply the effect Image effects (http://support.aquasoft.de/930242-IEffect) to generate the content to display. * Parameter Bitmap: The Canvas object (http://support.aquasoft.de/375229-ICanvas) that is used for drawing 2. Method procedure Render(SlideShowObject: ISlideShowObject (http://support.aquasoft.de/154180-ISlideShowObject); Bitmap: ICanvas (http://support.aquasoft.de/375229-ICanvas));