Class Services

Class Services.

Inheritance

Object

Services

Namespace: Unity.Industrial.Forma.Editor.UI.Service

Syntax

[MovedFrom(true, "UnityEditor.Industrial.Configuring.UI", "Unity.Industrial.Configurator.Editor", null)]
public static class Services

Fields

OnValidateProfileCanChange

Use this event to validate the change of the active profile

Declaration

public static Func<ConfiguratorProfile, bool> OnValidateProfileCanChange

Field Value

Type	Description
Func<ConfiguratorProfile, Boolean>

Methods

CreateExportProfile(Configurator)

Creates the export profile.

Declaration

public static BuildProfile CreateExportProfile(Configurator configurator)

Parameters

Type	Name	Description
Configurator	configurator	The configurator linked to the profile.

Returns

Type	Description
BuildProfile	BuildProfile.

FindConfigurator()

Finds the configurator.

Declaration

public static Configurator FindConfigurator()

Returns

Type	Description
Configurator	Configurator.

IsIn2DMode()

Determines whether [is in2 d mode].

Declaration

public static bool IsIn2DMode()

Returns

Type	Description
Boolean	true if [is in2 d mode]; otherwise, false.

NameFromContextKey(String, ContextCollection, IInfoEngine)

Names from context key.

Declaration

public static string NameFromContextKey(string key, ContextCollection collection, IInfoEngine infoEngine)

Parameters

Type	Name	Description
String	key	The key.
ContextCollection	collection	The collection.
IInfoEngine	infoEngine	The information engine.

Returns

Type	Description
String	System.String.

NameFromContextValue(String, String, ContextCollection, IInfoEngine)

Names from context value.

Declaration

public static string NameFromContextValue(string value, string key, ContextCollection collection, IInfoEngine infoEngine)

Parameters

Type	Name	Description
String	value	The value.
String	key	The key.
ContextCollection	collection	The collection.
IInfoEngine	infoEngine	The information engine.

Returns

Type	Description
String	System.String.

NameFromFeature(Feature, IInfoEngine)

Names from feature.

Declaration

public static string NameFromFeature(Feature feature, IInfoEngine infoEngine)

Parameters

Type	Name	Description
Feature	feature	The feature.
IInfoEngine	infoEngine	The information engine.

Returns

Type	Description
String	System.String.

NameFromFeatureSet(FeatureSet, IInfoEngine)

Names from feature set.

Declaration

public static string NameFromFeatureSet(FeatureSet featureSet, IInfoEngine infoEngine)

Parameters

Type	Name	Description
FeatureSet	featureSet	The feature set.
IInfoEngine	infoEngine	The information engine.

Returns

Type	Description
String	System.String.

RefreshRenderPipeline(Boolean)

Refreshes the render pipeline.

Declaration

public static void RefreshRenderPipeline(bool setDefaultOtherwise = true)

Parameters

Type	Name	Description
Boolean	setDefaultOtherwise	if set to true [set default otherwise].

RefreshUI()

Method to force Forma to refresh all of its UI. This can be useful if after importing or changing some of Forma's underlying data you need to have the UI reflect its new state.

Declaration

public static void RefreshUI()

RemoveUnsupportedPipelineScripts()

Removes URP/HDRP scripts when that pipeline is not in use.

Declaration

public static void RemoveUnsupportedPipelineScripts()

SetCameraAntiAlias(Configurator)

Sets the camera anti alias.

Declaration

public static void SetCameraAntiAlias(Configurator configurator)

Parameters

Type	Name	Description
Configurator	configurator	The configurator.

SetQualityLevelAndRendering(Int32, Boolean)

Sets the quality level and rendering.

Declaration

public static void SetQualityLevelAndRendering(int qualityIndex, bool applyExpensiveChanges = true)

Parameters

Type	Name	Description
Int32	qualityIndex	Index of the quality.
Boolean	applyExpensiveChanges	if set to true [apply expensive changes].

SetSceneViewAntiAlias(Configurator)

Sets the scene view anti alias.

Declaration

public static void SetSceneViewAntiAlias(Configurator configurator)

Parameters

Type	Name	Description
Configurator	configurator	The configurator.

SetupEnvironmentPreview(Configurator)

Setups the environment preview.

Declaration

public static EnvironmentPreview SetupEnvironmentPreview(Configurator configurator)

Parameters

Type	Name	Description
Configurator	configurator	The configurator.

Returns

Type	Description
EnvironmentPreview	EnvironmentPreview.

SetupSceneQuality(Configurator)

Setups the scene quality.

Declaration

public static void SetupSceneQuality(Configurator configurator)

Parameters

Type	Name	Description
Configurator	configurator	The configurator.