Class PipelineWorkerBase

Inheritance
object
PipelineWorkerBase
DataProviderWorker<TDataType>
MapWorker
PoseSetWorker
SpawnerWorker
Implements
Namespace: Holoride.ElasticSDK
Assembly: Holoride.ElasticSDK.Library.Runtime.dll
Syntax
public abstract class PipelineWorkerBase : IPipelineWorker

Properties

CurrentGenerationContext

Declaration
public GenerationContext CurrentGenerationContext { get; set; }
Property Value
Type Description
GenerationContext

GenerationSettings

Declaration
public GenerationSettings GenerationSettings { get; }
Property Value
Type Description
GenerationSettings

GenerationState

Declaration
public GenerationState GenerationState { get; }
Property Value
Type Description
GenerationState

HasMissingMandatoryInputInHierarchy

Declaration
public bool HasMissingMandatoryInputInHierarchy { get; }
Property Value
Type Description
bool

Inputs

Declaration
public IEnumerable<IPipelineWorker> Inputs { get; }
Property Value
Type Description
IEnumerable<IPipelineWorker>

IsGatheringResources

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

IsProcessing

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

MissingMandatoryInputs

Declaration
public IReadOnlyCollection<string> MissingMandatoryInputs { get; }
Property Value
Type Description
IReadOnlyCollection<string>

Pipeline

Declaration
public Pipeline Pipeline { get; set; }
Property Value
Type Description
Pipeline

Methods

AddInput(string, IPipelineWorker)

Declaration
public void AddInput(string id, IPipelineWorker pipelineWorker)
Parameters
Type Name Description
string id
IPipelineWorker pipelineWorker

AddMissingMandatoryInput(string)

Declaration
public void AddMissingMandatoryInput(string id)
Parameters
Type Name Description
string id

CallCleanUp()

Declaration
[Obsolete("Use Dispose() instead.")]
public virtual void CallCleanUp()

CallGatherResourcesAsync(GenerationContext, IProgress<float>, CancellationToken)

Declaration
public virtual UniTask<LoadResourceResult> CallGatherResourcesAsync(GenerationContext context, IProgress<float> onProgressUpdate = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GenerationContext context
IProgress<float> onProgressUpdate
CancellationToken cancellationToken
Returns
Type Description
Cysharp.Threading.Tasks.UniTask<T><LoadResourceResult>

CallInit()

Declaration
public virtual void CallInit()

CallInitResources()

Declaration
public virtual void CallInitResources()

CallProcessAsync(GenerationContext, IProgress<float>, CancellationToken)

Declaration
public virtual UniTask CallProcessAsync(GenerationContext context, IProgress<float> onProgressUpdate = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GenerationContext context
IProgress<float> onProgressUpdate
CancellationToken cancellationToken
Returns
Type Description
Cysharp.Threading.Tasks.UniTask

CleanUp()

Declaration
[Obsolete("Use Dispose() instead.")]
public virtual void CleanUp()

Dispose()

Declaration
public virtual void Dispose()

GatherResourcesAsync(GenerationContext, IProgress<float>, CancellationToken)

Gathers resources for this node.

Declaration
protected virtual UniTask<LoadResourceResult> GatherResourcesAsync(GenerationContext context, IProgress<float> onProgressUpdate, CancellationToken cancellationToken)
Parameters
Type Name Description
GenerationContext context

Contains the immutable meta-information of a single update iteration.
IProgress<float> onProgressUpdate

Called with current relative processing progress in [0, 1].
CancellationToken cancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Cysharp.Threading.Tasks.UniTask<T><LoadResourceResult>

GetInput(string)

Declaration
public IPipelineWorker GetInput(string id)
Parameters
Type Name Description
string id
Returns
Type Description
IPipelineWorker

GetInput<T>(string)

Declaration
public T GetInput<T>(string id) where T : class, IPipelineWorker
Parameters
Type Name Description
string id
Returns
Type Description
T
Type Parameters
Name Description
T

Init()

Initializes this worker when generation starts.

Declaration
public virtual void Init()

InitResources()

Initializes the resources required for this node in order to be processed.

Declaration
public virtual void InitResources()

ProcessAsync(GenerationContext, IProgress<float>, CancellationToken)

Processes this node.

Declaration
protected virtual UniTask ProcessAsync(GenerationContext context, IProgress<float> onProgressUpdate, CancellationToken cancellationToken)
Parameters
Type Name Description
GenerationContext context

Contains the immutable meta-information of a single update iteration.
IProgress<float> onProgressUpdate

Called with current relative processing progress in [0, 1].
CancellationToken cancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Cysharp.Threading.Tasks.UniTask

Implements