Haply::Inverse::Unity::DeviceMapper
La classe DeviceMapper gère la découverte, le mappage et la gestion de l'état des appareils Haply dans l'environnement Unity. Plus d'informations...
Inherits from Haply.Inverse.Unity.Utilities.Singleton< DeviceMapper >, MonoBehaviour
Types de public
Nom | |
---|---|
classe enum | DeviceInfoPollingMode { Manuel, Une fois, Continu} |
Événements publics
Nom | |
---|---|
Délégué d'État | StateChanged() Événement déclenché lorsque l'état change. |
Action< DeviceMapperState, DeviceMapperState > | StateChangedAsync() Événement d'unité déclenché après le traitement des changements d'état. |
Fonctions publiques
Nom | |
---|---|
délégué vide | StateDelegate(DeviceMapperState state, DeviceMapperState previous) Délégué pour la gestion des changements d'état. |
IEnumerable< Inverse3 > | GetInverse3Devices(HandednessType handedness =HandednessType.Nil) Récupère une collection de dispositifs Inverse3 filtrés par le Handedness spécifié. |
IEnumerable< VerseGrip > | GetVerseGripDevices(HandednessType handedness =HandednessType.Nil) Récupère une collection de dispositifs VerseGrip associés aux dispositifs Inverse3 qui correspondent au handness spécifié. |
Inverse3 | GetInverse3(uint id) Récupère le dispositif Inverse3 correspondant à l'identifiant unique donné. |
Inverse3 | GetInverse3(HandednessType handedness =HandednessType.Nil) Récupère le premier dispositif Inverse3 correspondant au Handedness spécifié. |
Inverse3 | GetInverse3(VerseGrip verseGrip) Récupère le dispositif Inverse3 associé à un dispositif VerseGrip donné. |
VerseGrip | GetVerseGrip(uint id) Récupère le dispositif VerseGrip correspondant à l'identifiant unique donné. |
VerseGrip | GetVerseGrip(HandednessType handedness =HandednessType.Nil) Récupère le premier dispositif VerseGrip correspondant au handness spécifié. |
VerseGrip | GetVerseGrip(Inverse3 inverse3) Récupère le dispositif VerseGrip associé à un dispositif Inverse3 spécifié. |
Objet de jeu | GetDeviceGameObject(uint id) Récupère le GameObject associé à un périphérique mappé, Inverse3 ou VerseGrip, en utilisant l'ID de périphérique spécifié. |
override string | ToString() |
Fonctions protégées
Nom | |
---|---|
virtual override void | Réveil() |
virtual override void | OnEnable() |
virtual override void | OnDisable() |
virtual override void | Mise à jour() |
virtual override void | OnDestroy() |
Propriétés publiques
Nom | |
---|---|
bool | IsReady Vérifie si le mappeur d'appareils est dans l'état "prêt". |
DeviceMapperState | État Obtient ou définit l'état actuel du mappeur de périphériques. |
Connexion client | Connexion client |
Attributs publics
Nom | |
---|---|
UnityEvent | Prêt Événement d'unité déclenché lorsque le mappeur d'appareils est prêt. |
DeviceInfoPollingMode | devicesInfoPollingMode Spécifie le mode d'interrogation des informations sur les appareils. |
flotter | devicesInfoPollDelay Fréquence, en secondes, à laquelle les informations sur les appareils sont automatiquement interrogées. |
Autres membres hérités
Public Functions inherited from Haply.Inverse.Unity.Utilities.Singleton< DeviceMapper >
Nom | |
---|---|
bool | Existe() |
Protected Functions inherited from Haply.Inverse.Unity.Utilities.Singleton< DeviceMapper >
Nom | |
---|---|
vide virtuel | OnApplicationQuit() |
Public Properties inherited from Haply.Inverse.Unity.Utilities.Singleton< DeviceMapper >
Nom | |
---|---|
T | Instance Obtient l'instance de la classe singleton. |
Protected Properties inherited from Haply.Inverse.Unity.Utilities.Singleton< DeviceMapper >
Nom | |
---|---|
bool | ApplicationIsQuitting |
Description détaillée
class Haply::Inverse::Unity::DeviceMapper;
La classe DeviceMapper gère la découverte, le mappage et la gestion de l'état des appareils Haply dans l'environnement Unity.
Il coordonne l'interaction entre le logiciel et les dispositifs physiques, permettant un contrôle et une configuration dynamiques basés sur les conditions d'exécution. Cette classe initialise automatiquement la cartographie des appareils lorsque le composant est activé, en fonction de filtres préconfigurés tels que SelectedId et SelectedHandedness.
Le processus d'initialisation peut être retardé en désactivant le composant au démarrage, ce qui permet de modifier la configuration en cours d'exécution avant d'autoriser le composant à initialiser le mappage des dispositifs.
Documentation sur les types de public
enum DeviceInfoPollingMode
Énumérateur | Valeur | Description |
---|---|---|
Manuel | Désactive l'interrogation automatique des informations sur les appareils. | |
Une fois | Interroge les informations sur le dispositif une fois immédiatement après l'ouverture du dispositif. | |
En continu | Interroge en permanence les informations relatives aux appareils à une fréquence définie par devicesInfoPollDelay. |
Documentation sur les événements publics
événement StateChanged
StateDelegate StateChanged()
Événement déclenché lorsque l'état change.
événement StateChangedAsync
Action< DeviceMapperState, DeviceMapperState > StateChangedAsync()
Événement d'unité déclenché après le traitement des changements d'état.
Documentation sur les fonctions publiques
fonction StateDelegate
delegate void StateDelegate(
DeviceMapperState state,
DeviceMapperState previous
)
Délégué pour la gestion des changements d'état.
fonction GetInverse3Devices
IEnumerable< Inverse3 > GetInverse3Devices(
HandednessType handedness =HandednessType.Nil
)
Récupère une collection de dispositifs Inverse3 filtrés en fonction de la main spécifiée.
Paramètres:
- handness Le handness pour filtrer les appareils, ou Nil pour afficher tous les appareils.
Retour: Une collection énumérable de dispositifs Inverse3 correspondant aux critères d'accessibilité, classés d'abord selon qu'ils sont prêts ou non, puis selon leur état de connexion (ordre décroissant).
fonction GetVerseGripDevices
IEnumerable< VerseGrip > GetVerseGripDevices(
HandednessType handedness =HandednessType.Nil
)
Récupère une collection de dispositifs VerseGrip associés à des dispositifs Inverse3 qui correspondent à la main spécifiée.
Paramètres:
- main La main par laquelle filtrer les appareils, ou Nul pour inclure tous les appareils.
Retour: Une collection énumérable de dispositifs VerseGrip dont les dispositifs Inverse3 correspondants correspondent aux critères de main, classés d'abord selon qu'ils sont prêts ou non, puis selon leur état de connexion (ordre décroissant).
fonction GetInverse3
Inverse3 GetInverse3(
uint id
)
Récupère le dispositif Inverse3 qui correspond à l'identifiant unique donné.
Paramètres:
- id Identifiant unique du dispositif Inverse3.
Retourne: Le dispositif Inverse3 s'il est trouvé ; sinon, null.
fonction GetInverse3
Inverse3 GetInverse3(
HandednessType handedness =HandednessType.Nil
)
Récupère le premier dispositif Inverse3 qui correspond à la main spécifiée.
Paramètres:
- handedness Type de main à comparer aux dispositifs. S'il n'est pas spécifié, la valeur par défaut est HandednessType.Nil, ce qui signifie qu'aucun filtre spécifique n'est appliqué.
Retourne: Le premier dispositif Inverse3 correspondant s'il a été trouvé ; sinon, null.
Les appareils sont classés par ordre de priorité et par ordre de préparation, puis par ordre de connexion (ordre décroissant).
fonction GetInverse3
Inverse3 GetInverse3(
VerseGrip verseGrip
)
Récupère le dispositif Inverse3 associé à un dispositif VerseGrip donné.
Paramètres:
Retourne: Le dispositif Inverse3 lié au VerseGrip spécifié ; sinon, null si aucun lien n'existe.
fonction GetVerseGrip
VerseGrip GetVerseGrip(
uint id
)
Récupère l'appareil VerseGrip qui correspond à l'identifiant unique donné.
Paramètres:
- id Identifiant unique du dispositif VerseGrip.
Retourne: Le dispositif VerseGrip s'il est trouvé ; sinon, null.
fonction GetVerseGrip
VerseGrip GetVerseGrip(
HandednessType handedness =HandednessType.Nil
)
Récupère le premier dispositif VerseGrip qui correspond à la main spécifiée.
Paramètres:
- handedness Type de main à comparer aux dispositifs. S'il n'est pas spécifié, la valeur par défaut est HandednessType.Nil, ce qui signifie qu'aucun filtre spécifique n'est appliqué.
Retourne: Le premier dispositif Inverse3 correspondant s'il a été trouvé ; sinon, null.
Les appareils sont classés par ordre de priorité et par ordre de préparation, puis par ordre de connexion (ordre décroissant).
fonction GetVerseGrip
VerseGrip GetVerseGrip(
Inverse3 inverse3
)
Récupère le dispositif VerseGrip associé à un dispositif Inverse3 spécifié.
Paramètres:
Retourne: Le dispositif VerseGrip lié à l'Inverse3 spécifié ; sinon, null si aucun lien n'existe.
fonction GetDeviceGameObject
GameObject GetDeviceGameObject(
uint id
)
Récupère le GameObject associé à un périphérique mappé, Inverse3 ou VerseGrip, à l'aide de l'ID de périphérique spécifié.
Paramètres:
- id Identifiant unique de l'appareil.
Retourne: Le GameObject associé au périphérique mappé s'il a été trouvé ; sinon, null.
fonction ToString
override string ToString()
Documentation sur les fonctions protégées
fonction Réveil
virtual override void Awake()
Réimplémente: Haply::Inverse::Unity::Utilities::Singleton::Awake
fonction OnEnable
virtual override void OnEnable()
Réimplémente: Haply::Inverse::Unity::Utilities::Singleton::OnEnable
fonction OnDisable
virtual override void OnDisable()
Réimplémente: Haply::Inverse::Unity::Utilities::Singleton::OnDisable
fonction Mise à jour
virtual override void Update()
Réimplémente: Haply::Inverse::Unity::Utilities::Singleton::Update
fonction OnDestroy
virtual override void OnDestroy()
Réimplémente: Haply::Inverse::Unity::Utilities::Singleton::OnDestroy
Documentation sur les biens publics
propriété IsReady
bool IsReady;
Vérifie si le mappeur de périphériques est dans l'état "prêt".
propriété État
DeviceMapperState State;
Obtient ou définit l'état actuel du mappeur de périphériques.
propriété ClientConnection
ClientConnection ClientConnection;
Documentation sur les attributs publics
variable Prêt
UnityEvent Ready;
Événement d'unité déclenché lorsque le mappeur d'appareils est prêt.
variable devicesInfoPollingMode
DeviceInfoPollingMode devicesInfoPollingMode = DeviceInfoPollingMode.Once;
Spécifie le mode d'interrogation des informations sur les appareils.
variable devicesInfoPollDelay
float devicesInfoPollDelay = DEFAULT_INFO_POLL_DELAY;
Fréquence, en secondes, à laquelle les informations sur les appareils sont automatiquement interrogées.
Des valeurs inférieures peuvent entraîner une gigue haptique et une dégradation des performances.