Haply::Inverse::Unity::DeviceBehaviour

Représente la classe de base pour les dispositifs Inverse, fournissant des fonctionnalités communes et une gestion des états.

Hérite de MonoBehaviour

Hérité de Haply.Inverse.Unity.Inverse3, Haply.Inverse.Unity.VerseGrip

Événements publics

	Nom
Action< DeviceBehaviour, Ret >	Événement d'erreur()
ConnectionStateDelegate	ConnectionStateChanged() Événement déclenché lorsque l'état de connexion de l'appareil change.
Action< DeviceBehaviour, DeviceConnectionState, DeviceConnectionState >	ConnectionStateChangedAsync() Événement déclenché peu après le changement d'état de la connexion de l'appareil.

Fonctions publiques

	Nom
délégué vide	ConnectionStateDelegate(DeviceBehaviour device, DeviceConnectionState state, DeviceConnectionState prevState) Délégué pour la gestion des changements d'état de connexion de l'appareil.
vide	SetSetupToPerform() Indique que la configuration doit être effectuée dans la prochaine image.
override string	ToString() Renvoie une représentation sous forme de chaîne de caractères de l'objet, fournissant une description lisible par l'homme qui comprend le nom de l'objet, le type de classe et l'identifiant de l'appareil.

Fonctions protégées

	Nom
vide	InvokeReadyEvent() Invoque l'événement Ready.
vide virtuel	Setup() Cette méthode est automatiquement appelée une fois que le drapeau _performSetup est activé pour gérer les calculs de consommation trop lourds pour être appelés à chaque image.
vide virtuel	Réveil()
vide	OnEnable()
vide	OnDisable()
vide	OnDestroy()
vide virtuel	Mise à jour fixe()

Propriétés publiques

	Nom
DeviceType	Type d'appareil Obtient le type de l'appareil.
int	SelectedDeviceId
uint	DeviceId Obtient l'identifiant de l'appareil.
bool	IsReady Indique si l'appareil est prêt à être utilisé.
Comportement du curseur	Curseur Obtient ou définit le comportement du curseur associé à l'appareil.
DeviceConnectionState	État de la connexion Obtient ou définit l'état de connexion actuel de l'appareil.
bool	EstConnecté Indique si l'appareil est connecté.
bool	IsOpened Indique si l'appareil est ouvert.

Propriétés protégées

	Nom
BaseCoordinateConverter	Convertisseur de coordonnées
bool	IsCursorSet Indique si le curseur a été défini.

Attributs publics

	Nom
const int	ANY_ID
UnityEvent< DeviceBehaviour >	DeviceOpened Événement déclenché lorsque l'état de connexion passe à l'état DeviceConnectionState.Opened.
UnityEvent< DeviceBehaviour >	DeviceClosed Événement déclenché lorsque l'état de connexion passe à l'état DeviceConnectionState.Connected.

Attributs protégés

	Nom
chaîne de caractères	Nom de l'objet

Documentation sur les événements publics

événement ErrorEvent

Action< DeviceBehaviour, Ret > ErrorEvent()

événement ConnectionStateChanged

ConnectionStateDelegate ConnectionStateChanged()

Événement déclenché lorsque l'état de connexion de l'appareil change.

événement ConnectionStateChangedAsync

Action< DeviceBehaviour, DeviceConnectionState, DeviceConnectionState > ConnectionStateChangedAsync()

Événement déclenché peu après le changement d'état de la connexion de l'appareil.

Voir: ConnectionStateChanged

Cet événement est déclenché par le thread principal, ce qui permet des interactions sûres avec les objets de la scène Unity et les éléments de l'interface utilisateur. Notez que l'état de l'appareil est mis à jour sur un thread séparé à haute fréquence, de sorte que l'état au moment de l'événement peut différer légèrement de l'état actuel lors de la gestion de l'événement. Utilisez l'événement ConnectionStateChanged si vous avez besoin de plus de précision.

Documentation sur les fonctions publiques

fonction ConnectionStateDelegate

delegate void ConnectionStateDelegate(
    DeviceBehaviour device,
    DeviceConnectionState state,
    DeviceConnectionState prevState
)

Délégué pour gérer les changements d'état de connexion de l'appareil.

Paramètres:

• state Nouvel état de l'appareil.
• prevState État précédent de l'appareil.
• device L'instance de l'appareil à l'origine de l'événement.

fonction SetSetupToPerform

void SetSetupToPerform()

Indique que la configuration doit être effectuée sur la trame suivante.

Voir: Configuration

fonction ToString

override string ToString()

Renvoie une représentation sous forme de chaîne de caractères de l'objet, fournissant une description lisible par l'homme qui comprend le nom de l'objet, le type de classe et l'identifiant de l'appareil.

Retourner: Une chaîne de caractères représentant l'objet actuel, y compris son nom, son type de classe et l'identifiant de l'appareil.

The returned string follows the format: "name <Class>(#id)", where:

