Skip to content
This repository has been archived by the owner on Apr 15, 2023. It is now read-only.

Amethyst Tracking Devices / Plugins samples for third-party plugins creation.

License

Notifications You must be signed in to change notification settings

KinectToVR/K2TrackingDevice-Samples

Repository files navigation

K2TrackingDevice Samples ( Amethyst 's plugins )

Discord server and I'm 公彦赤屋先#5023

License

This project is licensed under the GNU GPL v3 License

Downloads

You're going to find built plugins in repo Actions, in the run artifact's section.

Build & Deploy

Both build and deployment instructions are available here.

Overview (AME API Devices Docs)

This repository contains sample projects of devices / plugins in terms of Amethyst project.
Each project in the solution is an example of a different possible implementation
of a tracking device (Later referred to as K2TrackingDevice), and an additional one with settings.

You can find a detailed description about every single plugin and device type here.
As for a real-world example, please check out this. (JointsBasis w/ custom settings)

BTW: If you prefer C# to C++ for your device/plugin, please check out this branch for samples.
All device docs are still valid for them, you can also find a small note at the end of the device docs.

Briefly, currently supported device types are:

  • Tracking providers:
    • JointsBasis - Provide a vector of named, tracked joints
    • SkeletonBasis - Provide a fixed array of enumerated, tracked joints
      • Full Character - Provide Joint_Total joints (as many as Kinect V2 does)
      • Simple Character - Provide [ Head, Elbows, Waist, Knees, Ankles, Foot Tips ]
      • Basic Character - Provide [ Head, Waist, Ankles ]
  • Spectator - Only poll data from the app

Please note that SkeletonBasis types can use automatic calibration, whereas JointsBasis cannot.
Additionally, plugins (devices) can provide their own settings, as described here and shown here.