Class ProfileDefinition
Class ProfileDefinition.
Inherited Members
Namespace: Unity.Industrial.Forma.Core.Profiles
Syntax
[MovedFrom(true, "UnityEngine.Industrial.Configuring.ConfiguratorRuntime", "Unity.Industrial.Configurator", null)]
[CreateAssetMenu(menuName = "Forma/Profile Definition", fileName = "Profile Definition", order = 10)]
[Serializable]
public class ProfileDefinition : ScriptableObject
Constructors
ProfileDefinition()
Initializes a new instance of the ProfileDefinition class.
Declaration
public ProfileDefinition()
Fields
anyProfileDefinitionChanged
Any profile definition changed
Declaration
public static Action<ProfileDefinitionChangedArgs> anyProfileDefinitionChanged
Field Value
Type | Description |
---|---|
Action<ProfileDefinitionChangedArgs> |
profiles
The profiles
Declaration
[SerializeField]
public List<ConfiguratorProfile> profiles
Field Value
Type | Description |
---|---|
List<ConfiguratorProfile> |
Properties
ActiveProfile
The Active Profile
Declaration
public ConfiguratorProfile ActiveProfile { get; set; }
Property Value
Type | Description |
---|---|
ConfiguratorProfile |
ActiveProfileReferenceId
Gets or sets the active profile reference.
Declaration
public string ActiveProfileReferenceId { get; set; }
Property Value
Type | Description |
---|---|
String | The active profile reference. |
ConfiguratorScenes
The scenes housing the configurators that use this build profile
Declaration
public List<SceneReference> ConfiguratorScenes { get; set; }
Property Value
Type | Description |
---|---|
List<SceneReference> |
Methods
AddConfiguratorUser(Configurator)
Add configurator to list of configurators using this profile
Declaration
public void AddConfiguratorUser(Configurator configurator)
Parameters
Type | Name | Description |
---|---|---|
Configurator | configurator | Configurator to add |
FirstProfileReference()
Creates a ConfiguratorProfileReference for the first Profile in this ProfileDefinition
Declaration
public ConfiguratorProfileReference FirstProfileReference()
Returns
Type | Description |
---|---|
ConfiguratorProfileReference | ConfiguratorProfileReference. |
IsUsedWithConfigurator(Configurator)
Check if passed configurator uses this build profile
Declaration
public bool IsUsedWithConfigurator(Configurator configurator)
Parameters
Type | Name | Description |
---|---|---|
Configurator | configurator | Configurator to check |
Returns
Type | Description |
---|---|
Boolean | True if passed configurator uses this build profile and false otherwise |
ProfileReference(ConfiguratorProfile)
Creates a ConfiguratorProfileReference for the provided Profile.
Declaration
public ConfiguratorProfileReference ProfileReference(ConfiguratorProfile profile)
Parameters
Type | Name | Description |
---|---|---|
ConfiguratorProfile | profile | The profile. |
Returns
Type | Description |
---|---|
ConfiguratorProfileReference | ConfiguratorProfileReference. |
RemoveConfiguratorUser(Configurator)
Remove configurator from list of configurators using this profile
Declaration
public void RemoveConfiguratorUser(Configurator configurator)
Parameters
Type | Name | Description |
---|---|---|
Configurator | configurator | Configurator to remove |