Blueprints
Généré depuis UBhapticsSDK2.
La cible de tous les nœuds est "Bhaptics SDK2".
Fonctions de lecture haptique basée sur les événements
Lit les motifs haptiques liés à un événement haptique spécifique créé depuis Designer/Portal. Nous vous recommandons vivement d'utiliser ces fonctions.
Play Haptic
Lit l'événement haptique. C'est la manière la plus simple d'appeler un événement haptique. Cette fonction possède la plus faible surcharge parmi toutes les fonctions d'appel d'événement haptique.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique que vous souhaitez lire. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. Vous pouvez utiliser le Request ID pour arrêter le retour haptique. Retourne -1 en cas d'échec. |
Play Haptic With Option
Lit l'événement haptique en ajustant l'intensité, la durée et la direction du retour haptique.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique que vous souhaitez lire. |
| Float | Intensity | L'Intensity haptique est multipliée par cette valeur. |
| Float | Duration | La Duration haptique est multipliée par cette valeur. |
| Float | Angle X | Fait pivoter le retour haptique dans le sens antihoraire autour du Vector3.up global. Plage valide : [0.0f - 360.0f] |
| Float | Offset Y | Déplace le retour haptique vers le haut ou vers le bas. Plage valide : [-0.5f - 0.5f] |
| Integer | Request Id | Spécifie un Request ID au lieu d'utiliser un ID aléatoire. Les valeurs valides sont 0 ou plus. Si la valeur est omise ou négative, un ID aléatoire est attribué. |
Réutiliser un Request ID
Normalement, si vous lisez un retour haptique pendant qu'un autre est encore en cours de lecture, la nouvelle lecture se superpose à celle en cours. En revanche, si vous le lisez avec les mêmes Event Id et Request Id que le retour haptique en cours, la lecture en cours s'arrête et la nouvelle démarre. Chaque retour haptique est ainsi ressenti plus distinctement, et les retours haptiques ne s'empilent pas lorsqu'ils sont lus de manière répétée à intervalles courts.
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. Vous pouvez utiliser le Request ID pour arrêter le retour haptique. Retourne -1 en cas d'échec. |
Play Haptic With StartTime
Lit l'événement haptique à partir d'une position de départ donnée, en ajustant l'intensité, la durée et la direction du retour haptique.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique que vous souhaitez lire. |
| Integer | Start Millis | Position de départ de la lecture en millisecondes. Les premiers Start Millis millisecondes de l'événement sont ignorées (il s'agit d'un Offset de départ, pas d'un délai avant la lecture). Windows/macOS/Android only. |
| Float | Intensity | L'Intensity haptique est multipliée par cette valeur. |
| Float | Duration | La Duration haptique est multipliée par cette valeur. |
| Float | Angle X | Fait pivoter le retour haptique dans le sens antihoraire autour du Vector3.up global. Plage valide : [0.0f - 360.0f] |
| Float | Offset Y | Déplace le retour haptique vers le haut ou vers le bas. Plage valide : [-0.5f - 0.5f] |
| Integer | Request Id | Spécifie un Request ID au lieu d'utiliser un ID aléatoire. Les valeurs valides sont 0 ou plus. Si la valeur est omise ou négative, un ID aléatoire est attribué. |
Réutiliser un Request ID
Normalement, si vous lisez un retour haptique pendant qu'un autre est encore en cours de lecture, la nouvelle lecture se superpose à celle en cours. En revanche, si vous le lisez avec les mêmes Event Id et Request Id que le retour haptique en cours, la lecture en cours s'arrête et la nouvelle démarre. Chaque retour haptique est ainsi ressenti plus distinctement, et les retours haptiques ne s'empilent pas lorsqu'ils sont lus de manière répétée à intervalles courts.
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. Vous pouvez utiliser le Request ID pour arrêter le retour haptique. Retourne -1 en cas d'échec. |
Play Loop
Lit le retour haptique de façon répétée. De plus, comme la fonction PlayHapticWithOption, vous pouvez ajuster l'intensité, la durée et la direction du retour haptique.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique que vous souhaitez lire. |
| Float | Intensity | L'Intensity haptique est multipliée par cette valeur. |
| Float | Duration | La Duration haptique est multipliée par cette valeur. |
| Float | Angle X | Fait pivoter le retour haptique dans le sens antihoraire autour du Vector3.up global. Plage valide : [0.0f - 360.0f] |
| Float | Offset Y | Déplace le retour haptique vers le haut ou vers le bas. Plage valide : [-0.5f - 0.5f] |
| Integer | Interval | L'intervalle de temps entre les boucles, exprimé en millisecondes. |
| Integer | Max Count | Le nombre de boucles. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. Vous pouvez utiliser le Request ID pour arrêter le retour haptique. Retourne -1 en cas d'échec. |
Fonctions de lecture haptique directe
Si vous souhaitez lire des retours haptiques sans créer de nouvel événement, utilisez ces fonctions.
Play Dot
Lit le retour haptique sur l'actionneur haptique spécifié. Vous pouvez utiliser cette fonction sans créer d'événement.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| Integer | Position | Type de périphérique haptique. |
| Array of Integers | Motor Values | Définissez la longueur du tableau en fonction du nombre de moteurs du périphérique. Les valeurs du tableau représentent l'Intensity des moteurs. Plage valide pour chaque valeur : [0 - 100] |
| Float | Seconds | La Duration du retour haptique, exprimée en secondes. Une valeur supérieure ou égale à 0.1f est recommandée. |
-
Position
Valeur Périphérique 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)
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. Vous pouvez utiliser le Request ID pour arrêter le retour haptique. Retourne -1 en cas d'échec. |
Play Path
Lit le retour haptique autour de coordonnées spécifiques. Consultez la référence C++ API pour plus d'informations.
[TactGlove DK3] Play Path ne pilote pas le moteur à bobine mobile (VCM) du poignet sur un gant DK3.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| Integer | Position | Type de périphérique haptique. |
| Array of Floats | X | Définit la coordonnée X. Plage valide pour chaque valeur : [0.0f - 1.0f] |
| Array of Floats | Y | Définit la coordonnée Y. Plage valide pour chaque valeur : [0.0f - 1.0f] |
| Array of Integers | Motor Values | Définissez la longueur du tableau en fonction du nombre de moteurs du périphérique. Les valeurs du tableau représentent l'Intensity des moteurs. Plage valide pour chaque valeur : [0 - 100] |
| Float | Seconds | La Duration du retour haptique, exprimée en secondes. Une valeur supérieure ou égale à 0.1f est recommandée. |
-
Position
Valeur Périphérique 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)
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. Vous pouvez utiliser le Request ID pour arrêter le retour haptique. Retourne -1 en cas d'échec. |
Play Waveform
TactGlove uniquement. Lit des retours haptiques sur le TactGlove. Contrairement à "Play Dot", vous pouvez régler finement la Duration haptique et les variations d'Intensity de vibration. Cela permet une expression encore plus précise du retour haptique.
Chaque tableau doit contenir six (TactGlove DK2) ou huit (TactGlove DK3) éléments, et les trois tableaux doivent avoir la même longueur.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| Integer | Position | Type de périphérique haptique. |
| Array of Integers | Motor Intensities | Un tableau d'intensités de moteurs. Sa longueur doit correspondre au nombre de moteurs du TactGlove : six (TactGlove DK2) ou huit (TactGlove DK3). Plage valide pour chaque valeur : [0 - 100] |
| Array of EBhapticsGlovePlayTime Enums | Play Time Values | Un tableau de même longueur que Motor Intensities (six pour DK2, huit pour DK3), chaque élément représentant un intervalle de temps d'activation, défini à l'aide des enums EBhapticsGlovePlayTime. |
| Array of EBhapticsGloveShapeValue Enums | Shape Values | Un tableau de même longueur que Motor Intensities (six pour DK2, huit pour DK3), chaque élément représentant la forme des variations d'Intensity haptique dans le temps, spécifiée par les enums EBhapticsGloveShapeValue. |
| Integer | Frequency | [TactGlove DK3 only] Fréquence de vibration en Hz des actionneurs propres au gant DK3. La valeur par défaut est 80. N'a aucun effet sur les gants DK2 ni sur le chemin universel (non-Windows/macOS). Windows/macOS only. |
| Integer | Repeat Count | Nombre de répétitions de la forme d'onde, à partir de 1. 0 la joue une seule fois. Windows/macOS only. |
-
Position
Valeur Périphérique 8 TactGlove(Left) 9 TactGlove(Right) -
Motor Intensities
Index du tableau Position du moteur… 0 Bout du pouce 1 Bout de l'index 2 Bout du majeur 3 Bout de l'annulaire 4 Bout de l'auriculaire 5 Sur le poignet 6 Sur la paume (côté pouce) 7 Sur la paume (côté auriculaire) -
Play Time Values
Valeur Duration Identique à… EBhapticsGlovePlayTime::None Aucune 0 EBhapticsGlovePlayTime::FiveMS 5ms 1 EBhapticsGlovePlayTime::TenMS 10ms 2 EBhapticsGlovePlayTime::TwentyMS 20ms 4 EBhapticsGlovePlayTime::ThirtyMS 30ms 6 EBhapticsGlovePlayTime::FortyMS 40ms 8 -
Shape Values
Valeur Forme d'onde Identique à… EBhapticsGloveShapeValue::Constant Intensity constante pendant la Duration 0 EBhapticsGloveShapeValue::Decreasing Commence à l'Intensity spécifiée et diminue de moitié 1 EBhapticsGloveShapeValue::Increasing Commence à la moitié de l'Intensity spécifiée et augmente jusqu'à l'Intensity spécifiée. 2
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Integer | Return Value | Request ID. Vous pouvez utiliser le Request ID pour arrêter le retour haptique. Retourne -1 en cas d'échec. |
Autres fonctions
Stop Haptic By Event Id
Arrête l'événement haptique par Event ID. Retourne si l'arrêt a réussi.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique que vous souhaitez arrêter. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Indique si l'arrêt a réussi. |
Stop Haptic By Request Id
Arrête l'événement haptique en utilisant le Request ID retourné par la fonction qui exécute le retour haptique. Retourne si l'arrêt a réussi.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| Integer | Request Id | Request ID de l'événement haptique en cours de lecture que vous souhaitez arrêter. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Indique si l'arrêt a réussi. |
Stop Haptic
Arrête tous les retours haptiques en cours de lecture. Retourne si l'arrêt a réussi.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Indique si l'arrêt a réussi. |
Pause Haptic By Event Id
Met en pause l'événement haptique par Event ID. La position de lecture est conservée afin de pouvoir reprendre ultérieurement avec "Resume Haptic By Event Id".
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique que vous souhaitez mettre en pause. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out |
Resume Haptic By Event Id
Reprend un événement haptique précédemment mis en pause avec "Pause Haptic By Event Id", en continuant depuis la position où il a été mis en pause.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique que vous souhaitez reprendre. |
Sorties
| Type | Nom | Description |
|---|
Is Playing
Vérifie si le retour haptique est en cours de lecture.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Indique si l'événement est en cours de lecture. |
Is Playing By Event Id
Vérifie si l'événement haptique correspondant à cet Event ID est en cours de lecture.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| String | Event Id | Nom de l'événement haptique dont vous souhaitez vérifier s'il est en cours de lecture. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Indique si l'événement est en cours de lecture. |
Is Playing By Request Id
Vérifie si l'événement haptique correspondant à ce Request ID est en cours de lecture.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| Integer | Request Id | Request ID de l'événement haptique dont vous souhaitez vérifier s'il est en cours de lecture. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Indique si l'événement est en cours de lecture. |
Initialize bHaptics
Initialise l'environnement haptique. Cette fonction doit être appelée avant d'utiliser les fonctions liées au retour haptique.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out |
Ping
Envoie un retour haptique simple à un périphérique spécifique.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In | |
| Bhaptics Device Structure | Device | Périphérique auquel vous souhaitez envoyer le ping. |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out |
Ping All
Envoie un retour haptique simple à tous les périphériques connectés.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out |
Destroy bHaptics
Détruit l'environnement haptique. Cette fonction doit être appelée à la fin du jeu et ne doit être appelée QU'UNE SEULE FOIS.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out |
Get bHaptics devices
Obtient un tableau d'informations sur les périphériques haptiques connectés.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Array of Bhaptics Device Structures | Return Value | Liste des périphériques. |
Is bHaptics Available
Vérifie si l'environnement haptique est initialisé et prêt à utiliser les fonctions liées au retour haptique.
Entrées
| Type | Nom | Description |
|---|---|---|
| exec | In |
Sorties
| Type | Nom | Description |
|---|---|---|
| exec | Out | |
| Boolean | Return Value | Indique si l'environnement bHaptics est disponible. |
Project To Vest With Player Collision Object
Fonction utilitaire permettant de calculer les valeurs d'Offset (angle et hauteur) d'un point de contact de collision donné par rapport au joueur. Ces valeurs d'Offset peuvent être utilisées dans PlayHapticWithOption et PlayLoop pour ajuster la position haptique.
Cette fonction suppose que la direction avant est alignée avec l'avant du gilet, et la position du joueur est considérée comme l'origine.
Consultez la référence C++ API pour plus d'informations.
Entrées
| Type | Nom | Description |
|---|---|---|
| Vector | Contact Location | Point de contact en coordonnées globales. |
| Primitive Component Object Reference | Player Component | Référence au composant primitif attaché au joueur. |
| Float | Half Height | La moitié de la hauteur réelle du joueur, exprimée en centimètres. |
Sorties
| Type | Nom | Description |
|---|---|---|
| Bhaptics Rotation Option Structure | Return Value | Valeurs d'Offset. |
Project To Vest With Player Location/Position
Fonction utilitaire permettant de calculer les valeurs d'Offset à partir d'un emplacement de contact et des informations de transform du joueur. Similaire à "Project To Vest", mais ne calcule que l'Offset angulaire (Offset Angle X). La hauteur (Offset Y) sera toujours 0.
Entrées
| Type | Nom | Description |
|---|---|---|
| Vector | Contact Location | Point de contact en coordonnées globales. |
| Vector | Player Location | Emplacement du joueur. |
| Rotator | Player Rotation | Rotation du joueur. |
Sorties
| Type | Nom | Description |
|---|---|---|
| Bhaptics Rotation Option Structure | Return Value | Valeurs d'Offset. |
Custom Project To Vest
Fonction utilitaire permettant de calculer les valeurs d'Offset à partir d'une collision. Remplit la même fonction que "Project To Vest", mais permet de modifier les vecteurs Forward et Up.
Entrées
| Type | Nom | Description |
|---|---|---|
| Vector | Contact Location | Point de contact en coordonnées globales. |
| Primitive Component Object Reference | Player Component | Référence au composant primitif attaché au joueur. |
| Float | Half Height | La moitié de la hauteur réelle du joueur, exprimée en centimètres. |
| Vector | Up Vector | Vecteur de direction vers le haut de référence pour le calcul d'Offset. |
| Vector | Forward Vector | Vecteur de direction vers l'avant de référence pour le calcul d'Offset. |
Sorties
| Type | Nom | Description |
|---|---|---|
| Bhaptics Rotation Option Structure | Return Value | Valeurs d'Offset. |