Blueprints

Generiert aus UBhapticsSDK2.

Das Target aller Nodes ist "Bhaptics SDK2".

---

Funktionen zum Abspielen Event-gesteuerter Haptik

Spielt die Haptik-Pattern ab, die an ein bestimmtes, in Designer/Portal erstelltes Haptik-Event gebunden sind. Wir empfehlen dringend, diese Funktionen zu verwenden.

Play Haptic

Spielt das Haptik-Event ab. Es ist die grundlegendste Methode, ein Haptik-Event aufzurufen. Es hat den geringsten Overhead aller Funktionen zum Aufrufen von Haptik-Events.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das Sie abspielen möchten.

Outputs

Typ	Name	Beschreibung
exec	Out
Integer	Return Value	Request ID. Sie können die Request ID verwenden, um die Haptik zu stoppen. Bei einem Fehlschlag wird -1 zurückgegeben.

Play Haptic With Option

Spielt ein Haptik-Event ab und passt dabei Stärke, Duration und Richtung der Haptik an.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das Sie abspielen möchten.
Float	Intensity	Die haptische Intensity wird mit diesem Wert multipliziert.
Float	Duration	Die haptische Duration wird mit diesem Wert multipliziert.
Float	Angle X	Dreht die Haptik gegen den Uhrzeigersinn um die globale Vector3.up. Gültiger Bereich: [0.0f - 360.0f]
Float	Offset Y	Bewegt die Haptik nach oben oder unten. Gültiger Bereich: [-0.5f - 0.5f]

Outputs

Typ	Name	Beschreibung
exec	Out
Integer	Return Value	Request ID. Sie können die Request ID verwenden, um die Haptik zu stoppen. Bei einem Fehlschlag wird -1 zurückgegeben.

Play Haptic With StartTime

Spielt ein Haptik-Event ab einer angegebenen Startposition ab und passt dabei Stärke, Duration und Richtung der Haptik an.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das Sie abspielen möchten.
Integer	Start Millis	Startposition der Wiedergabe in Millisekunden. Die ersten Start Millis Millisekunden des Events werden übersprungen (dies ist ein Start-Offset, keine Verzögerung vor der Wiedergabe). Nur Windows/macOS/Android.
Float	Intensity	Die haptische Intensity wird mit diesem Wert multipliziert.
Float	Duration	Die haptische Duration wird mit diesem Wert multipliziert.
Float	Angle X	Dreht die Haptik gegen den Uhrzeigersinn um die globale Vector3.up. Gültiger Bereich: [0.0f - 360.0f]
Float	Offset Y	Bewegt die Haptik nach oben oder unten. Gültiger Bereich: [-0.5f - 0.5f]

Outputs

Typ	Name	Beschreibung
exec	Out
Integer	Return Value	Request ID. Sie können die Request ID verwenden, um die Haptik zu stoppen. Bei einem Fehlschlag wird -1 zurückgegeben.

Play Loop

Spielt die Haptik wiederholt ab. Zusätzlich können Sie, wie bei der Funktion PlayHapticWithOption, Stärke, Duration und Richtung der Haptik anpassen.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das Sie abspielen möchten.
Float	Intensity	Die haptische Intensity wird mit diesem Wert multipliziert.
Float	Duration	Die haptische Duration wird mit diesem Wert multipliziert.
Float	Angle X	Dreht die Haptik gegen den Uhrzeigersinn um die globale Vector3.up. Gültiger Bereich: [0.0f - 360.0f]
Float	Offset Y	Bewegt die Haptik nach oben oder unten. Gültiger Bereich: [-0.5f - 0.5f]
Integer	Interval	Das Zeitintervall zwischen den Wiederholungen, gemessen in Millisekunden.
Integer	Max Count	Die Anzahl der Wiederholungen.

Outputs

Typ	Name	Beschreibung
exec	Out
Integer	Return Value	Request ID. Sie können die Request ID verwenden, um die Haptik zu stoppen. Bei einem Fehlschlag wird -1 zurückgegeben.

Funktionen zum direkten Abspielen von Haptik

Wenn Sie Haptik abspielen möchten, ohne ein neues Event zu erstellen, verwenden Sie diese Funktionen.

Play Dot

Spielt haptisches Feedback am angegebenen Haptik-Aktuator ab. Sie können diese Funktion verwenden, ohne ein Event zu erstellen.

Inputs

