README.md 1.92 KB
Newer Older
Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
1 2
# VAUnity

3
VAUnity provides scripts to ease usage of the VA C# binding ([VACS](http://git.rwth-aachen.de/ita/VACS)) within Unity. For example, you can use the VAUSoundSource script and drop it on a sound source object in order to link it with a VA sound source.
Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
4 5 6 7 8 9 10

# Quick build guide

Clone the repository into the assets folder of your Unity scene.

# Howto

11
If you see the VAU* scripts in your Unity scene, you can start to extend your objects by sound sources and listener(s).
Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
12 13 14

## Connect to VA

15
To connect to VA, drag&drop the VAUAdapter script on any GameObject,. It is recommended to create an empty top level GameObject named "VAConnection".
Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
16 17 18 19 20 21 22 23 24 25 26 27 28

## Listener

Drag&drop the VAUListener script onto the camera rig / ears to create a dynamic listener in VA. The Script will update the pose accordingly based on the transform, i.e. if the movement is connected to a tracking device, the tracked data will be forwared to VA.

## Sound source

Drag&drop the VAUSoundSource script onto any sound object to create a VA sound source. The Script will update the pose accordingly based on the transform, i.e. if the movement is connected to a tracking device, the tracked data will be forwared to VA.

## Auralization modes

You can control the auralization modes via the VAAuraMode script. Auralization modes are either controlling sound sources, listeners or are set globally. VA will only auralize a certain effect, if effects are active for all three, i.e. uses a logic AND combination.

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
29 30 31 32
## Prefabs

Unity has the possibility to create so called prefabs, that combine GameObjects, scripts and settings. You can also use the provided prefabs, like VA.prefab, to create objects that are already configured and are ready to use.

Dipl.-Ing. Jonas Stienen's avatar
Dipl.-Ing. Jonas Stienen committed
33 34
# Extensions

35
Have a look at the [VAUnityExtensions](http://git.rwth-aachen.de/ita/VAUnityExtensions) project to get 3D user interfaces that control VA using menus, like muting, sound level control, direct auralization mode manipulation and more.