Open Commissioning UI

Unity package com.open-commissioning.ui — runtime UI for Open Commissioning (URP, UIToolkit, Input System).

Quick start

1. Add packages — Documentation/Setup.md
   Add com.open-commissioning.ui and com.cqf.outline to Packages/manifest.json, plus host OC assembly, UniTask, and NaughtyAttributes.

2. Configure URP and outline — Documentation/Setup.md, Documentation/Components/Outline.md
   URP renderer with OutlineRendererFeature, volume override, rendering layers Outline_1–Outline_4, post-processing on camera.

3. Set up the scene — Documentation/Scene-Setup.md
   Place Main Camera, Interactions, and one or more Virtual Camera prefabs.

4. Add interactions on devices — Documentation/Components/Interaction.md
   Add Interaction (OC core) on commissioning objects; optional Outline, RuntimeInspector, labels, hide groups.

5. Run and enable tools — Documentation/AppUI/Toolbar-Tools.md
   Turn on Interaction Tool to select objects; use other toolbar tools as needed.

Optional samples: Samples/Basic Demo/0.1 Devices.unity, Tests/Scenes/0.1 Components UI.unity
(package.json lists Samples~/Demo paths that are not in this repository.)

Documentation index

Setup

Document	Description
Setup	Install, dependencies, URP, input, platforms
Scene Setup	Prefabs, hierarchy, checklist, troubleshooting

Components

Document	Description
Virtual Camera	CameraController, Cinemachine prefab
Interaction	OC Interaction + package integration
Outline	URP outline layers and Outline component
Runtime Inspector	Transform fields and undo

Subsystems

Document	Description
Selection Manager	Picking, hover, selection events
Cameras Manager	Virtual camera switching
Panel Manager	Component property panels
Undo System	Runtime undo/redo stack

AppUI

Document	Description
AppUI Overview	Root UI, pointer state, popups
Toolbar Tools	Interaction, Hide, Label, Cameras, etc.

Modules

Document	Description
Panels	Panel handlers and field types
Transform Handles	Move/rotate gizmos
Component Layout	XML layout save/load
Console	Runtime commands
Industrial UI	HMI-style UIToolkit widgets
Scene Gizmo and Selection	Gizmo, box select, tooltips

Package summary

Item	Value
Name	com.open-commissioning.ui
Unity	6000.3+
Pipeline	URP
Key prefabs	Runtime/Prefabs/Main Camera, Interactions, Virtual Camera, AppUI

Architecture

flowchart LR
  UserInput[InputSystem] --> AppUI
  UserInput --> SelectionManager
  UserInput --> CameraController
  SelectionManager --> Interaction
  Interaction --> Outline
  SelectionManager --> PanelManager
  SelectionManager --> RuntimeTransformHandle
  PanelManager --> AppUIRoot[AppUI.Root]
  RuntimeTransformHandle --> RuntimeUndoSystem
  CamerasManager --> CameraController

Loading

License

See LICENSE.md and [Third Party Notices.md](Third Party%20Notices.md).