Class ProductRuntimeUI

Base class for creating Runtime UI for a Product. Product

Inheritance

Object

ProductRuntimeUI

ProductUGUIRuntime

Namespace: UnityEngine.Industrial.Configuring.RuntimeUI

Syntax

public abstract class ProductRuntimeUI

Constructors

ProductRuntimeUI(IResourceProvider, IInfoEngine)

Initializes a new instance of the ProductRuntimeUI class.

Declaration

protected ProductRuntimeUI(IResourceProvider resourceProvider, IInfoEngine infoEngine)

Parameters

Type	Name	Description
IResourceProvider	resourceProvider	The resource provider.
IInfoEngine	infoEngine	The information engine.

Fields

contextValueChange

The context value change

Declaration

public EventHandler<UIContextOptionChangeEventArgs> contextValueChange

Field Value

Type	Description
EventHandler<UIContextOptionChangeEventArgs>

currentContext

The current context

Declaration

protected Context currentContext

Field Value

Type	Description
Context

currentProduct

The current product

Declaration

protected Product currentProduct

Field Value

Type	Description
Product

currentProductValueChange

The current product value change

Declaration

public EventHandler<UICurrentProductChangeEventArgs> currentProductValueChange

Field Value

Type	Description
EventHandler<UICurrentProductChangeEventArgs>

featureButtons

The feature buttons

Declaration

protected Dictionary<Feature, IFeatureButton> featureButtons

Field Value

Type	Description
Dictionary<Feature, IFeatureButton>

featureSetDropdowns

The feature set dropdowns

Declaration

protected Dictionary<FeatureSet, IFeatureSetDropdown> featureSetDropdowns

Field Value

Type	Description
Dictionary<FeatureSet, IFeatureSetDropdown>

featureValueChange

The feature value change

Declaration

public EventHandler<UIFeatureOptionChangeEventArgs> featureValueChange

Field Value

Type	Description
EventHandler<UIFeatureOptionChangeEventArgs>

infoEngine

The information engine

Declaration

protected IInfoEngine infoEngine

Field Value

Type	Description
IInfoEngine

infoPanel

The information panel

Declaration

protected IProductInfoPanel infoPanel

Field Value

Type	Description
IProductInfoPanel

productCanvas

The product canvas

Declaration

protected IProductCanvas productCanvas

Field Value

Type	Description
IProductCanvas

resourceProvider

The resource provider

Declaration

protected IResourceProvider resourceProvider

Field Value

Type	Description
IResourceProvider

setupPanel

The setup panel

Declaration

protected IProductSetupPanel setupPanel

Field Value

Type	Description
IProductSetupPanel

stagingOptionChange

The staging option change

Declaration

public EventHandler<UIStagingOptionChangeEventArgs> stagingOptionChange

Field Value

Type	Description
EventHandler<UIStagingOptionChangeEventArgs>

stagingPanel

The staging panel

Declaration

protected IStagingPanel stagingPanel

Field Value

Type	Description
IStagingPanel

uiStatusChange

The UI status change

Declaration

public EventHandler<UIStatusChangeEventArgs> uiStatusChange

Field Value

Type	Description
EventHandler<UIStatusChangeEventArgs>

Properties

canvasInformation

Gets the canvas information.

Declaration

public IProductCanvas canvasInformation { get; }

Property Value

Type	Description
IProductCanvas	The canvas information.

featureSetsInformation

Gets the feature sets information.

Declaration

public IReadOnlyDictionary<FeatureSet, IFeatureSetDropdown> featureSetsInformation { get; }

Property Value

Type	Description
IReadOnlyDictionary<FeatureSet, IFeatureSetDropdown>	The feature sets information.

featuresInformation

Gets the features information.

Declaration

public IReadOnlyDictionary<Feature, IFeatureButton> featuresInformation { get; }

Property Value

Type	Description
IReadOnlyDictionary<Feature, IFeatureButton>	The features information.

infoInformation

Gets the information information.

Declaration

public IProductInfoPanel infoInformation { get; }

Property Value

Type	Description
IProductInfoPanel	The information information.

