Supporting Flystick2+; Fixing github issue #3

Author: ka-ART

CHANGELOG.md

@@ -1,8 +1,18 @@
 
-# List of Unity DTrack plugin releases
+# List of Unity DTrack Plugin releases
 
-## v1.0.0 (2020-25-02)
+## v1.0.3 (2022-05-13)
 
-- Initial release for Unity v2019.1.0f2
-- Supports 6DoF targets (6d), Flysticks 2 and 3 (6df2)
+- Supports additional Flystick2+ buttons and trigger
+- Fixing Flystick parsing error (cf. GitHub issue #3)
+
+## v1.0.2 (2020-07-28)
+
+- Fixing locale issue (cf. GitHub issue #1)
+- Fixing incorrect accessor (cf. GitHub issue #2)
+
+## v1.0.0 (2020-02-25)
+
+- Initial release for Unity 2019.1.0f2 or later
+- Supports 6DOF standard targets (6d), Flysticks (6df2)
 

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2019, Advanced Realtime Tracking GmbH
+Copyright (c) 2019-2022 Advanced Realtime Tracking GmbH & Co. KG
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

README.md

@@ -1,22 +1,25 @@
-# DTrack Plugin for the Unity Game Engine 2019.x
+# DTrack Plugin for Unity Game Engine 2019.x or later
 
 This is a component for Unity 2019.1 or later with the purpose of
 native integration of the Advanded Realtime Tracking (ART) DTrack
-(versions 2 and 3) tracking solutions. This Unity Asset provides
+(DTrack2 or DTrack3) tracking solutions. This Unity Asset provides
 access to DTrack tracking data, that is send over network using
 UDP/IP datagrams. Each UDP packet contains one frame of tracking
 data including all outputs activated via the DTrack software (see
 Section [**DTrack**](#DTrackShortGuide)). This package currently
-supports the DTrack body `6d` and flystick `6df2` data formats.
+supports the DTrack standard body `6d` and Flystick `6df2` data formats.
 
 ## Download <a name="download"></a>
 
 You can download or clone sources for this Asset package at
-[GitHub](http://github.com/ar-tracking/UnityDTrackPlugin)
+[GitHub](http://github.com/ar-tracking/UnityDTrackPlugin).
+
+You can download a ready-to-use Unity package ( UnityDTrackPlugin-vX.X.X.unitypackage ) at
+[GitHub releases](http://github.com/ar-tracking/UnityDTrackPlugin/releases).
 
 ## Prerequisites
 
-To use this Asset the following components are required.
+To use this Asset the following components are required:
 
 - Unity Editor 2019.1 or later
 - Windows 64 bit, Linux 64 bit
@@ -30,6 +33,9 @@ To use this Asset the following components are required.
 In order to create a Unity package from the provided sources, follow
 the steps below.
 
+If you downloaded a ready-to-use Unity package ( UnityDTrackPlugin-vX.X.X.unitypackage ),
+proceed with [**Importing Unity package**](#importing).
+
 1. Download or clone sources for this Asset package ( see [**Download**](#download) )
 - Launch Unity
 - Create new Unity project ( e.g., "MyUnityProject" )
@@ -38,22 +44,25 @@ the steps below.
 - Export package ( right-click on DTrack in the **Project** window and
   select **Export Package...** )
 
-### Importing Unity package
+**Please note:** if you created the Unity package from sources and you want to try the available example scene,
+you need to assign DTrack scripts and to configure the plugin manually ( see [**Plugin Configuration**](#pluginconfiguration) ).
+
+### Importing Unity package <a name="importing"></a>
 
 1. Launch Unity
 - Create/Open Unity project
 - Import package ( *Assets* &rarr; *Import Package...* &rarr; *Custom Package...* )
 
+
 ## DTrack Configuration
 
 Find here a quick-start guide to DTrack. For details, please, refer
 to your DTrack User's Guide and DTrack Programmer's Guide, that is
 shipped with the DTrack distribution. In this section we assume that
 the ART tracking system is properly set up and a room calibration
-was done. Further, a set of 6DOF targets and flysticks are
+was done. Further, a set of 6DOF targets and/or Flysticks are
 calibrated.
 
-
 ### Room Calibration
 
 For general information about the DTrack room calibration and room
@@ -89,14 +98,11 @@ and Z axes, i.e.,<br>
 ![Figure: DTrack and Unity coordinate systems](Doc/images/dtrack-vs-unity.png)
 <br><br>
 
-
 DTrack offers a multitude of ways to adjust coordinate systems for
 room and bodies, e.g., offsets, scaling, additional rotations, or
 shifting the origin of bodies. Consult your manual for details on
 *Room adjustment* and *Body adjustment*.
 
-
-
 ### Setting outputs <a name="DTrackSettingOutputs"></a>
 
 To configure the tracking data stream generated by DTrack, execute
@@ -105,14 +111,13 @@ these steps:
 1. Activate a channel if needed
 - Fill in the IP/Port of the device receiving tracking data
 - Select outputs you are interested in (i.e., currently frame counter `fr`,
-time stamp `ts`, 6DOF standard body `6d` and flystick `6df2` are
+6DOF standard body `6d` and Flystick `6df2` are
 supported) via the menu *Tracking* &rarr; *Output* (DTrack3) or *Settings*
 &rarr; *Output* (DTrack2), respectively.
 
 ![Figure: DTrack output dialog](Doc/images/dtrack-output.png)
 <br><br>
 
-
 ### Data display ( 6DOF ) <a name="DTrackDataDisplay6DOF"></a>
 
 Enable the *data display* view ( *View* &rarr; *Data* ) to find
@@ -123,22 +128,20 @@ tracking volume.
 ![Figure: DTrack data display body](Doc/images/dtrack-data-body.png)
 <br><br>
 
-
 ### Data display ( Flystick ) <a name="DTrackDataDisplayFlystick"></a>
 
-Enable the *flystick* view ( *View* &rarr; *Flystick* ) to find
-assigned flystick IDs. Listed flystick IDs are prefixed with a
-capital **`F`**. When referencing flysticks from within Unity in the
+Enable the *Flystick* view ( *View* &rarr; *Flystick* ) to find
+assigned Flystick IDs. Listed Flystick IDs are prefixed with a
+capital **`F`**. When referencing Flysticks from within Unity in the
 `DTrackReceiverFlystick` mask, this prefix must be removed. In addition to
-position and rotation data, button presses (_b1_,...,_b6_), joystick movement
-(_jx_,_jy_) are illustrated in the table.
+position and rotation data, button presses (_b1_,...,_b8_), joystick movement
+(_jx_,_jy_) and trigger (_jt_) are illustrated in the table.
 
 ![Figure: DTrack data display flystick](Doc/images/dtrack-data-flystick.png)
 <br><br>
 
 
-
-## Plugin Configuration
+## Plugin Configuration <a name="pluginconfiguration"></a>
 
 Streaming position, rotation and button events data from DTrack
 tracking systems to objects in your scene, requires appropriate
@@ -147,7 +150,7 @@ it a name, e.g., **DTrackSource**. To this object attach the
 **DTrack** script via *Add Component* &rarr; *Scripts* &rarr;
 *DTrack* &rarr; *DTrack*. Set *Listen Port* number matching the
 setting for DTrack (see Section [**Setting outputs**](#DTrackSettingOutputs)
-below). Note that 3D position data in the DTrack output stream have unit
+below). Note that 3DOF position data in the DTrack output stream have unit
 millimeters. The DTrack Unity Plugin converts such values to unit meter.
 
 ![Figure: Unity DTrackSource inspector](Doc/images/unity-dtrack-source.png)
@@ -174,18 +177,17 @@ In your scene attach via *Add Component* the DTrack script
 `DTrackReceiverFlystick` to an object you want to receive positional
 and rotational data as well as interactive button and joystick
 events. In the `DTrackReceiverFlystick` mask type in the ID that was
-assigned to the flystick by DTrack
+assigned to the Flystick by DTrack
 (see Section [**Data display (Flysticks)**](#DTrackDataDisplayFlystick)).
 
 ![Figure: Unity Flystick inspector](Doc/images/unity-dtrack-flystick.png)
 <br><br>
 
-
 ### Attaching 6DOF Targets to Camera
 
 For non-static, point-of-view cameras, you can attach a DTrack
 Receiver with positional and rotational data, e.g., 6DOF body or
-flystick.
+Flystick.
 
 ![Figure: Unity POV Camera inspector](Doc/images/unity-dtrack-pov.png)
 <br><br>

Scenes/DTrackExample.unity

@@ -370,7 +370,7 @@ Transform:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 534669902}
   m_LocalRotation: {x: -0, y: -0, z: -0, w: 1}
-  m_LocalPosition: {x: 0, y: 2, z: -10}
+  m_LocalPosition: {x: 0, y: 1, z: -1}
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_Children: []
   m_Father: {fileID: 0}
@@ -487,8 +487,8 @@ Transform:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 788681089}
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
-  m_LocalPosition: {x: 0, y: 0, z: 0}
-  m_LocalScale: {x: 95, y: 95, z: 95}
+  m_LocalPosition: {x: -0.2, y: 0.8, z: 0}
+  m_LocalScale: {x: 0.095, y: 0.095, z: 0.095}
   m_Children:
   - {fileID: 384705472}
   m_Father: {fileID: 0}
@@ -596,8 +596,8 @@ Transform:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 832688257}
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
-  m_LocalPosition: {x: 0, y: 0, z: 0}
-  m_LocalScale: {x: 75, y: 95, z: 75}
+  m_LocalPosition: {x: 0, y: 1.2, z: 0}
+  m_LocalScale: {x: 0.075, y: 0.095, z: 0.075}
   m_Children: []
   m_Father: {fileID: 0}
   m_RootOrder: 4
@@ -704,8 +704,8 @@ Transform:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 1467775502}
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
-  m_LocalPosition: {x: 0, y: 0, z: 0}
-  m_LocalScale: {x: 100, y: 100, z: 100}
+  m_LocalPosition: {x: 0, y: 1, z: 0}
+  m_LocalScale: {x: 0.1, y: 0.1, z: 0.1}
   m_Children: []
   m_Father: {fileID: 0}
   m_RootOrder: 3
@@ -957,8 +957,8 @@ Transform:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 1860915836}
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
-  m_LocalPosition: {x: 0, y: 0, z: 0}
-  m_LocalScale: {x: 125, y: 125, z: 125}
+  m_LocalPosition: {x: 0.2, y: 0.8, z: 0}
+  m_LocalScale: {x: 0.125, y: 0.125, z: 0.125}
   m_Children:
   - {fileID: 1610434898}
   m_Father: {fileID: 0}

Source/DTrack.cs

@@ -1,4 +1,8 @@
-/* Copyright (c) 2019, Advanced Realtime Tracking GmbH
+/* Unity DTrack Plugin: script DTrack
+ *
+ * Main script providing DTrack tracking data to Unity
+ *
+ * Copyright (c) 2019-2022 Advanced Realtime Tracking GmbH & Co. KG
  * 
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -36,15 +40,15 @@
 
 namespace DTrack
 {
+
+
     public class DTrack : MonoBehaviour
     {
         [Tooltip("Port for incoming DTrack tracking data")]
         public int listenPort = 5000;
         [Tooltip("Game objects receiving tracking data from DTrack")]
         public GameObject[] receivers = new GameObject[0];
 
-        //public Axis axis = Axis.XZY;
-
         private IPEndPoint _endPoint;
         private UdpClient _client;
         private Thread _thread;
@@ -55,8 +59,6 @@ public class DTrack : MonoBehaviour
 
         void Start()
         {
-            //usedAxis = this.axis;
-
             _endPoint = new IPEndPoint(IPAddress.Any, listenPort);
 
             _client = new UdpClient(_endPoint);
@@ -68,7 +70,6 @@ void Start()
                     {
                         var result = await _client.ReceiveAsync();
                         var rawString = Encoding.UTF8.GetString(result.Buffer);
-                        //usedAxis = this.axis;
                         var packet = RawParser.Parse(rawString);
                         _currentPacket = packet;
                     }
@@ -86,16 +87,16 @@ void Start()
 
         public void RegisterTarget(GameObject obj)
         {
-            var objs = new List<GameObject>(receivers);
+            var objs = new List< GameObject >( this.receivers );
             objs.Add(obj);
-            receivers = objs.ToArray();
+            this.receivers = objs.ToArray();
         }
 
         public void UnregisterTarget(GameObject obj)
         {
-            var objs = new List<GameObject>(receivers);
+            var objs = new List< GameObject >( this.receivers );
             objs.Remove(obj);
-            receivers = objs.ToArray();
+            this.receivers = objs.ToArray();
         }
 
         void OnDestroy()
@@ -110,11 +111,11 @@ void FixedUpdate()
         {
             if (_currentPacket != null)
             {
-                foreach (var i in receivers)
+                foreach ( var receiver in this.receivers )
                 {
                     try
                     {
-                        i.GetComponent<IDTrackReceiver>().ReceiveDTrackPacket(_currentPacket);
+                        receiver.GetComponent< IDTrackReceiver >().ReceiveDTrackPacket( _currentPacket );
                     }
                     catch (Exception e)
                     {
@@ -124,4 +125,7 @@ void FixedUpdate()
             }
         }
     }
-}
+
+
+}  // namespace DTrack
+

…cts/Interfaces/IEulerRotationProvider.cs Source/DTrackReceiver.csSource/DataObjects/Interfaces/IEulerRotationProvider.cs renamed to Source/DTrackReceiver.cs Source/DataObjects/Interfaces/IEulerRotationProvider.cs renamed to Source/DTrackReceiver.cs

@@ -1,4 +1,8 @@
-/* Copyright (c) 2019, Advanced Realtime Tracking GmbH
+/* Unity DTrack Plugin: script DTrackReceiver
+ *
+ * Abstract class to provide DTrack tracking data to a Game Object
+ *
+ * Copyright (c) 2020-2022 Advanced Realtime Tracking GmbH & Co. KG
  * 
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -25,12 +29,35 @@
  */
 
 using UnityEngine;
+using DTrack.DataObjects;
 
-namespace DTrack.DataObjects.Interfaces
+namespace DTrack
 {
-    public interface IEulerRotationProvider
-    {
-        // ReSharper disable once UnusedMember.Global
-        Vector3 GetEulerRotation();
-    }
+
+
+public abstract class DTrackReceiver : MonoBehaviour, IDTrackReceiver
+{
+	/* DTrack object this receiver is associated to */
+	private DTrack _source = null;
+
+	public abstract void ReceiveDTrackPacket( Packet packet );
+
+	public void Register()
+	{
+		var dtracksource = FindObjectOfType< DTrack >();
+		dtracksource.RegisterTarget( this.gameObject );
+		this._source = dtracksource;
+	}
+
+	public void Unregister()
+	{
+		if ( this._source != null )
+		{
+			this._source.UnregisterTarget( this.gameObject );
+		}
+	}
 }
+
+
+}  // namespace DTrack
+