Class FormaCatalogLoader

Class FormaCatalogLoader.

Inheritance

Object

FormaCatalogLoader

Namespace: UnityEngine.Industrial.Configuring.Core

Syntax

public class FormaCatalogLoader

Constructors

FormaCatalogLoader(String)

Catalog loader that dynamically update the '{FORMA_CATALOG_PATH}' aa runtime variable before resolving catalog content dependencies. Note: Forma catalogs needs to be loaded synchronously, otherwise dependencies won't load correctly.

Declaration

public FormaCatalogLoader(string fullPath)

Parameters

Type	Name	Description
String	fullPath	Load a catalog with a URL or a folder path

Exceptions

Type	Condition
Exception	Throw if catalog paath / url is empty

Fields

AaFolderRootPath

The aa folder root path

Declaration

public string AaFolderRootPath

Field Value

Type	Description
String

KDynamicAaVariableName

The k dynamic aa variable name

Declaration

public const string KDynamicAaVariableName = "FORMA_CATALOG_PATH"

Field Value

Type	Description
String

RelativeCatalogPath

The relative catalog path

Declaration

public string RelativeCatalogPath

Field Value

Type	Description
String

Properties

CatalogPath

Gets the catalog path.

Declaration

public string CatalogPath { get; }

Property Value

Type	Description
String	The catalog path.

IsLoaded

Gets a value indicating whether this instance is loaded.

Declaration

public bool IsLoaded { get; }

Property Value

Type	Description
Boolean	true if this instance is loaded; otherwise, false.

IsLoading

Gets a value indicating whether this instance is loading.

Declaration

public bool IsLoading { get; }

Property Value

Type	Description
Boolean	true if this instance is loading; otherwise, false.

Methods

Unload()

Unloads this instance.

Declaration

public void Unload()

Events

onCatalogStateChange

Occurs when [on catalog state change].

Declaration

public event FormaCatalogLoader.CatalogHandler onCatalogStateChange

Event Type

Type	Description
FormaCatalogLoader.CatalogHandler