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.

• iOS 13 or macOS 10.15
• Swift 5.2
• Xcode 11

RUISlider gestures are not working with macOS currently.

• Installation
• Usage
• RealityUI Entities
  • RUISwitch
  • RUIStepper
  • RUISlider
  • RUIButton
• RealityUI Components
  • RUIComponent
  • SwitchComponent
  • StepperComponent
  • SliderComponent
  • ButtonComponent

Add the URL of this repository to your Xcode 11+ Project under Project > Swift Packages.

https://github.com/maxxfrazer/RealityUI.git

Add import RealityUI to the top of your swift file to start.

All components used in RealityUI must be registered before they are used, simply call RealityUI.registerComponents() anywhere in your app before any classes starting with RUI are initialised to avoid issues with that. For more information on what is meant by registering components see Apple's documentation here.

If you plan on using RUISwitch or RUIStepper, then you should at least enable .tap RUISlider uses .pan, but I would just recommend using .all to avoid issues, as these will inevitably move around ad RealityUI develops, and will not interfere with the rest of your RealityKit scene.

arView.enableRealityUIGestures(.all)

For the sake of all these examples, the Simple heading will create an Entity with no custom properties or callbacks, and for Functional, imagine there is a ModelEntity in the scene which we can reference from the variable adjustmentCuboid.

By default all RealityUI Entities are quite large. This is used to standardize the sizes so that you always know what to expect. For example, all UI thumbs are spheres with a diameter of 1 meter, which is 1 unit in RealityKit, ± any padding adjustments. All RealityUI Entities face [0, 0, 1] by default, in the same way as a ModelEntity with a plane mesh.

RUISwitch is a 3D toggle switch with an on and off state.

Default bounding box is 2x1x1m

let newSwitch = RUISwitch()

This RUISwitch will respond to lighting, and will change a ModelEntity's material between a red and a green color.

let newSwitch = RUISwitch(
  RUI: [RUIComponent](#ruicomponent)(respondsToLighting: true),
  changedCallback: { mySwitch in
    adjustmentCuboid.model?.materials = [
      SimpleMaterial(
        color: mySwitch.isOn ? .green : .red,
        isMetallic: false
      )
    ]
  }
)

To customise switches further, see SwitchComponent.

RUIStepper is used to increment or decrement a value.

Default bounding box is 2x1x0.25m

let newStepper = RUIStepper()

This RUIStepper will move a ModelEntity's y position up and down by 0.1m on each tap.

let stepper = RUIStepper(upTrigger: { _ in
  adjustmentCuboid.position.y += 0.1
}, downTrigger: { _ in
  adjustmentCuboid.position.y -= 0.1
})

To customise steppers further, see StepperComponent.

An interactive track to represent an interpolated value.

Default bounding box is 10x1x1m (Including thumb)

let newSlider = RUISlider()

This RUISlider has a starting value of 0.9, meaning that the thumb will be positioned 90% of the way along. The callback function will happen every time the slider value changes (set with isContinuous). The callback function will adjust the x scale of an Entity to the slider's value (0-1), plus an arbitrary value of 0.1.

let newSlider = RUISlider(
  slider: SliderComponent(startingValue: 0.9, isContinuous: true)
) { (slider, _) in
  adjustmentCuboid.scale.x = slider.value + 0.1
}

To customise sliders further, see SliderComponent.

RUIButton is used to initiate a specified action. The action here will only trigger if the gesture begins on a button, and also ends on the same button. This is similar to the touchUpInside UIControl Event.

Default button bounding box before depressing the button into the base is [1, 1, 0.3]

let newButton = RUIButton()

This RUIButton will animate an Entity to a new transform, and change its own button color to .systemGreen.

let button = RUIButton(updateCallback: { myButton in
  adjustmentCuboid.move(
    to: Transform(
      scale: .one,
      rotation: .init(),
      translation: [0, 1, 0]),
    relativeTo: adjustmentCuboid.parent,
    duration: 0.3
  )
  myButton.buttonColor = .systemGreen
})

To customise buttons further, see ButtonComponent.

These components are largely for customising RealityUI entities in terms of colour and sizing. The components default values are great for most use-cases, but there may be times when more customisation is necessary.

SwitchComponent is used for the RUISwitch class, it has properties which affect colour for each model, as well as sizing between components such as the border.

To see more, check out RealityUI+Examples in this repository.