Class UnityUiInstaller
Unity-specific UI installer that manages the complete UI system setup and configuration.
Handles canvas creation, theme application, component factories, and view initialization for Unity UI infrastructure.
Inheritance
UnityUiInstaller
Assembly: Serenity.UnityUi.Installation.dll
Syntax
public class UnityUiInstaller : UiInstaller, IFoundationInstaller, IInstaller
Constructors
UnityUiInstaller(ILogService)
Initializes a new instance of the UnityUiInstaller with the specified log service.
Sets up the installer with logging capabilities for tracking installation progress and issues.
Declaration
public UnityUiInstaller(ILogService logService)
Parameters
| Type |
Name |
Description |
| ILogService |
logService |
The log service for tracking installation operations
|
Properties
FoundationViewElementFactory
Declaration
public IFoundationViewElementFactory FoundationViewElementFactory { get; }
Property Value
Declaration
public IPrimaryInputPromptView PrimaryInputPromptView { get; }
Property Value
UiBackgroundComponentFactory
Declaration
public UnityUiBackgroundComponentFactory UiBackgroundComponentFactory { get; }
Property Value
UiDropdownComponentFactory
Declaration
public UnityUiDropdownComponentFactory UiDropdownComponentFactory { get; }
Property Value
Declaration
public UnityUiInputComponentFactory UiInputComponentFactory { get; }
Property Value
UiSelectorComponentFactory
Declaration
public UnityUiSelectorComponentFactory UiSelectorComponentFactory { get; }
Property Value
UiSliderComponentFactory
Declaration
public UnityUiSliderComponentFactory UiSliderComponentFactory { get; }
Property Value
UiSubmitComponentFactory
Declaration
public UnityUiSubmitComponentFactory UiSubmitComponentFactory { get; }
Property Value
UiToggleComponentFactory
Declaration
public UnityUiToggleComponentFactory UiToggleComponentFactory { get; }
Property Value
UiViewModelFactory
Declaration
public UnityUiViewModelFactory UiViewModelFactory { get; }
Property Value
Methods
GetCanvas()
Gets the Unity Canvas instance created during installation.
Provides access to the root UI canvas for external components.
Declaration
public Canvas GetCanvas()
Returns
| Type |
Description |
| Canvas |
The Unity Canvas instance
|
GetTheme()
Gets the UI theme definition applied during installation.
Provides access to the theme configuration for UI styling and assets.
Declaration
public IUiThemeDefinition GetTheme()
Returns
Installs the complete Unity UI system with the specified configuration.
Orchestrates the installation of settings, factories, canvas, and UI components.
Declaration
public override void Install(UiInstallerInstallInput input)
Parameters
InstallPrimaryInputPromptView(object, IFoundationSettings, IPlayerInputService, string, IUiThemeDefinition, IViewModel)
Declaration
protected IViewBase InstallPrimaryInputPromptView(object canvas, IFoundationSettings settings, IPlayerInputService playerInputService, string audioServiceId, IUiThemeDefinition theme, IViewModel viewModel)
Parameters
Returns
InstallService(IUiSettings, IEventDispatcherService, ILogService)
Declaration
protected override IUiService InstallService(IUiSettings uiSettings, IEventDispatcherService eventDispatcherService, ILogService logService)
Parameters
Returns
InstallServiceFactory()
Declaration
protected override IUiServiceFactory InstallServiceFactory()
Returns
InstallUseCases(IUiService, IUiPresenter)
Declaration
protected override UiUseCases InstallUseCases(IUiService service, IUiPresenter presenter)
Parameters
Returns
Implements