setupInformation

Gets the setup information.

Declaration

public IProductSetupPanel setupInformation { get; }

Property Value

Type	Description
IProductSetupPanel	The setup information.

stagingInformation

Gets the staging information.

Declaration

public IStagingPanel stagingInformation { get; }

Property Value

Type	Description
IStagingPanel	The staging information.

Methods

BuildFeaturesElements()

Builds the features elements.

Declaration

protected void BuildFeaturesElements()

ClearFeatureDropdownList()

Clears the feature dropdown list.

Declaration

protected void ClearFeatureDropdownList()

CreateContextOption(String)

Creates the context option.

Declaration

protected abstract IContextOptionField CreateContextOption(string key)

Parameters

Type	Name	Description
String	key	The key.

Returns

Type	Description
IContextOptionField	IContextOptionField.

CreateFeatureButton(IFeatureSetDropdown, Feature)

Creates the feature button.

Declaration

protected abstract 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.

CreateFeatureSetDropdown(FeatureSet, Action<IFeatureSetDropdown>)

Creates the feature set dropdown.

Declaration

protected abstract void CreateFeatureSetDropdown(FeatureSet featureSet, Action<IFeatureSetDropdown> callback)

Parameters

Type	Name	Description
FeatureSet	featureSet	The feature set.
Action<IFeatureSetDropdown>	callback	The callback.

CreateFeatureSets(IReadOnlyDictionary<FeatureSet, FeatureAvailability>)

Creates the feature sets.

Declaration

protected void CreateFeatureSets(IReadOnlyDictionary<FeatureSet, FeatureAvailability> featureAvailabilities)

Parameters

Type	Name	Description
IReadOnlyDictionary<FeatureSet, FeatureAvailability>	featureAvailabilities	The feature availabilities.

CreateInfoPanel()

Creates the information panel.

Declaration

protected abstract IProductInfoPanel CreateInfoPanel()

Returns

Type	Description
IProductInfoPanel	IProductInfoPanel.

CreateProductCanvas()

Creates the product canvas.

Declaration

protected abstract IProductCanvas CreateProductCanvas()

Returns

Type	Description
IProductCanvas	IProductCanvas.

CreateRuntimeUI(Product, UIStatus)

Creates a runtime UI for a given products

Declaration

public virtual void CreateRuntimeUI(Product product, UIStatus status = UIStatus.UICreated)

Parameters

Type	Name	Description
Product	product	The product.
UIStatus	status	The status.

CreateSetupPanel()

Creates the setup panel.

Declaration

protected abstract IProductSetupPanel CreateSetupPanel()

Returns

Type	Description
IProductSetupPanel	IProductSetupPanel.

CreateStagingUI(RuntimeStagingSettings)

Creates the staging UI.

Declaration

public abstract void CreateStagingUI(RuntimeStagingSettings runtimeStagingSettings)

Parameters

Type	Name	Description
RuntimeStagingSettings	runtimeStagingSettings	The runtime staging settings.

FocusFeatureSet(String, Boolean, Boolean)

Focuses the feature set.

Declaration

public abstract 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].

RaiseContextOptionChangeEvent(UIContextOptionChangeEventArgs)

Raises the context option change event.

Declaration

protected void RaiseContextOptionChangeEvent(UIContextOptionChangeEventArgs args)

Parameters

Type	Name	Description
UIContextOptionChangeEventArgs	args	The UIContextOptionChangeEventArgs instance containing the event data.

RaiseFeatureOptionChangeEvent(UIFeatureOptionChangeEventArgs)

Raises uiStatusChange event. Called when a feature button is clicked

Declaration

protected void RaiseFeatureOptionChangeEvent(UIFeatureOptionChangeEventArgs args)

Parameters

Type	Name	Description
UIFeatureOptionChangeEventArgs	args	The UIFeatureOptionChangeEventArgs instance containing the event data.

RaiseUICurrentProductChangeEvent(UICurrentProductChangeEventArgs)

Raises the UI current product change event.

Declaration