• "nom" est la valeur du champ "nom" de l'objet. _objectName champ.
• "Classe" est le nom du type de classe de l'objet.
• "id" est l'ID de l'appareil, formaté comme une chaîne hexadécimale de 4 caractères, ou "*" si l'ID de l'appareil est ANY_ID. Si DeviceId est ANY_ID, la valeur de SelectedDeviceId est utilisé.

Cette méthode facilite le débogage et la journalisation en fournissant une description concise et informative de l'objet.

Documentation sur les fonctions protégées

fonction InvokeReadyEvent

void InvokeReadyEvent()

Invoque l'événement Ready.

Cette méthode est automatiquement appelée par la propriété IsReady lorsque sa valeur devient vraie. Elle doit être implémentée par les classes dérivées pour déclencher l'événement correspondant.

La propriété IsReady doit être fixée à true dans les classes dérivées lorsque l'appareil est entièrement initialisé et prêt à l'emploi.

fonction Setup

virtual void Setup()

Cette méthode est automatiquement appelée une fois que l'indicateur _performSetup est activé pour gérer les calculs de consommation trop lourds pour être appelés à chaque image.

Réimplémenté par: Haply::Inverse::Unity::Inverse3::Setup

Cette méthode peut être remplacée en prenant soin de conserver l'appel de base. Utiliser SetSetupToPerform pour déclencher l'appel à Setup.

fonction Réveil

virtual void Awake()

fonction OnEnable

void OnEnable()

fonction OnDisable

void OnDisable()

fonction OnDestroy

void OnDestroy()

fonction FixedUpdate

virtual void FixedUpdate()

Réimplémenté par: Haply::Inverse::Unity::Inverse3::FixedUpdate

Documentation sur les biens publics

propriété DeviceType

DeviceType DeviceType;

Obtient le type de l'appareil.

Peut être Inverse.DeviceType.Inverse3, Inverse.DeviceType.VerseGrip ou Inverse.DeviceType.Nil s'il n'est pas déjà défini par le DeviceMapper.

propriété SelectedDeviceId

int SelectedDeviceId;

propriété DeviceId

uint DeviceId;

Obtient l'identifiant de l'appareil.

propriété IsReady

bool IsReady;

Indique si l'appareil est prêt à être utilisé.

propriété Cursor

CursorBehaviour Cursor;

Obtient ou définit le comportement du curseur associé à l'appareil.

propriété ConnectionState

DeviceConnectionState ConnectionState;

Obtient ou définit l'état actuel de la connexion de l'appareil.

L'appareil peut être dans l'état DeviceConnectionState.Disconnected, DeviceConnectionState.Connected ou DeviceConnectionState.Opened. Le changement d'état déclenche les événements correspondants et les notifications de changement d'état.

propriété IsConnected

bool IsConnected;

Indique si l'appareil est connecté.

propriété IsOpened

bool IsOpened;

Indique si le dispositif est ouvert.

Documentation sur les biens protégés

propriété CoordinateConverter

BaseCoordinateConverter CoordinateConverter;

propriété IsCursorSet

bool IsCursorSet;

Indique si le curseur a été défini.

Cette propriété permet d'optimiser les vérifications de l'existence du curseur, car les comparaisons directes avec null peuvent être coûteuses dans Unity.

Documentation sur les attributs publics

variable ANY_ID

static const int ANY_ID = 0;

variable DeviceOpened

UnityEvent< DeviceBehaviour > DeviceOpened;

Événement déclenché lorsque l'état de connexion passe à l'état DeviceConnectionState.Opened.

Voir: ConnectionStateChanged

Cela indique que le dispositif est prêt à être utilisé, avec toutes les données nécessaires, telles que DeviceId et Inverse3.Handedness, correctement initialisées. En fonction du DeviceType, l'instance DeviceBehaviour passée en premier argument peut être castée vers le type correspondant, soit Inverse3, soit VerseGrip.

Cet événement est déclenché par le thread principal, ce qui permet des interactions sûres avec les objets de la scène Unity et les éléments de l'interface utilisateur. Notez que l'état de l'appareil est mis à jour sur un thread séparé à haute fréquence, de sorte que l'état au moment de l'événement peut différer légèrement de l'état actuel lors de la gestion de l'événement. Utilisez l'événement ConnectionStateChanged si vous avez besoin de plus de précision.

variable DeviceClosed

UnityEvent< DeviceBehaviour > DeviceClosed;

Événement déclenché lorsque l'état de connexion passe à l'état DeviceConnectionState.Connected.

Voir: ConnectionStateChanged

Cela indique que le dispositif n'est plus prêt à être utilisé. En fonction du type de dispositif, l'instance de DeviceBehaviour transmise en tant que premier argument peut être convertie dans le type correspondant, soit Inverse3, soit VerseGrip.

Cet événement est déclenché par le thread principal, ce qui permet des interactions sûres avec les objets de la scène Unity et les éléments de l'interface utilisateur. Notez que l'état de l'appareil est mis à jour sur un thread séparé à haute fréquence, de sorte que l'état au moment de l'événement peut différer légèrement de l'état actuel lors de la gestion de l'événement. Utilisez l'événement ConnectionStateChanged si vous avez besoin de plus de précision.

Documentation sur les attributs protégés

variable _objectName

string _objectName;

---