Class RuntimeConfiguratorSceneData
Class for accessing Configurator scene data.
Namespace: Unity.Industrial.Forma.FormaUIBase
Syntax
public class RuntimeConfiguratorSceneDataConstructors
RuntimeConfiguratorSceneData(Configurator)
constructor
Declaration
public RuntimeConfiguratorSceneData(Configurator configurator)Parameters
| Type | Name | Description |
|---|---|---|
| Configurator | configurator |
Properties
configurator
Configurator
Declaration
public Configurator configurator { get; }Property Value
| Type | Description |
|---|---|
| Configurator |
currentProduct
Active product
Declaration
public Product currentProduct { get; }Property Value
| Type | Description |
|---|---|
| Product |
currentProductIndex
Product index in the repository
Declaration
public int currentProductIndex { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
productNames
Names of all products in repository
Declaration
public List<string> productNames { get; }Property Value
| Type | Description |
|---|---|
| List<String> |
Methods
Cameras()
List of available cameras and their display info
Declaration
public IEnumerable<(DisplayInfoContent, StagingElement)> Cameras()Returns
| Type | Description |
|---|---|
| IEnumerable<(T1, T2)<DisplayInfoContent, StagingElement>> | List of available cameras and their display info |
ContextDisplayInfo()
Context display info
Declaration
public ContextCollectionDisplayInfo ContextDisplayInfo()Returns
| Type | Description |
|---|---|
| ContextCollectionDisplayInfo | Context display info |
Contexts()
Contexts
Declaration
public ContextCollection Contexts()Returns
| Type | Description |
|---|---|
| ContextCollection | Contexts |
CurrentCamera()
Active camera
Declaration
public StagingElement CurrentCamera()Returns
| Type | Description |
|---|---|
| StagingElement | Active camera |
EnvironmentDisplayInfo()
List of all environments with their display info
Declaration
public IEnumerable<(DisplayInfoContent, StagingItem)> EnvironmentDisplayInfo()Returns
| Type | Description |
|---|---|
| IEnumerable<(T1, T2)<DisplayInfoContent, StagingItem>> | List of all environments with their display info |
Environments()
List of availible environments
Declaration
public IEnumerable<StagingItemRow> Environments()Returns
| Type | Description |
|---|---|
| IEnumerable<StagingItemRow> | List of environments |
FeatureDisplayInfo(Feature)
Feature display info
Declaration
public FeatureDisplayInfo FeatureDisplayInfo(Feature feature)Parameters
| Type | Name | Description |
|---|---|---|
| Feature | feature |
Returns
| Type | Description |
|---|---|
| FeatureDisplayInfo | Feature display info |
FeatureDisplayInfos(List<Feature>)
Returns a list of FeatureDisplayInfo(Feature) for a specified list of Features
Declaration
public List<FeatureDisplayInfo> FeatureDisplayInfos(List<Feature> features)Parameters
| Type | Name | Description |
|---|---|---|
| List<Feature> | features | List of Features for which we want the display information |
Returns
| Type | Description |
|---|---|
| List<FeatureDisplayInfo> | List of FeatureDisplayInfo(Feature) |
FeatureIsSelected(Feature)
Is Feature Selected?
Declaration
public bool FeatureIsSelected(Feature feature)Parameters
| Type | Name | Description |
|---|---|---|
| Feature | feature |
Returns
| Type | Description |
|---|---|
| Boolean | is selected |
GetSelectedEnvironment()
Returns either the selected environment or the first environment in the list if none are selected.
Declaration
public StagingItemRow GetSelectedEnvironment()Returns
| Type | Description |
|---|---|
| StagingItemRow |
IsStagingManagerBusy()
Is an environment being loaded or unloaded
Declaration
public static bool IsStagingManagerBusy()Returns
| Type | Description |
|---|---|
| Boolean | Staging manager is busy loading or unloading an environment |
ProductFeatureChangesForPack(Pack)
Returns list of all current features that will be changed on the product if given Pack is applied.
Declaration
public List<Feature> ProductFeatureChangesForPack(Pack pack)Parameters
| Type | Name | Description |
|---|---|---|
| Pack | pack | Pack to be applied |
Returns
| Type | Description |
|---|---|
| List<Feature> | List of current product features that will be changed |
Products()
Get configurator products;
Declaration
public IEnumerable<AssetProductReference> Products()Returns
| Type | Description |
|---|---|
| IEnumerable<AssetProductReference> | IEnumerable<AssetProductReference> |