AquaSoft Wiki - Benutzerbeiträge [de]

Partikelobjekt

2019-09-27T08:18:50Z

Daniel Bärmann: /* Partikel */

Das Partikelobjekt ist vom Typ '''IParticle''' und leitet von '''[[ISlideShowObject]]''' ab. Mit diesem Objekt kann man Partikeleffekte erstellen.

Das Partikelobjekt enthält unter anderem Eigenschaften des Typs [[IParticleRangeValue]] bzw. [[IParticleRangeValue|IParticleVectorRangeValue]]. Einige dieser Eigenschaften verfügen über Initialwerte (wie ''Size'' und ''InitialSize''). Die Initialwerte geben den Ausgangszustand des Wertes an, die Nicht-Initialwerte geben eine Änderung an. Die Initialwerte bekommen einen Wertebereich. Beim Emittieren eines Partikels wird dem neuen Partikel ein zufälliger Werte innerhalb dieses Bereichs zugewiesen. Initialwerte können sich über die Dauer des Partikelsystems ändern. Die Änderungswerte erhalten ebenfalls einen Bereich. Der Unterschied ist, dass bei ihnen vorher eine Wichtung ermittelt wird. Diese wird benutzt um die Änderungen über die Lebenszeit des Partikels immer gleich gewichtet zu haben (siehe [[#Beispiel|Beispiel]]).

<code>
IParticle '''inherits from''' [[ISlideShowObject]]
function InitialDirection: [[IParticleRangeValue|IParticleVectorRangeValue]]
function Direction: [[IParticleRangeValue|IParticleVectorRangeValue]]
function InitialSpeed: [[IParticleRangeValue]]
function Speed: [[IParticleRangeValue]]
function InitialSize: [[IParticleRangeValue]]
function Size: [[IParticleRangeValue]]
function InitialRotation: [[IParticleRangeValue|IParticleVectorRangeValue]]
function Rotation: [[IParticleRangeValue|IParticleVectorRangeValue]]
function InitialRotationFrequency: [[IParticleRangeValue|IParticleVectorRangeValue]]
function RotationFrequency: [[IParticleRangeValue|IParticleVectorRangeValue]]
function InitialOpacity: [[IParticleRangeValue|IParticleRangeValue]]
function Opacity: [[IParticleRangeValue|IParticleRangeValue]]

property Move: [[TParticleMove]]
function InitialMoveStrength: [[IParticleRangeValue|IParticleVectorRangeValue]]
function MoveStrength: [[IParticleRangeValue|IParticleVectorRangeValue]]
function InitialMoveSineFrequency: [[IParticleRangeValue]]
function MoveSineFrequency: [[IParticleRangeValue]]

function MaxAge: [[IParticleRangeValue]]
function ParticlesPerSecond: [[IParticleRangeValue]]

property SpriteAnimation: [[TParticleSpriteAnimation]]
function InitialSpriteAnimationFrequency: [[IParticleRangeValue|IParticleRangeValue]]
function SpriteAnimationFrequency: [[IParticleRangeValue]]

property Filename: [[IFilename]]
property Clipping: Boolean
property PreWarmTime: Integer

property Emitter: [[TParticleEmitter]]
function EmitterSpread: [[IParticleRangeValue]]
procedure AddEmitterClipRect(const X, Y, Width, Height, AngleZ: Single; const Invert: Boolean);

property Options: [[TParticleOptions]]
property Environment: [[TParticleEnvironment]]

property Seed: Int64
end;
</code>

= Methoden =

== Partikel ==

* Bewegungsrichtung: Die Werte modifizieren einen Bewegungsvektor, der nach rechts zeigt. Die jeweiligen Richtungen geben Winkel an, um die der Vektor gedreht wird. Wichtig ist dabei die Reihenfolge. Als erstes wird der Winkel um die Z-Achse addiert, dann wird der Vektor um die Y-Achse gedreht und dann um die X-Achse.
Die Drehwinkel kann man sich anhand folgender Beispiele herleiten:
** Drehwinkel um X und Y = 0 zeigt der Vektor bei Z = 0 (also der Basisvektor) nach rechts, bei Z = 90 zeigt der Vektor nach unten
** Bei X = 0 und Z = 0, zeigt der Vektor bei Y = 90 nach hinten
** Bei Z = 0 und Y = 90 zeigt der Vektor bei X = 90 nach oben
<code>function InitialDirection: [[IParticleRangeValue|IParticleVectorRangeValue]];</code>
* Richtungsänderung über die Zeit: Addition von Winkeln (zB. bei Initialrichtung von 10 und einer Richtung von 10 bekommt das Partikel die Richtung 20).
<code>
function Direction: [[IParticleRangeValue|IParticleVectorRangeValue]];
</code>

* Partikelgeschwindigkeit in Bewegungsrichtung
<code>
function InitialSpeed: [[IParticleRangeValue]];
</code>
* Geschwindigkeitsänderung über die Zeit: Prozent der Initialgeschwindigkeit.
<code>
function Speed: [[IParticleRangeValue]];
</code>

* Partikelgröße. Skaliert das Partikel ohne Verzerrung so, dass die größte Richtung die Partikelgröße wird ("einpassen"). Der Wert versteht sich in Prozent zu seinem Bezugssystem (siehe [[TParticleEnvironment]]):
<code>
function InitialSize: [[IParticleRangeValue]];
</code>
* Größenänderung über die Zeit: Prozent der Initialgröße.
<code>
function Size: [[IParticleRangeValue]];
</code>

* Partikeltransparenz
<code>
function InitialOpacity: [[IParticleRangeValue]];
</code>
* Transparenzänderung über die Zeit: Prozent der Initialtransparenz.
<code>
function Opacity: [[IParticleRangeValue]];
</code>

* Partikeldrehung: Man unterscheidet zwischen der statischen Lage des Partikels und einer beständigen Drehung. Beispielsweise sollen die Partikel beim Emittieren immer zwischen 10 und 20 Grad gedreht sein, die Lage aber behalten. Dafür kommt die Eigenschaft '''Rotation''' in Frage (bei einer Rotationsgeschwindigkeit von 0). Ist jedoch eine permanente Drehung gewünscht, nimmt man die '''Rotationfrequency''' (Rotationsgeschwindigkeit). Lage und Rotationsgeschwindigkeitschließen sich nicht aus. Positive Werte drehen im Uhrzeigersinn, negative entgegengesetzt. Die Werte verstehen sich als Winkeladditionen eines Basisvektoren, der die Standardrichtung angibt. Bei X = 0, Y = 0 und Z = 0 zeigt dieser Basisvektor nach rechts. Als erstes wird um Z rotiert, dann um Y, dann um X.
* Lage des Partikels
<code>
function InitialRotation: [[IParticleRangeValue|IParticleVectorRangeValue]];
</code>
* Lageänderung über die Zeit. Additiv (zB. 10° bei 0ms und 20° bei 1000ms ergibt in der ersten Sekunde eine Drehung um 10°, danach keine weitere).
<code>
function Rotation: [[IParticleRangeValue|IParticleVectorRangeValue]];
</code>
* Rotationsgeschwindigkeit: Gibt die Anzahl der Drehungen in einer Sekunde an.
<code>
function InitialRotationFrequency: [[IParticleRangeValue|IParticleVectorRangeValue]];
</code>
* Geschwindigkeitsänderung die Zeit: Prozent der Initialgeschwindigkeit.
<code>
function RotationFrequency: [[IParticleRangeValue|IParticleVectorRangeValue]];
</code>

* Partikelbewegung: Partikel können neben ihrer eigentlichen Bewegungsrichtung auch von ihrer Bewegung abweichen, zum Beispiel schwingen.
<code>
property Move: [[TParticleMove]];
</code>
* Maximale Stärke der Abweichungsbewegung. Die Stärke ist in Prozent der maximalen Partikelgröße angegeben. Stärke = 100 heißt also, dass ein Partikel nach oben unten so weit ausschlägt, wie es selbst groß ist.
<code>
function InitialMoveStrength: [[IParticleRangeValue|IParticleVectorRangeValue]];
</code>
* Stärkenänderung über die Zeit: Prozent der Initialstärke:
<code>
function MoveStrength: [[IParticleRangeValue|IParticleVectorRangeValue]];
</code>
* Abweichungsfrequenz: Gibt an, wie viele Schwingungen oder Kreisbewegungen in einer Sekunde vollführt werden
<code>
function InitialMoveFrequency: [[IParticleRangeValue]];
</code>
* Frequenzänderung über die Zeit: Prozent der Initialfrequenz:
<code>
function MoveFrequency: [[IParticleRangeValue]];
</code>

* Lebensdauer des Partikels in Millisekunden. 0 heißt, dass das Partikel nie "stirbt".
<code>
function MaxAge: [[IParticleRangeValue]];
</code>

* Emittierrate. Gibt an, wie viele Partikel in einer Sekunde emittiert werden.
<code>
function ParticlesPerSecond: [[IParticleRangeValue]];
</code>

* Partikelanimation. Sind im Partikelsystem mehrere Bilddateien angegeben, können die Partikel ihr Bild während ihrer Lebenszeit ändern.
<code>
property SpriteAnimation: [[TParticleSpriteAnimation]]
</code>
* Animationsgeschwindigkeit: Gibt die Anzahl der Bildwechsel pro Sekunde an
<code>
function InitialSpriteAnimationFrequency: [[IParticleRangeValue]];
</code>
* Geschwindigkeitsänderung über die Zeit: Prozent der Initialgeschwindigkeit.
<code>
function SpriteAnimationFrequency: [[IParticleRangeValue]];
</code>

* Dateinamen der Partikelbilder
<code>
property Filename: [[IFilename]];
</code>

* Partikelsystem auf seine Bounds zuschneiden oder alle Partikel, die hinausragen anzeigen:
<code>
property Clipping: Boolean;
</code>

* Partikelsystem vorsimulieren. Es ist möglich, dass simuliert wird, dass das Partikelsystem bereits eine gewisse Zeit (in Millisekunden) gelaufen war, bevor es wirklich angezeigt wird. Mindestwert = 100ms
<code>
property PreWarmTime: Integer;
</code>

== Emitter ==

* Emitter-Typ:
<code>
property Emitter: [[TParticleEmitter]]
</code>

* Rand am Emitter: Wenn der Emitter vom Typ ''pePoint'' oder ''pePath'' ist, kann er einen Abstand erhalten: Beim Punkt-Emitter werden die Partikel in einem Kreis mit angebenen Abstand emittiert, beim Pfad-Emitter werden die Partikel sowohl oberhalb als auch unterhalb davon abgebildet. Angabe in Prozent des Bildschirms.
<code>
function EmitterSpread: [[IParticleRangeValue]]
</code>

* Flächen, an denen nicht emittiert werden soll: Der Emitter hält eine Liste von gedrehten Rechtecken, an denen nicht emittiert werden darf.
<code>
procedure AddEmitterClipRect(const X, Y, Width, Height, AngleZ: Single; const Exclude: Boolean);
</code>

== Optionen ==

* Partikel-Umgebung: Gibt an, ob die Bounds vom Partikelsystem nur als Positionierung der Partikel beim Emittieren dienen ('''peGlobal'''), oder ob das Partikelsystem Einfluss auf die Partikel hat, die Partikel also mitskalieren und sich mitdrehen, etc. ('''peLocal''')
<code>
property Environment: [[TParticleEnvironment]]
</code>

* Partikeloptionen geben beispielsweise an, wie sich die Partikel bei Drehung des Partikelsystems verhalten oder ob die Animationen abrupt oder durch Alphablending ablaufen. Einige Optionen sind nur für [[TParticleEnvironment|Environment]] = peGlobal sinnvoll:
<code>
property Options: [[TParticleOptions]]
</code>

* Zufallswert (''Seed''), um wiederholbare Zufälle zu generieren. Ist der Wert = 0 werden alle Zufälle in den [[IParticleRangeValue|RangeValues]] wirklich zufällig berechnet, also immer ein eigener Seed generiert. Ansonsten wird der gegebene Seed verwendet.
<code>
property Seed: Int64;
</code>

= Beispiel 1 =

Wird dieses Script einem Partikelobjekt zugeordnet, wird das Partikelsystem wie folgt konfiguriert:

Einem Partikelsystem werden folgende [[IParticleRangeValue|RangeValues]] gegeben:
* InitialSize zwischen 10 und 20.
* Size zwischen 50 und 100 ab 0ms und 0 und 50 ab 1000ms

Partikel 1 bekommt zufällig eine Größe zwischen 10 und 20, zB. 15. Der Size-Wert modifiziert diesen Initialwert, in dem Fall prozentual. Das heißt das Partikel ist zwischen 50% * 15 und 100% * 15 groß ab Sekunde 0 seiner Lebenszeit. Der genaue Wert wird durch die zufällig gewählte Wichtung ermittelt, sagen wir 50%. Die Wichtung legt also die Mitte des Bereichs fest. Demnach ist die Wichtung 75%, also die Mitte zwischen 50 und 100. Daher hat der Partikel zum Zeitpunkt 0ms (also dem Zeitpunkt seines Emittierens) die Größe 75% * 15 = 11,25.
Der Size-Wert ändert sich über die Zeit. Allerdings bleibt die Wichtung pro Partikel gleich. Der Size-Wert sagt, dass die Partikel bei Sekunde 1 nur noch zwischen 0 und 50% des Initialwertes groß sind. Durch die Wichtung von 50% ergibt sich ein Size-Wert von 25%, also der Mitte zwischen 0 und 50%. Daher hat das Partikel zum Zeitpunkt 1000ms die Größe 25% * 15 = 3,75.

Für Partikel 2 wird eine neue Initialgröße vergeben (deren Bereich sich über die Zeit natürlich auch verändern kann). Ebenso wird eine neue Wichtung ermittelt, zB. Initialgröße von 12 und einer Wichtung von 100%. Demnach ist das Partikel 2 zum Zeitpunkt 0ms 12 Einheiten groß und nach einer Sekunde nur noch 6.

<code>
procedure OnExpandSlideShow(SlideShowObject: ISlideShowObject);
begin
var Particle := SlideShowObject as IParticle;
Particle.InitialSize.SetValue(0, 0, 10);
Particle.InitialSize.SetValue(1, 0, 20);
Particle.Size.SetValue(0, 0, 50);
Particle.Size.SetValue(1, 0, 100);
Particle.Size.SetValue(0, 1000, 0);
Particle.Size.SetValue(1, 1000, 50);
end;
</code>

= Beispiel 2 =

Wird dieses Script einem Partikelobjekt zugeordnet, lässt es die Partikel um die X-Achse im 3D-Raum rotieren.

<code>
procedure OnExpandSlideShow(SlideShowObject: ISlideShowObject);
begin
var ParticleObject: IParticle = SlideShowObject as IParticle;

ParticleObject.InitialRotationFrequency.SetValueX(0, 0, 0.8); // Angabe in Hz
end;
</code>

[[Kategorie:Scripting-API]]
[[Kategorie:Partikelsystem]]
[[Kategorie:Language]]

TParticleOptions

2019-09-27T08:13:48Z

Daniel Bärmann: /* Werte */

Set vom Aufzählungstyp '''TParticleOption''' für Methode ''Options'' des [[Partikelobjekt|Partikelobjekts]]. Options kann generell alle möglichen Schalter für das Partikelsystem haben.

= Werte =
* '''poInheritEmitterDirection''': Partikel in Bewegungsrichtung des Emitters drehen. Partikelrotation bleibt unbeeinflusst. ''Nur [[TParticleEnvironment]] = peGlobal!''
* '''poInheritEmitterRotation''': Partikel erben den Rotationswinkel des Emitters. Bewegungsrichtung der Partikel bleibt unbeeinflusst.
* '''poInheritEmitterSize''': Partikel skalieren mit dem Emitter mit. ''Nur [[TParticleEnvironment]] = peGlobal!''
* '''poRotateParticleInDirection''': Partikel drehen sich in Bewegungsrichtung des Emitters. ''Nur [[TParticleEnvironment]] = peGlobal!''
* '''poBlendSprites''': Partikelanimation ist normal ein einfacher Wechsel der Bilder. Mit dieser Option werden die Einzelbilder per Alphablending ineinander übergeblendet.
* '''poReverseParticleOrder''': Partikelzeichenreihenfolge umkehren, d.h. alte Partikel liegen über neu erzeugten
* '''poBlendModeAdd''': Partikelfarben aufaddieren und nicht verblenden

[[Kategorie:Scripting-API]]
[[Kategorie:Partikelsystem]]
[[Kategorie:Language]]

IRichText

2016-06-30T09:07:01Z

Daniel Bärmann: /* Methoden */

'''IRichText''' erlaubt es Diashow-Objekten, die Text enthalten können, diesen mit Formatierungen zu versehen. Um auf die Textformatierung zugreifen zu können muss das Objekt auf IRichText gecastet werden:

<pre>
var Text = Item as IRichText;
</pre>

'''IRichText''' unterstützt die folgenden Methoden:

<pre>
procedure SetRichText(const Value: string);
function GetRichText: string;
procedure SetStyle(const CharIndexBegin, CharIndexEnd: Integer; const RichTextStyle: TRichTextStyle; const SetValues: TRichTextStyleTypes);
function GetStyle(const CharIndex: Integer; out RichTextStyle: TRichTextStyle): Boolean;
property RichText: string read GetRichText write SetRichText;
</pre>

= Methoden =
* Objekt Erzeugung
<pre>
function CreateText: IText;
var richText = CreateText as IRichText;
</pre>

* RichText abrufen oder setzen
<pre>
procedure SetRichText(const Value: string);
function GetRichText: string;
</pre>

Liefert oder setzt den formatierten Text im [https://de.wikipedia.org/wiki/Rich_Text_Format Rich Text-Format]

* Textformatierung setzen oder abrufen
<pre>procedure SetStyle(const CharIndexBegin, CharIndexEnd: Integer; const RichTextStyle: TRichTextStyle; const SetValues: TRichTextStyleTypes);</pre>
Setzt die Formatierung für einen Teil des Textes.

:CharIndexBegin: Nr. des ersten Zeichens, für das die Formatierung gesetzt werden soll (das erste Zeichen hat die Nummer 0)
:CharIndexEnd: Nr. des letzten Zeichens, für das die Formatierung gesetzt werden soll
:RichTextStyle: eine Datenstruktur, die Formatierungsangaben enthält
:SetValues: gibt an, welche der in RichTextStyle gesetzten Formatierungen angewendet werden soll

<pre>function GetStyle(const CharIndex: Integer; out RichTextStyle: TRichTextStyle): Boolean;</pre>
Liefert die Formatierung eines Zeichens

:CharIndex: Nummer des Zeichens, für das die Formatierung ermittelt werden soll (das erste Zeichen hat die Nummer 0)
:RichTextStyle: enthält nach dem Aufruf die Zeichenformatierung

= Beispiel =
<pre>
var RichText = SlideShowObject as IRichText;
if RichText = nil then
Continue;

var TextFormat: TRichTextStyle;
TextFormat.Style := [fsBold];

// Den ganzen Text fett machen
RichText.SetStyle(0, (RichText as IText).Count - 1, TextFormat, [stStyle]);</pre>

[[Kategorie:Scripting-API]]

IRichText

2016-06-30T08:45:48Z

Daniel Bärmann: Die Seite wurde neu angelegt: „'''IRichText''' erlaubt es Diashow-Objekten, die Text enthalten können, diesen mit Formatierungen zu versehen. Um auf die Textformatierung zugreifen zu könne…“

'''IRichText''' erlaubt es Diashow-Objekten, die Text enthalten können, diesen mit Formatierungen zu versehen. Um auf die Textformatierung zugreifen zu können muss das Objekt auf IRichText gecastet werden:

<pre>
var Text = Item as IRichText;
</pre>

'''IRichText''' unterstützt die folgenden Methoden:

<pre>
procedure SetRichText(const Value: string);
function GetRichText: string;
procedure SetStyle(const CharIndexBegin, CharIndexEnd: Integer; const RichTextStyle: TRichTextStyle; const SetValues: TRichTextStyleTypes);
function GetStyle(const CharIndex: Integer; out RichTextStyle: TRichTextStyle): Boolean;
property RichText: string read GetRichText write SetRichText;
</pre>

= Methoden =
* Objekt Erzeugung
<pre>
function CreateText: IText;
var richText = CreateText as IRichText;
</pre>

* RichText abrufen oder setzen
<pre>
procedure SetRichText(const Value: string);
function GetRichText: string;
</pre>

Liefert oder setzt den formatierten Text im [https://de.wikipedia.org/wiki/Rich_Text_Format Rich Text-Format]

* Textformatierung setzen oder abrufen
<pre>procedure SetStyle(const CharIndexBegin, CharIndexEnd: Integer; const RichTextStyle: TRichTextStyle; const SetValues: TRichTextStyleTypes);</pre>
Setzt die Formatierung für einen Teil des Textes.

:CharIndexBegin: Nr. des ersten Zeichens, für das die Formatierung gesetzt werden soll (das erste Zeichen hat die Nummer 0)
:CharIndexEnd: Nr. des letzten Zeichens, für das die Formatierung gesetzt werden soll
:RichTextStyle: eine Datenstruktur, die Formatierungsangaben enthält
:SetValues: gibt an, welche der in RichTextStyle gesetzten Formatierungen angewendet werden soll

<pre>function GetStyle(const CharIndex: Integer; out RichTextStyle: TRichTextStyle): Boolean;</pre>
Lefert die Formatierung eines Zeichens

:CharIndex: Nummer des Zeichens, für das die Formatierung ermittelt werden soll (das erste Zeichen hat die Nummer 0)
:RichTextStyle: enthält nach dem Aufruf die Zeichenformatierung

= Beispiel =
<pre>
var RichText = SlideShowObject as IRichText;
if RichText = nil then
Continue;

var TextFormat: TRichTextStyle;
TextFormat.Style := [fsBold];

// Den ganzen Text fett machen
RichText.SetStyle(0, (RichText as IText).Count - 1, TextFormat, [stStyle]);</pre>

[[Kategorie:Scripting-API]]

DiaShow-Objekte

2016-06-30T08:07:39Z

Daniel Bärmann: /* Allgemeinere Objekte */

Neben den [http://code.google.com/p/dwscript/wiki/Language Befehlen], die Ihnen die Programmiersprache direkt zur Verfügung stellt, gibt haben Sie Zugriff auf die Objekte der Diashow (sonst wäre das ganze ja auch ziemlich sinnlos). Objekte der DiaShow sind die Bilder, Texte, Videos etc. eben alles aus dem sich eine Diashow zusammensetzen kann.

= Verfügbare DiaShow-Objekte =

* [[IPicture]] - Bilder
* [[IText]] - Text
* [[ISound]] - Sounds
* [[IVideo]] - Videos/Filme
* [[IParticle]] - Partikel
* [[IChapter]] - Kapitel
* [[ICollage]] - Statische Collage
* [[ITransformation]] - Flexi-Collage
* [[IPath]] - Animierter Pfad / Routenanimation
* [[IShader]] - Pixelshadereffekte, die auf der GPU laufen
* [[IBlackboxContainer]] - Kapitelobjekte, die als Kindelemente Container für Effektinhalte dienen

Es gibt für jedes Objekt eine Create-Methode, z.B. so:

<code>
var pic: IPicture;
pic := CreatePicture;
var text: IText;
text := CreateText;
</code>

= Allgemeinere Objekte =
* [[ISlideShowObject]] - DiaShow-Objekt - Basis für alle Objekte.
* [[ICanvas]] - Leinwandobjekt/Zeichenfläche zum Zeichnen bzw. Pixelzugriff auf Bilder
* [[IMoveable]], [[IPanable]] - Zugriff auf Bewegungspfad und Kameraschwenk
* [[IRichText]] - Zugriff auf Text-Formatierungen

= Entwickler-Objekte =

Folgende Objekte stehen in der Toolbox nur zur Verfügung, wenn der Entwicklermodus aktiviert wurde:

* Transparentes Kapitel
* "Laufende Linie"
* Blackbox
* Blackbox, horizontal
* Blackbox, vertikal
* Geometrische Form
* Shader

Diese Objekte haben keine richtige Benutzeroberfläche und sind auf die Steuerung per Script angewiesen bzw. haben selbst steuernde Wirkung. Manche Objekte funktionieren nur in einem ganz bestimmten Kontext. Die Entwickler-Objekte werden nun genauer beschrieben:

== Blackbox ==

Eine Blackbox verhält sich wie eine Flexi-Collage, aber ohne Überblendung und ohne Hintergrundfarbe. Was bleibt ist die Möglichkeit, einen Bewegungspfad und einen Kameraschwenk zuzuweisen. Alle in einer Blackbox befindlichen Objekten erben diesen Pfad und Schwenk, so wie es auch bei Flexi-Collagen der Fall ist.

Eine Blackbox wird normalerweise Container für beliebige weitere Objekte verwendet. Ein an die Blackbox angehängtes Script, manipuliert dann den Inhalt in beliebiger Weise. Meist enthält das Script auch eine [[GUI-API|Benutzeroberfläche]], um den Nutzer verschiedene Parameter zur Verfügung zu stellen.

Im Script ist das Blackbox-Objekt einfach nur ein [[ISlideShowObject]], dass aber die Interfaces [[IMoveable]] und [[IPanable]] implementiert.

== Blackbox, horizontal ==

Wie "Blackbox" nur erlaupt die Timeline es nicht, in diesem Objekt mehrere Spuren anzulegen. Ebenso sind Abstände zwischen den Objekten nicht erlaubt. Dieses Objekt wird z.B. als Container für Bilder innerhalb von "Intelligen Vorlagen" eingesetzt. Hier soll der Nutzer keine komplexen Strukturen ablegen dürfen, da diese in die Vorlagen nicht übernommen werden könnten.

== Blackbox, vertikal ==

Wie "Blackbox" nur werden alle eingefügten Objekte auf die Dauer des vertikalen Blackbox gestreckt und jedes erscheint auf einer eigenen Spur.

== Transparentes Kapitel ([[IBlackboxContainer]]) ==

Ein "Transparentes Kapitel" ist kein Objekt mit Funktion innerhalb der Präsentation, sondern dient als Hilfselement für die Benutzeroberfläche, nämlich zur Beschriftung der Spuren. Es ist dafür ausgelegt innerhalb eines Blackbox-Objekts verwendet zu werden. Außerhalb davon ist die Funktionsweise undefiniert. Ein "Transparentes Kapitel" hat immer mindestens die Dauer seines Elternelements, kann aber selbst größer werden. Ansonsten verhält es sich wie ein normales Kapitel, d.h. es unterstützt beliebig viele Spuren und Abstände zwischen den Objekten. Aus Scriptingsicht ist das Objekt ein [[IBlackboxContainer]].

Als Anwendungsbeispiel dient z.B. die "Dynamische Maske":

[[Datei:TransparentesKapitel.png]]

Dieser Effekt besteht aus einer Blackbox, der ein Script angehängt wurde, und zwei transparenten Kapiteln. Die beiden "Transparenten Kapitel" bieten einfach nur Platz für die zwei unterschiedlichen Funkionen (Maske und Inhalt). Das Script schaut in die beiden "Transparenten Kapitel" und macht damit "etwas".

== Geometrische Form ==

Objekt hat keine Funktion. Es war ursprünglich dafür Gedacht, Dreicke oder andere Formen darzustellen. Dafür kann aber das [[IShader|Shader-Objekt]] verwendet werden.

== Shader ([[IShader]]) ==

Über das Shader-Objekt lassen sich Pixelshader ausführen. Ein Shader-Objekt wird immer per Script angelegt und konfiguriert (ist also niemals in der Timeline zu sehen). Es benötigt zum Wirken mindestens den Dateinamen eines [[HLSL-Shader|Pixelshaders (HLSL)]].

[[Kategorie:Scripting-API]]

OnInitDesigner

2012-09-11T13:39:14Z

Daniel Bärmann:

<code>
procedure OnInitDesigner(SlideShowObject: [[ISlideShowObject]]; Context: [[IDesignerContext]])
</code>

Dieser Hook wird vom Layoutdesigner aufgerufen, wenn das Objekt im Layoutdesigner angezeigt werden muss.

Scripts sollten diesen Hook implementieren, wenn sie die Darstellung eines Objektes im Layoutdesigner anpassen möchten.

== Parameter ==

SlideShowObject: [[ISlideShowObject]]

Context: [[IDesignerContext]]

[[Kategorie:Scripting-API]]

OnInitDesigner

2012-09-11T13:38:35Z

Daniel Bärmann:

OnDesignerChanged

2012-09-11T13:36:24Z

Daniel Bärmann:

Dieser Hook wird aufgerufen, wenn Änderungen an einem Diashowobjekt vorgenommen werden, die sich im Layoutdesigner auswirken.
Anhand der Art der Änderung kann das Script die internen Daten aktualisieren.

<code>
procedure OnDesignerChanged(SlideShowObject: [[ISlideShowObject]]; Context: [[IDesignerContext]]; UpdateInfo: [[IDesignerUpdate]]);
</code>

== Parameter ==

SlideShowObject: [[ISlideShowObject]]

Context: [[IDesignerContext]]

UpdateInfo: [[IDesignerUpdate]]

== Rückgabewert ==

Der Rückgabewert bestimmt, wie der Layoutdesigner auf die Aktualisierung reagiert.

* hrDefault: Der Layoutdesigner verhält sich so, wie es der Objekttyp vorgibt. Beispielsweise führt eine Größenänderung eines Bildobjektes nur zum Neuzeichnen, während eine Änderung des Dateinamens eine Neuinitialisierung erforderlich macht.
* hrInvalidate: Das Objekt wird lediglich neu gezeichnet
* hrReinit: Das Objekt wird vollständig neu intialisiert
* hrPreview: Der gesamte Inhalt des Layoutdesigners wird neu erzeugt
[[Kategorie:Scripting-API]]

TDesignerChangeType

2012-09-11T12:32:34Z

Daniel Bärmann: Die Seite wurde neu angelegt: „Gibt die Art der Änderung an einem Diashowobjekt an. * ctDuration: Die Dauer des Objektes hat sich geändert * ctOffset: Die Startzeit in Bezug auf sein überge…“

Gibt die Art der Änderung an einem Diashowobjekt an.

* ctDuration: Die Dauer des Objektes hat sich geändert
* ctOffset: Die Startzeit in Bezug auf sein übergeordnetes Objekt hat sich geändert
* ctContent: Sonstige Objektdaten haben sich geändert (z.B. der Dateiname eines Bildobjektes)
* ctEnabled: Das Objekt wurde aktiviert oder deaktiviert
* ctThumbnail: Ein (neues) Thumbnail für das Objekt wurde erzeugt
* ctMoveable: Der Bewegungspfad des Objektes wurde geändert
* ctTransparency: Die animierte Transparenz wurde geändert
* ctRotation: Der Drehwinkel eines Bewgeungspfadpunktes wurde verändert
* ctSize: Die Größe des Objektes/eines einzelnen Bewegunspfadpunktes wurde geändert
* ctPosition: Die Position des Objektes/eines einzelnen Bewegunspfadpunktes wurde geändert
* ctText: Der Text des Objektes wurde geändert

[[Kategorie:Scripting-API]]

IDesignerChangeTypes

2012-09-11T12:27:40Z

Daniel Bärmann: Die Seite wurde neu angelegt: „Erlaubt den Zugriff auf die Änderungen an einem Diashowobjekt. == Methoden == <code>procedure Add(const Val: TDesignerChangeType)</code> Fügt den Änderu…“

Erlaubt den Zugriff auf die Änderungen an einem Diashowobjekt.

== Methoden ==

<code>procedure Add(const Val: [[TDesignerChangeType]])</code>

Fügt den Änderungen die gegebene hinzu.

<code>function Contains(const Val: [[TDesignerChangeType]]): Boolean</code>

Liefert einen Wert, der angibt, ob die gegebene Änderung in diesem IDesignerChangeTypes-Objekt enthalten ist.

[[Kategorie:Scripting-API]]

IDesignerUpdate

2012-09-11T12:24:24Z

Daniel Bärmann: Die Seite wurde neu angelegt: „Dieses Objekt enthält Informationen über Änderungen an Diashowobjekten und erlaubt dem OnDesignerChanged-Hook diese zu behandeln. == Methoden == <code>fu…“

Dieses Objekt enthält Informationen über Änderungen an Diashowobjekten und erlaubt dem [[OnDesignerChanged]]-Hook diese zu behandeln.

== Methoden ==

<code>function GetChangeType: [[IDesignerChangeTypes]]</code>

Liefert die Art der Änderung.

<code>procedure SetChangeType(const Value: [[IDesignerChangeTypes]])</code>

Setzt die Art der Änderung.

<code>function GetDisplayObject: [[ISlideShowObject]]</code>

Liefert das von der Änderung betroffene Objekt.

<code>procedure SetDisplayObject(const Value: [[ISlideShowObject]])</code>

Setzt das von der Änderung betroffene Objekt.

[[Kategorie:Scripting-API]]

IDesignerContext

2012-09-11T12:20:15Z

Daniel Bärmann: Die Seite wurde neu angelegt: „Das IDesignerContext-Objekt dient zum Austausch von Daten zwischen einem Script und dem Layoutdesigner. == Methoden == <code>procedure SetDisplayObject(SlideSho…“

Das IDesignerContext-Objekt dient zum Austausch von Daten zwischen einem Script und dem Layoutdesigner.

== Methoden ==

<code>procedure SetDisplayObject(SlideShowObject: ISlideShowObject)</code>

Diese Methode sollte im [[OnInitDesigner]]-Hook aufgerufen werden, wenn das Diashowobjekt ein oder mehrere andere Objekte an seiner Statt im Layoutdesigner anzeigen möchte.
Das übergebene Objekt dient bei der Darstellung im Layoutdesigner als "Ersatz" für das Objekt, dessen Script diese Methode aufruft.

<code>function GetDisplayObject: ISlideShowObject</code>

Liefert das Objekt, welches mit SetDisplayObject gesetzt wurde.

<code>procedure SetInternalObject(SlideShowObject: ISlideShowObject)</code>

Setzt ein Objekt als internes Objekt. Hooks, denen ein IDesignerContext übergeben wird können diese Objekte zur internen Verwaltung von Daten verwenden.

<code>function GetInternalObject: ISlideShowObject</code>

Liefert das Objekt, welches mit SetInternalObject gesetzt wurde

[[Kategorie:Scripting-API]]

OnInitDesigner

2012-09-11T12:10:07Z

Daniel Bärmann:

Dieser Hook wird vom Layoutdesigner aufgerufen, wenn das Objekt im Layoutdesigner angezeigt werden muss.

Scripts sollten diesen Hook implementieren, wenn sie die Darstellung eines Objektes im Layoutdesigner anpassen möchten.

== Parameter ==

Context: [[IDesignerContext]]

[[Kategorie:Scripting-API]]

OnInitDesigner

2012-09-11T12:09:31Z

Daniel Bärmann: Die Seite wurde neu angelegt: „Dieser Hook wird vom Layoutdesigner aufgerufen, wenn das Objekt im Layoutdesigner angezeigt werden muss. Scripts sollten diesen Hook implementieren, wenn sie die…“

OnDesignerChanged

2012-09-11T12:06:07Z

Daniel Bärmann:

Dieser Hook wird aufgerufen, wenn Änderungen an einem Diashowobjekt vorgenommen werden, die sich im Layoutdesigner auswirken.
Anhand der Art der Änderung kann das Script die internen Daten aktualisieren.

== Parameter ==

Context: [[IDesignerContext]]

UpdateInfo: [[IDesignerUpdate]]

== Rückgabewert ==

Der Rückgabewert bestimmt, wie der Layoutdesigner auf die Aktualisierung reagiert.

* hrDefault: Der Layoutdesigner verhält sich so, wie es der Objekttyp vorgibt. Beispielsweise führt eine Größenänderung eines Bildobjektes nur zum Neuzeichnen, während eine Änderung des Dateinamens eine Neuinitialisierung erforderlich macht.
* hrInvalidate: Das Objekt wird lediglich neu gezeichnet
* hrReinit: Das Objekt wird vollständig neu intialisiert
* hrPreview: Der gesamte Inhalt des Layoutdesigners wird neu erzeugt
[[Kategorie:Scripting-API]]

OnDesignerChanged

2012-09-11T12:03:51Z

Daniel Bärmann: /* Parameter */

Dieser Hook wird aufgerufen, wenn Änderungen an einem Diashowobjekt vorgenommen werden, die sich im Layoutdesigner auswirken.
Anhand der Art der Änderung kann das Script die internen Daten aktualisieren.

== Parameter ==

Context: [[IDesignerContext]]

UpdateInfo: [[IDesignerUpdate]]

== Rückgabewert ==

Der Rückgabewert bestimmt, wie der Layoutdesigner auf die Aktualisierung reagiert.

* hrDefault: Der Layoutdesigner verhält sich so, wie es der Objekttyp vorgibt. Beispielsweise führt eine Größenänderung eines Bildobjektes nur zum Neuzeichnen, während eine Änderung des Dateinamens eine Neuinitialisierung erforderlich macht.
* hrInvalidate: Das Objekt wird lediglich neu gezeichnet
* hrReinit: Das Objekt wird vollständig neu intialisiert
* hrPreview: Der gesamte Inhalt des Layoutdesigners wird neu erzeugt

OnDesignerChanged

2012-09-11T12:03:31Z

Daniel Bärmann: Die Seite wurde neu angelegt: „Dieser Hook wird aufgerufen, wenn Änderungen an einem Diashowobjekt vorgenommen werden, die sich im Layoutdesigner auswirken. Anhand der Art der Änderung kann d…“

Dieser Hook wird aufgerufen, wenn Änderungen an einem Diashowobjekt vorgenommen werden, die sich im Layoutdesigner auswirken.
Anhand der Art der Änderung kann das Script die internen Daten aktualisieren.

== Parameter ==

Context: [[IDesignerContext]]
UpdateInfo: [[IDesignerUpdate]]

== Rückgabewert ==

Der Rückgabewert bestimmt, wie der Layoutdesigner auf die Aktualisierung reagiert.

* hrDefault: Der Layoutdesigner verhält sich so, wie es der Objekttyp vorgibt. Beispielsweise führt eine Größenänderung eines Bildobjektes nur zum Neuzeichnen, während eine Änderung des Dateinamens eine Neuinitialisierung erforderlich macht.
* hrInvalidate: Das Objekt wird lediglich neu gezeichnet
* hrReinit: Das Objekt wird vollständig neu intialisiert
* hrPreview: Der gesamte Inhalt des Layoutdesigners wird neu erzeugt