File List

Here is a list of all documented files with brief descriptions:

[detail level 12345]

▼ Assets
▼ VRKB
▼ Audio
63531__florian-reinke__click1.wav	Audio clip that is played on key press in example scenes.
▼ Editor
KeyboardBehaviourEditor.cs	Custom Unity Inspector panel for "KeyboardBehaviour".
RoundedRectEditor.cs	Custom Unity Inspector panel for "RoundedRect".
▼ Examples
VRKB_Oculus_Example.unitypackage	Example VRKB scene using the Oculus SDK. Double-click to unpack.
VRKB_SteamVR1_Example.unitypackage	Example VRKB scene using the SteamVR 1.0 SDK. Double-click to unpack.
VRKB_SteamVR2_Example.unitypackage	Example VRKB scene using the SteamVR 2.0 SDK. Double-click to unpack.
▼ Materials
InputFieldBackgroundMaterial.mat	Material for the background of the keyboard input area.
KeyboardBackplateMaterial.mat	Material used for keyboard backplate.
KeyLabelMaterial_LiberationSansSDF.mat	TextMesh Pro material used for the labels on the keys.
PressedKeyMaterial.mat	Material used for a key when it is pressed down.
UnpressedKeyMaterial.mat	Material used for a key in its default (unpressed) state.
▼ Prefabs
▼ Examples
AudioManagerPrefab.prefab	Prefab that manages sound settings in the example scenes.
HelloCanvasPrefab.prefab	Prefab for "Hello, World!" canvas used in example scenes.
1.5xKeyPrefab.prefab	Prefab for 1.5-unit-wide modifier key (e.g. Shift key).
1xKeyPrefab.prefab	Prefab for a 1-unit-wide keyboard key.
KeyboardPrefab.prefab	Prefab for the default VRKB keyboard.
MalletPrefab.prefab	Prefab for the mallet(s) that are used to strike the keyboard keys.
SpacebarPrefab.prefab	Prefab for the Spacebar key.
▼ Resources
▼ Images	The image files for the icons on the VRKB keyboard.
▼ Scripts
▼ Behaviour
KeyBehaviour.cs	Manages settings for a single key. Detects collisions with mallets and calls KeyPress method on parent keyboard (KeyboardBehaviour).
KeyboardBehaviour.cs	Manages keyboard-wide settings. Parses JSON config file and propagates settings to individual keys (KeyBehaviour objects).
MalletBehaviour.cs	Implement configurable handle length and head radius for the mallets.
▼ Config
Action.cs	Represents the type of action to perform on key press (e.g. "output", "cancel", "confirm"), and an associated argument for that action (if any).
ColorDictionary.cs	Maps color names to corresponding Unity Color objects.
KeyboardConfig.cs	Simple query interface for the JSON config file.
KeyConfig.cs	Represents settings for a single key (e.g. "output", "label").
▼ Event
OnCancelEvent.cs	Stores callbacks to invoke when the user presses the "cancel" key (e.g. red "X" button).
OnConfirmEvent.cs	Stores callbacks to invoke when the user presses the "confirm" key (e.g. green checkmark key).
OnKeyPressEvent.cs	Stores callbacks to invoke every time the user presses a key.
▼ Examples
HelloCanvasBehaviour.cs	Canvas that displays a greeting message, which is used in Oculus/SteamVR example scenes.
▼ Layout
LinearLayoutBehaviour.cs	Positions child game objects at equal distances along a chosen axis (X, Y, or Z).
▼ Mesh
RoundedRect.cs	Procedural mesh for a cube with rounded corners. (Used for keyboard keys.)
Doxygen.cs	Supplementary Doxygen documentation for landing page and non-source-code files.