Typ	Name	Beschreibung
exec	In
Integer	Position	Typ des Haptik-Geräts.
Array of Integers	Motor Values	Legen Sie die Länge des Arrays entsprechend der Anzahl der Motoren des Geräts fest. Die Werte im Array bezeichnen die Intensity der Motoren. Gültiger Bereich für jeden Wert im Array: [0 - 100]
Float	Seconds	Die Duration der Haptik, gemessen in Sekunden. Ein Wert größer oder gleich 0.1f wird empfohlen.

• Position

  Wert	Gerät
  0	TactSuit Pro
  1	TactSleeve(Left)
  2	TactSleeve(Right)
  3	TactVisor
  4	Tactosy for Hands(Left)
  5	Tactosy for Hands(Right)
  6	Tactosy for Feet(Left)
  7	Tactosy for Feet(Right)
  8	TactGlove(Left)
  9	TactGlove(Right)

Outputs

Typ	Name	Beschreibung
exec	Out
Integer	Return Value	Request ID. Sie können die Request ID verwenden, um die Haptik zu stoppen. Bei einem Fehlschlag wird -1 zurückgegeben.

Play Path

Spielt Haptik um bestimmte Koordinaten herum ab. Weitere Informationen finden Sie in der C++ API Reference.

[TactGlove DK3] Play Path steuert den Handgelenk-Voice-Coil-Motor (VCM) eines DK3-Gloves nicht an.

Inputs

Typ	Name	Beschreibung
exec	In
Integer	Position	Typ des Haptik-Geräts.
Array of Floats	X	Legt die X-Koordinate fest. Gültiger Bereich für jeden Wert im Array: [0.0f - 1.0f]
Array of Floats	Y	Legt die Y-Koordinate fest. Gültiger Bereich für jeden Wert im Array: [0.0f - 1.0f]
Array of Integers	Motor Values	Legen Sie die Länge des Arrays entsprechend der Anzahl der Motoren des Geräts fest. Die Werte im Array bezeichnen die Intensity der Motoren. Gültiger Bereich für jeden Wert im Array: [0 - 100]
Float	Seconds	Die Duration der Haptik, gemessen in Sekunden. Ein Wert größer oder gleich 0.1f wird empfohlen.

• Position

  Wert	Gerät
  0	TactSuit Pro
  1	TactSleeve(Left)
  2	TactSleeve(Right)
  3	TactVisor
  4	Tactosy for Hands(Left)
  5	Tactosy for Hands(Right)
  6	Tactosy for Feet(Left)
  7	Tactosy for Feet(Right)
  8	TactGlove(Left)
  9	TactGlove(Right)

Outputs

Typ	Name	Beschreibung
exec	Out
Integer	Return Value	Request ID. Sie können die Request ID verwenden, um die Haptik zu stoppen. Bei einem Fehlschlag wird -1 zurückgegeben.

Play Waveform

Nur TactGlove. Spielt Haptik im TactGlove ab. Anders als bei "Play Dot" können Sie die haptische Duration und die Änderungen der Vibrations-Intensity fein anpassen. Dies ermöglicht eine noch feinere Darstellung von haptischem Feedback.

Jedes Array muss sechs (TactGlove DK2) oder acht (TactGlove DK3) Elemente enthalten, und alle drei Arrays müssen dieselbe Länge haben.

Inputs

Typ	Name	Beschreibung
exec	In
Integer	Position	Typ des Haptik-Geräts.
Array of Integers	Motor Intensities	Ein Array von Motor-Intensities. Seine Länge muss der Anzahl der Motoren im TactGlove entsprechen: sechs (TactGlove DK2) oder acht (TactGlove DK3). Gültiger Bereich für jeden Wert im Array: [0 - 100]
Array of EBhapticsGlovePlayTime Enums	Play Time Values	Ein Array mit derselben Länge wie Motor Intensities (sechs für DK2, acht für DK3), wobei jedes Element ein Zeitintervall für die Aktuierung darstellt, wobei die Zeit über EBhapticsGlovePlayTime-Enums definiert wird.
Array of EBhapticsGloveShapeValue Enums	Shape Values	Ein Array mit derselben Länge wie Motor Intensities (sechs für DK2, acht für DK3), wobei jedes Element die Form der zeitlichen Änderung der haptischen Intensity darstellt, angegeben durch die EBhapticsGloveShapeValue-Enums.
Integer	Frequency	[Nur TactGlove DK3] Vibrationsfrequenz in Hz der eigenen Aktuatoren des DK3-Gloves. Der Standardwert ist 80. Es hat keine Auswirkung auf DK2-Gloves oder auf den universellen (Nicht-Windows/macOS-)Pfad. Nur Windows/macOS.
Integer	Repeat Count	Anzahl der Wiederholungen der Waveform, ab 1. 0 spielt sie einmal ab. Nur Windows/macOS.

