Class ProductUGUIRuntime

UGUI runtime UI generator for Products

Inheritance
Object
ProductRuntimeUI
ProductUGUIRuntime
Inherited Members
Namespace: UnityEngine.Industrial.Configuring.RuntimeUI
Syntax
public class ProductUGUIRuntime : ProductRuntimeUI

Constructors

ProductUGUIRuntime(IResourceProvider, IInfoEngine)

Creates an instance of UGUI runtime product UI

Declaration
public ProductUGUIRuntime(IResourceProvider resourceProvider, IInfoEngine infoEngine)
Parameters
Type Name Description
IResourceProvider resourceProvider

Resource provider for the UI. You can use DefaultResourceProvider if you don't have one
IInfoEngine infoEngine

Info engine to populate UI elements

Methods

CreateContextOption(String)

Creates the context option.

Declaration
protected override IContextOptionField CreateContextOption(string key)
Parameters
Type Name Description
String key

The key.
Returns
Type Description
IContextOptionField

IContextOptionField.
Overrides

CreateFeatureButton(IFeatureSetDropdown, Feature)

Creates the feature button.

Declaration
protected override IFeatureButton CreateFeatureButton(IFeatureSetDropdown featureSetDropdown, Feature feature)
Parameters
Type Name Description
IFeatureSetDropdown featureSetDropdown

The feature set dropdown.
Feature feature

The feature.
Returns
Type Description
IFeatureButton

IFeatureButton.
Overrides
Exceptions
Type Condition
NullReferenceException

Feature Button can't be null. Please create a prefab with FeatureButton script attached to it.

CreateFeatureSetDropdown(FeatureSet, Action<IFeatureSetDropdown>)

Creates the feature set dropdown.

Declaration
protected override void CreateFeatureSetDropdown(FeatureSet featureSet, Action<IFeatureSetDropdown> callback)
Parameters
Type Name Description
FeatureSet featureSet

The feature set.
Action<IFeatureSetDropdown> callback

The callback.
Overrides

CreateInfoPanel()

Creates the information panel.

Declaration
protected override IProductInfoPanel CreateInfoPanel()
Returns
Type Description
IProductInfoPanel

IProductInfoPanel.
Overrides

CreateProductCanvas()

Creates the product canvas.

Declaration
protected override IProductCanvas CreateProductCanvas()
Returns
Type Description
IProductCanvas

IProductCanvas.
Overrides

CreateSetupPanel()

Creates the setup panel.

Declaration
protected override IProductSetupPanel CreateSetupPanel()
Returns
Type Description
IProductSetupPanel

IProductSetupPanel.
Overrides

CreateStagingUI(RuntimeStagingSettings)

Creates Staging UI if staging prefab is provided

Declaration
public override void CreateStagingUI(RuntimeStagingSettings runtimeStagingSettings)
Parameters
Type Name Description
RuntimeStagingSettings runtimeStagingSettings

The runtime staging settings.
Overrides

FocusFeatureSet(String, Boolean, Boolean)

Focuses UI on the feature set dropdown and expands its view

Declaration
public override void FocusFeatureSet(string setname, bool on, bool closeOthers = false)
Parameters
Type Name Description
String setname

The setname.
Boolean on

if set to true [on].
Boolean closeOthers

if set to true [close others].
Overrides

RemoveContextOption(String)

Removes the context option.

Declaration
protected override void RemoveContextOption(string key)
Parameters
Type Name Description
String key

The key.
Overrides

RemoveFeatureButton(IFeatureSetDropdown, Feature)

Removes the feature button.

Declaration
protected override void RemoveFeatureButton(IFeatureSetDropdown featureSetDropdown, Feature feature)
Parameters
Type Name Description
IFeatureSetDropdown featureSetDropdown

The feature set dropdown.
Feature feature

The feature.
Overrides
Exceptions
Type Condition
Exception

Feature button: {feature.code}, does not exist!

RemoveFeatureSetDropdown(FeatureSet)

Removes the feature set dropdown.

Declaration
protected override void RemoveFeatureSetDropdown(FeatureSet featureSet)
Parameters
Type Name Description
FeatureSet featureSet

The feature set.
Overrides
Exceptions
Type Condition
Exception

Feature set dropdown: {featureSet.code}, does not exist!

UpdateContextUI(Context)

Updates context option selections

Declaration
public override void UpdateContextUI(Context context)
Parameters
Type Name Description
Context context

The context.
Overrides

UpdatePricingInfo(PricingEngineReply)

Updates the pricing information.

Declaration
public override void UpdatePricingInfo(PricingEngineReply pricing)
Parameters
Type Name Description
PricingEngineReply pricing

The pricing.
Overrides

UpdateProductUI(Product)

Updates the canvas with a given product

Declaration
public override void UpdateProductUI(Product product)
Parameters
Type Name Description
Product product

New Product to be displayed
Overrides

UpdateStagingUI(StagingType, SwitchStagingElementArgs)

Updates staging UI change

Declaration
public override void UpdateStagingUI(StagingType stagingChangeType, SwitchStagingElementArgs args)
Parameters
Type Name Description
StagingType stagingChangeType

Type of the staging change.
SwitchStagingElementArgs args

The arguments.
Overrides