Class RuntimeConfiguratorActions

Methods for changing the Configurator scene at runtime.

Inheritance

Object

RuntimeConfiguratorActions

Namespace: Unity.Industrial.Forma.FormaUIBase

Syntax

public static class RuntimeConfiguratorActions

Properties

Configurator

Configurator

Declaration

public static Configurator Configurator { get; }

Property Value

Type	Description
Configurator

Methods

AddCatalogs(String, IEnumerable<String>, IEnumerable<List<String>>)

Add catalogs from a product source.

Declaration

public static void AddCatalogs(string id, IEnumerable<string> catalogPaths = null, IEnumerable<List<string>> multiPartCatalogPaths = null)

Parameters

Type	Name	Description
String	id	Id of product source to add catalog to
IEnumerable<String>	catalogPaths	Paths to catalogs
IEnumerable<List<String>>	multiPartCatalogPaths

AddCatalogToDefaultSource(String)

Add a new catalog from an addressable to the default product source.

Declaration

public static void AddCatalogToDefaultSource(string uri)

Parameters

Type	Name	Description
String	uri	Path to catalog

AddCCDProductsourceDefault(String, String)

AddCCDProductsourceDefault

Declaration

public static void AddCCDProductsourceDefault(string projectId, string bucketId)

Parameters

Type	Name	Description
String	projectId	Project ID
String	bucketId	Bucket ID

ApplyFeature(Feature)

Apply this feature to the current product and change its configuration.

Declaration

public static void ApplyFeature(Feature feature)

Parameters

Type	Name	Description
Feature	feature	Feature to be applied.

ChangeCamera(StagingElement)

Change the active camera.

Declaration

public static void ChangeCamera(StagingElement newCamera)

Parameters

Type	Name	Description
StagingElement	newCamera	Camera to activate

ChangeContext(String, String)

Change the current product's context.

Declaration

public static void ChangeContext(string contextKey, string contextOption)

Parameters

Type	Name	Description
String	contextKey	Context key
String	contextOption	Context option

ChangeEnvironment(StagingElement)

Change the current Environment

Declaration

public static bool ChangeEnvironment(StagingElement newEnvironment)

Parameters

Type	Name	Description
StagingElement	newEnvironment	Environment to activate

Returns

Type	Description
Boolean	Environment was changed

ChangeProduct(Int32)

Change the active product.

Declaration

public static void ChangeProduct(int productIndex)

Parameters

Type	Name	Description
Int32	productIndex	The index in the product repository of the product to load.

CreateProductSource(String, IEnumerable<String>, List<List<String>>)

Add a new product source.

Declaration

public static MixedProductSource CreateProductSource(string id = "", IEnumerable<string> catalogPaths = null, List<List<string>> multiPartCatalogPaths = null)

Parameters

Type	Name	Description
String	id	Id of product source to add catalog to.
IEnumerable<String>	catalogPaths	catalogPaths
List<List<String>>	multiPartCatalogPaths	multiPartCatalogPaths

Returns

Type	Description
MixedProductSource	MixedProductSource

Exceptions

Type	Condition
NullReferenceException	Throw if MixedProductSource was not found.

ProcessConflictResponse(ConflictEventArgs)

Called by the conflict resolution window to process the conflict response

Declaration

public static void ProcessConflictResponse(ConflictEventArgs args)

Parameters

Type	Name	Description
ConflictEventArgs	args	ConflictEventArgs

RemoveCatalogs(String, IEnumerable<String>, IEnumerable<List<String>>)

Remove catalogs from a product source.

Declaration

public static void RemoveCatalogs(string id, IEnumerable<string> catalogPaths = null, IEnumerable<List<string>> multiPartCatalogPaths = null)

Parameters

Type	Name	Description
String	id	Id of product source to add catalog to
IEnumerable<String>	catalogPaths	Paths to catalogs
IEnumerable<List<String>>	multiPartCatalogPaths

RemoveProductSource(String)

Remove a product source.

Declaration

public static void RemoveProductSource(string id = "")

Parameters

Type	Name	Description
String	id	Id of product source to add catalog to

Events

conflict

Raised if trying to apply the new configuration creates an assignment conflict

Declaration

public static event Action<RuleEngineReply> conflict

Event Type

Type	Description
Action<RuleEngineReply>