Finch Logo

Documentation

Prefabs

There are four main prefabs that provide fast and easy integration of controllers into your Unity appication.

FinchMain prefab

This prefab is necessary on scene if you want to use Finch controllers in this scene. It contains FinchVR script, which is basic class for all controllers functions. Each Unity scene should have only one FinchVR script (or FinchMain prefab) instance in it. FinchVR also contains settings, you can read more about it in Settings section.

FinchSingleController

You can use prefab FinchSingleController if you are sure that your application will use only one controller at a time. It means that the user should have only one Finch controller to use your application. It does not matter how many controllers are connected to device, you will see only one controller in the scene. Will the controller instance be right or left - depends on Preferred Handedness setting.

FinchDualController

You can use prefab FinchDualController if you want to use two controllers at a time. It means that the user should have one or two Finch controllers to use in your application. If there is only one controller connected to the device - your application will work properly, but you will see only one controller in the scene.

FinchAvatar

You can use prefab FinchAvatar, if you want visualize skeletal model (with UnityEngine.Animator) for both single and dual controllers cases. FinchAvatar proceeds character skeletal model animation according to controller position. Allows to visualize not only controllers, but also head, body, arms etc.

Note: It is not recommended to use several Finch controller prefabs in one scene. Read Get Started if you want to know more.

Scenes

SingleControllerScene

Contains FinchMain prefab and FinchSingleController prefab.

DualControllerScene

Contains FinchMain prefab and FinchDualController prefab.

FinchAvatar

Contains FinchMain prefab and FinchAvatar prefab.

Calibration

In Unity SDK you can find a folder named FinchCalibration, it contains ready calibration scenes. You can use this scene as basis for your own calibration environment or simply use it as the first scene of your application. In all the scenes you should write

3DOFCalibrationScene

Contains all necessary steps to calibrate one or two 3DOF controllers. Process of calibration of one and two controllers are different, but you don't have to choose manually, it is detected automatically. All steps are necessary for the calibration, please, don't remove them.

6DOFCalibrationScene

Contains all necessary steps to calibrate one or two 6DOF controllers. All steps are necessary for the calibration, please, don't remove them.

Anthropometry6DOFCalibrationScene

Allows you to calibrate 6DOF contoller for the the user using his body parameters. User have to enter only gender and height, the other parameters (bone lenghts) will be calculated. All steps are necessary for the calibration, please, don't remove them.

Calibration while playing

You could recalibrate your Finch controllers any time while you use them, not only in calbiration scene.

Read Guidelines if you want to know more.