# ``RealityUI``

Use RealityUI to add 3D controls and other useful tools to your AR or VR RealityKit apps.

## Overview

RealityUI is a collection of User Interface classes for RealityKit. The classes included in RealityUI aim to offer familiar User Interface guidelines, but in a 3D setting for Augmented and Virtual Reality through RealityKit.

The User Interface controls in this repository so far are made to be familiar to what people are used to with 2D interfaces, however the plan is to expand the tools on offer to new and unique controls, which are more appropriate for an Augmented Reality and Virtual Reality context.


## Topics

### Setup

It's important to set up your RealityKit scene to work with RealityUI before moving on.

- <doc:Setup>
- <doc:RealityUI/RealityUI>

### RUIControl Elements

- <doc:RUIControls>
- ``RUISwitch``
- ``RUISlider``
- ``RUIButton``
- ``RUIStepper``

### Custom Interaction Events

- ``RUIDragComponent``
- ``RUITapComponent``

### Visual Objects

- ``RUIText``

### RealityUI Object Settings

- ``HasRUI``
- ``HasRUIMaterials``
- ``RUIComponent``