protected void RaiseUICurrentProductChangeEvent(UICurrentProductChangeEventArgs args)

Parameters

Type	Name	Description
UICurrentProductChangeEventArgs	args	The UICurrentProductChangeEventArgs instance containing the event data.

RaiseUIStagingOptionChangeEvent(UIStagingOptionChangeEventArgs)

Raises the UI staging option change event.

Declaration

protected void RaiseUIStagingOptionChangeEvent(UIStagingOptionChangeEventArgs args)

Parameters

Type	Name	Description
UIStagingOptionChangeEventArgs	args	The UIStagingOptionChangeEventArgs instance containing the event data.

RaiseUIStatusChangeEvent(UIStatusChangeEventArgs)

Raises the UI status change event.

Declaration

protected void RaiseUIStatusChangeEvent(UIStatusChangeEventArgs args)

Parameters

Type	Name	Description
UIStatusChangeEventArgs	args	The UIStatusChangeEventArgs instance containing the event data.

RemoveContextOption(String)

Removes the context option.

Declaration

protected abstract void RemoveContextOption(string key)

Parameters

Type	Name	Description
String	key	The key.

RemoveFeatureButton(IFeatureSetDropdown, Feature)

Removes the feature button.

Declaration

protected abstract void RemoveFeatureButton(IFeatureSetDropdown featureSetDropdown, Feature feature)

Parameters

Type	Name	Description
IFeatureSetDropdown	featureSetDropdown	The feature set dropdown.
Feature	feature	The feature.

RemoveFeatureSetDropdown(FeatureSet)

Removes the feature set dropdown.

Declaration

protected abstract void RemoveFeatureSetDropdown(FeatureSet featureSet)

Parameters

Type	Name	Description
FeatureSet	featureSet	The feature set.

SetActive(Boolean)

Toggles IProductCanvas's Content root on or off

Declaration

public virtual void SetActive(bool active)

Parameters

Type	Name	Description
Boolean	active	if set to true [active].

UpdateContextUI(Context)

Updates the context UI.

Declaration

public abstract void UpdateContextUI(Context context)

Parameters

Type	Name	Description
Context	context	The context.

UpdateFeatureAvailabilities(IReadOnlyDictionary<Feature, FeatureAvailability>)

Updates feature availability information on feature buttons

Declaration

public virtual void UpdateFeatureAvailabilities(IReadOnlyDictionary<Feature, FeatureAvailability> featureAvailabilities)

Parameters

Type	Name	Description
IReadOnlyDictionary<Feature, FeatureAvailability>	featureAvailabilities	The feature availabilities.

Exceptions

Type	Condition
ArgumentNullException	featureAvailabilities

UpdateFeatureSetAvailabilities(Product, IReadOnlyDictionary<FeatureSet, FeatureAvailability>)

Updates featureSet availability information on feature buttons

Declaration

public virtual bool UpdateFeatureSetAvailabilities(Product product, IReadOnlyDictionary<FeatureSet, FeatureAvailability> featureSetAvailabilities)

Parameters

Type	Name	Description
Product	product	The product.
IReadOnlyDictionary<FeatureSet, FeatureAvailability>	featureSetAvailabilities	The feature availabilities.

Returns

Type	Description
Boolean

Exceptions

Type	Condition
ArgumentNullException	featureAvailabilities

UpdatePricingInfo(PricingEngineReply)

Updates the pricing information.

Declaration

public abstract void UpdatePricingInfo(PricingEngineReply pricing)

Parameters

Type	Name	Description
PricingEngineReply	pricing	The pricing.

UpdateProductUI(Product)

Updates the product UI.

Declaration

public abstract void UpdateProductUI(Product product)

Parameters

Type	Name	Description
Product	product	The product.

UpdateStagingUI(StagingType, SwitchStagingElementArgs)

Updates the staging UI.

Declaration

public abstract void UpdateStagingUI(StagingType stagingChangeType, SwitchStagingElementArgs args)

Parameters

Type	Name	Description
StagingType	stagingChangeType	Type of the staging change.
SwitchStagingElementArgs	args	The arguments.