Class CatalogProductSourceImpl

Class CatalogProductSourceImpl.

Inheritance
Object
CatalogProductSourceImpl
Namespace: UnityEngine.Industrial.Configuring.ConfiguratorRuntime
Syntax
[Serializable]
public class CatalogProductSourceImpl : IProductSource

Constructors

CatalogProductSourceImpl(MonoBehaviour)

Initializes a new instance of the CatalogProductSourceImpl class.

Declaration
public CatalogProductSourceImpl(MonoBehaviour controller)
Parameters
Type Name Description
MonoBehaviour controller

The controller.

Fields

LoadFromStreamingAssets

Load catalogs from streaming assets.

Declaration
[SerializeField]
public bool LoadFromStreamingAssets
Field Value
Type Description
Boolean

Properties

CatalogPaths

Gets all the catalog paths.

Declaration
public List<string> CatalogPaths { get; }
Property Value
Type Description
List<String>

The catalog paths.

IsFormaManaged

Check if the product source is managed by Forma code.

Declaration
public bool IsFormaManaged { get; set; }
Property Value
Type Description
Boolean

true if this instance is loading; otherwise, false.
Implements

IsLoaded

Gets or sets a value indicating whether this instance is loaded.

Declaration
public virtual bool IsLoaded { get; set; }
Property Value
Type Description
Boolean

true if this instance is loaded; otherwise, false.
Implements

IsLoading

Gets or sets a value indicating whether this instance is loading.

Declaration
public virtual bool IsLoading { get; set; }
Property Value
Type Description
Boolean

true if this instance is loading; otherwise, false.
Implements

MultiPartCatalogPaths

Get all split catalog paths.

Declaration
public List<List<string>> MultiPartCatalogPaths { get; set; }
Property Value
Type Description
List<List<String>>

The catalog paths.

Products

Gets or sets the products.

Declaration
public List<AssetProductReference> Products { get; set; }
Property Value
Type Description
List<AssetProductReference>

The products.
Implements

Methods

ClearListeners()

Clears the listeners.

Declaration
public void ClearListeners()

FindCatalogFromStreamingAssetFolder(String)

Works in Windows, Mac and Linux. (Not on Android or iOS)

Declaration
public static List<string> FindCatalogFromStreamingAssetFolder(string folderPath)
Parameters
Type Name Description
String folderPath

Path to look into
Returns
Type Description
List<String>

Catalog found

Load()

Loads this instance.

Declaration
public virtual IEnumerator Load()
Returns
Type Description
IEnumerator

IEnumerator.
Implements

RemoveProduct(String, Boolean)

Removes the product.

Declaration
public void RemoveProduct(string key, bool sendEvent = true)
Parameters
Type Name Description
String key

The key.
Boolean sendEvent

if set to true [send event].
Implements
Exceptions
Type Condition
ArgumentException

There is no product with {key}.

Unload()

Unloads this instance.

Declaration
public virtual IEnumerator Unload()
Returns
Type Description
IEnumerator

IEnumerator.
Implements

Events

onProductAdded

Occurs when [on product added].

Declaration
public event ProductSource.ProductReferenceEvent onProductAdded
Event Type
Type Description
ProductSource.ProductReferenceEvent
Implements

onProductRemoved

Occurs when [on product removed].

Declaration
public event ProductSource.ProductGuidEvent onProductRemoved
Event Type
Type Description
ProductSource.ProductGuidEvent
Implements