• Position

  Wert	Gerät
  8	TactGlove(Left)
  9	TactGlove(Right)

• Motor Intensities

  Array Index	Motor befindet sich an…
  0	Spitze des Daumens
  1	Spitze des Zeigefingers
  2	Spitze des Mittelfingers
  3	Spitze des Ringfingers
  4	Spitze des kleinen Fingers
  5	Am Handgelenk
  6	An der Handfläche (Daumenseite)
  7	An der Handfläche (Kleinfingerseite)

• Play Time Values

  Wert	Duration	Entspricht…
  EBhapticsGlovePlayTime::None	Keine	0
  EBhapticsGlovePlayTime::FiveMS	5ms	1
  EBhapticsGlovePlayTime::TenMS	10ms	2
  EBhapticsGlovePlayTime::TwentyMS	20ms	4
  EBhapticsGlovePlayTime::ThirtyMS	30ms	6
  EBhapticsGlovePlayTime::FortyMS	40ms	8

• Shape Values

  Wert	Waveform	Entspricht…
  EBhapticsGloveShapeValue::Constant	Konstante Intensity für die Duration	0
  EBhapticsGloveShapeValue::Decreasing	Beginnt bei der angegebenen Intensity und nimmt um die Hälfte ab	1
  EBhapticsGloveShapeValue::Increasing	Beginnt bei der Hälfte der angegebenen Intensity und steigt bis zur angegebenen an.	2

Outputs

Typ	Name	Beschreibung
exec	Out
Integer	Return Value	Request ID. Sie können die Request ID verwenden, um die Haptik zu stoppen. Bei einem Fehlschlag wird -1 zurückgegeben.

Die übrigen Funktionen

Stop Haptic By Event Id

Stoppt das Haptik-Event anhand der Event ID. Gibt zurück, ob das Stoppen erfolgreich war.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das Sie stoppen möchten.

Outputs

Typ	Name	Beschreibung
exec	Out
Boolean	Return Value	Ob das Stoppen erfolgreich war.

Stop Haptic By Request Id

Stoppt das Haptik-Event anhand der Request ID, die von der Funktion zurückgegeben wird, die die Haptik ausführt. Gibt zurück, ob das Stoppen erfolgreich war.

Inputs

Typ	Name	Beschreibung
exec	In
Integer	Request Id	Request ID des abgespielten Haptik-Events, das Sie stoppen möchten.

Outputs

Typ	Name	Beschreibung
exec	Out
Boolean	Return Value	Ob das Stoppen erfolgreich war.

Stop Haptic

Stoppt alle aktuell abgespielten Haptiken. Gibt zurück, ob das Stoppen erfolgreich war.

Inputs

Typ	Name	Beschreibung
exec	In

Outputs

Typ	Name	Beschreibung
exec	Out
Boolean	Return Value	Ob das Stoppen erfolgreich war.

Pause Haptic By Event Id

Pausiert das Haptik-Event anhand der Event ID. Die Wiedergabeposition wird beibehalten, sodass es später mit "Resume Haptic By Event Id" fortgesetzt werden kann.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das Sie pausieren möchten.

Outputs

Typ	Name	Beschreibung
exec	Out

Resume Haptic By Event Id

Setzt ein zuvor mit "Pause Haptic By Event Id" pausiertes Haptik-Event fort und fährt an der Position fort, an der es pausiert wurde.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das Sie fortsetzen möchten.

Outputs

Typ	Name	Beschreibung

Is Playing

Prüft, ob die Haptik abgespielt wird.

Inputs

Typ	Name	Beschreibung
exec	In

Outputs

Typ	Name	Beschreibung
exec	Out
Boolean	Return Value	Ob das Event abgespielt wird.

Is Playing By Event Id

Prüft, ob das Haptik-Event für diese Event ID abgespielt wird.

Inputs

Typ	Name	Beschreibung
exec	In
String	Event Id	Name des Haptik-Events, das auf aktuelle Wiedergabe geprüft werden soll.

Outputs

Typ	Name	Beschreibung
exec	Out
Boolean	Return Value	Ob das Event abgespielt wird.

Is Playing By Request Id

Prüft, ob das Haptik-Event für diese Request ID abgespielt wird.

Inputs

Typ	Name	Beschreibung
exec	In
Integer	Request Id	Request ID des Haptik-Events, das auf aktuelle Wiedergabe geprüft werden soll.

Outputs

Typ	Name	Beschreibung
exec	Out
Boolean	Return Value	Ob das Event abgespielt wird.

