Class ScriptGraphProcessor

This class processes the processor nodes in the correct order.

Inheritance

object

ScriptGraphProcessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: InsaneScatterbrain.ScriptGraph

Syntax

[Serializable]
public class ScriptGraphProcessor

Properties

AutoDispose

Declaration

public bool AutoDispose { get; set; }

Property Value

Type	Description
bool

Disposer

Gets the disposer.

Declaration

public Disposer Disposer { get; set; }

Property Value

Type	Description
Disposer

Graph

Gets/sets the graph to process.

Declaration

public ScriptGraphGraph Graph { get; set; }

Property Value

Type	Description
ScriptGraphGraph

InstanceProvider

Declaration

public IInstanceProvider InstanceProvider { get; set; }

Property Value

Type	Description
IInstanceProvider

IsAborted

Declaration

public bool IsAborted { get; }

Property Value

Type	Description
bool

IsMainThreadTimePerFrameLimitEnabled

Declaration

public bool IsMainThreadTimePerFrameLimitEnabled { get; set; }

Property Value

Type	Description
bool

IsMultiThreadingEnabled

Declaration

public bool IsMultiThreadingEnabled { get; set; }

Property Value

Type	Description
bool

IsProcessing

Gets whether the processor is currently processing a graph or not.

Declaration

public bool IsProcessing { get; }

Property Value

Type	Description
bool

IsSeedRandom

Gets/sets whether a random RNG seed is used or the one set in seed property.

Declaration

public bool IsSeedRandom { get; set; }

Property Value

Type	Description
bool

Rng

Gets the RNG.

Declaration

[Obsolete("Will be removed in version 2.0. Check the manual page about custom nodes to see how to access dependencies, such as the Rng object.")]
public Rng Rng { get; }

Property Value

Type	Description
Rng

RngStartState

Declaration

public RngState? RngStartState { get; set; }

Property Value

Type	Description
RngState?

ScriptGraphInstanceProvider

Declaration

public IScriptGraphInstanceProvider ScriptGraphInstanceProvider { get; set; }

Property Value

Type	Description
IScriptGraphInstanceProvider

Seed

Gets/sets the RNG seed.

Declaration

public int Seed { get; set; }

Property Value

Type	Description
int

SeedGuid

Declaration

public string SeedGuid { get; set; }

Property Value

Type	Description
string

SeedType

Declaration

public SeedType SeedType { get; set; }

Property Value

Type	Description
SeedType

Methods

Cancel()

Declaration

public void Cancel()

ContainsInParameterId(string)

Declaration

public bool ContainsInParameterId(string id)

Parameters

Type	Name	Description
string	id

Returns

Type	Description
bool

FlagInUnconnected(string)

Flags the given in parameter as unconnected.

Declaration

public void FlagInUnconnected(string id)

Parameters

Type	Name	Description
string	id	The input parameters ID.

GetConsumerNodes()

Declaration

public IEnumerable<IConsumerNode> GetConsumerNodes()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><IConsumerNode>

GetInParameterId(string)

Declaration

public string GetInParameterId(string inName)

Parameters

Type	Name	Description
string	inName

Returns

Type	Description
string

GetInParameterIds()

Declaration

public IEnumerable<string> GetInParameterIds()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><string>

GetInParameterName(string)

Declaration

public string GetInParameterName(string id)

Parameters

Type	Name	Description
string	id

Returns

Type	Description
string

GetInParameterType(string)

Declaration

public Type GetInParameterType(string id)

Parameters

Type	Name	Description
string	id

Returns

Type	Description
System.Type

In(string, Func<object>)

Set input providers for the given input parameter.

Declaration

public void In(string name, Func<object> value)

Parameters

Type	Name	Description
string	name	The parameter name.
System.Func<TResult><object>	value	Input provider.

In<T>(string, Func<T>)

Declaration

public void In<T>(string name, Func<T> value)

Parameters

Type	Name	Description
string	name
System.Func<TResult><T>	value

Type Parameters

Name	Description
T

Process(ScriptGraphGraph)

Processes the given graph.

Declaration

public Dictionary<string, object> Process(ScriptGraphGraph graphToProcess = null)

Parameters

Type	Name	Description
ScriptGraphGraph	graphToProcess	The graph to process.

Returns

Type	Description
System.Collections.Generic.Dictionary<TKey, TValue><string, object>	The values for each output parameter.

Exceptions

Type	Condition
System.InvalidOperationException	InvalidOperationException is thrown if the graph is already processing.

SetGraph(ScriptGraphGraph)

Declaration

public void SetGraph(ScriptGraphGraph setGraph)

Parameters

Type	Name	Description
ScriptGraphGraph	setGraph

Unprepare()

Declaration

public void Unprepare()

Events

OnProcess

Global event that's called each time a script graph is about to be processed by any script graph processor.

Declaration

public static event Action<ScriptGraphProcessor> OnProcess

Event Type

Type	Description
System.Action<T><ScriptGraphProcessor>

OnProgress

Declaration

public event Action<int, int> OnProgress

Event Type

Type	Description
System.Action<T1, T2><int, int>