Initialize bHaptics

Initialisiert die Haptik-Umgebung. Diese Funktion sollte vor der Nutzung der haptikbezogenen Funktionen aufgerufen werden.

Inputs

Typ	Name	Beschreibung
exec	In

Outputs

Typ	Name	Beschreibung
exec	Out

Ping

Sendet einfaches haptisches Feedback an ein bestimmtes Gerät.

Inputs

Typ	Name	Beschreibung
exec	In
Bhaptics Device Structure	Device	Gerät, an das Sie einen Ping senden möchten.

Outputs

Typ	Name	Beschreibung
exec	Out

Ping All

Sendet einfaches haptisches Feedback an alle verbundenen Geräte.

Inputs

Typ	Name	Beschreibung
exec	In

Outputs

Typ	Name	Beschreibung
exec	Out

Destroy bHaptics

Gibt die Haptik-Umgebung frei. Diese Funktion muss beim Beenden des Spiels aufgerufen werden und darf NUR EINMAL aufgerufen werden.

Inputs

Typ	Name	Beschreibung
exec	In

Outputs

Typ	Name	Beschreibung
exec	Out

Get bHaptics devices

Ruft ein Array mit Informationen über die verbundenen Haptik-Geräte ab.

Inputs

Typ	Name	Beschreibung
exec	In

Outputs

Typ	Name	Beschreibung
exec	Out
Array of Bhaptics Device Structures	Return Value	Liste der Geräte.

Is bHaptics Available

Prüft, ob die Haptik-Umgebung initialisiert und bereit zur Nutzung der haptikbezogenen Funktionen ist.

Inputs

Typ	Name	Beschreibung
exec	In

Outputs

Typ	Name	Beschreibung
exec	Out
Boolean	Return Value	Ob die bHaptics-Umgebung verfügbar ist.

Project To Vest With Player Collision Object

Hilfsfunktion zur Berechnung der Offset-Werte (Winkel und Höhe) eines gegebenen Kollisions-Kontaktpunkts relativ zum Spieler. Diese Offset-Werte können in PlayHapticWithOption und PlayLoop verwendet werden, die die Haptik-Position anpassen können.

Diese Funktion geht davon aus, dass die Vorwärtsrichtung mit der Vorderseite der Vest übereinstimmt, und betrachtet die Position des Spielers als Ursprung.

Weitere Informationen finden Sie in der C++ API Reference.

Inputs

Typ	Name	Beschreibung
Vector	Contact Location	Kontaktpunkt in globalen Koordinaten.
Primitive Component Object Reference	Player Component	Referenz auf die am Spieler angehängte Primitive-Komponente.
Float	Half Height	Der halbe Wert der tatsächlichen Körpergröße des Spielers, gemessen in Zentimetern.

Outputs

Typ	Name	Beschreibung
Bhaptics Rotation Option Structure	Return Value	Offset-Werte.

Project To Vest With Player Location/Position

Hilfsfunktion zur Berechnung von Offset-Werten aus einer Kontaktposition und den Transform-Informationen des Spielers. Sie ähnelt "Project To Vest", berechnet aber nur den Winkel-Offset (Offset Angle X). Die Höhe (Offset Y) ist immer 0.

Inputs

Typ	Name	Beschreibung
Vector	Contact Location	Kontaktpunkt in globalen Koordinaten.
Vector	Player Location	Position des Spielers.
Rotator	Player Rotation	Rotation des Spielers.

Outputs

Typ	Name	Beschreibung
Bhaptics Rotation Option Structure	Return Value	Offset-Werte.

Custom Project To Vest

Hilfsfunktion zur Berechnung von Offset-Werten aus einer Kollision. Erfüllt dieselbe Funktion wie "Project To Vest", erlaubt aber, die Forward- und Up-Vektoren zu ändern.

Inputs

Typ	Name	Beschreibung
Vector	Contact Location	Kontaktpunkt in globalen Koordinaten.
Primitive Component Object Reference	Player Component	Referenz auf die am Spieler angehängte Primitive-Komponente.
Float	Half Height	Der halbe Wert der tatsächlichen Körpergröße des Spielers, gemessen in Zentimetern.
Vector	Up Vector	Der als Referenz dienende Aufwärtsrichtungsvektor für die Offset-Berechnung.
Vector	Forward Vector	Der als Referenz dienende Vorwärtsrichtungsvektor für die Offset-Berechnung.

Outputs

Typ	Name	Beschreibung
Bhaptics Rotation Option Structure	Return Value	Offset-Werte.