Class ProcessorNode
Interface for any node that can be used to process something. It can either consume or provide data or both.
Inheritance
object
ProcessorNode
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Syntax
[Serializable]
public abstract class ProcessorNode : ScriptNode, IProcessorNode, IProviderNode, IConsumerNode, IScriptNode, INode
Constructors
ProcessorNode()
Declaration
protected ProcessorNode()
ProcessorNode(ScriptGraphGraph)
Declaration
[Obsolete("Processor nodes needn't be dependant on a graph anymore. You can use the parameterless constructor instead. This one will be removed with version 2.0.")]
protected ProcessorNode(ScriptGraphGraph graph)
Parameters
Properties
InPorts
Declaration
public ReadOnlyCollection<InPort> InPorts { get; }
Property Value
Type |
Description |
System.Collections.ObjectModel.ReadOnlyCollection<T><InPort> |
|
OutPorts
Declaration
public ReadOnlyCollection<OutPort> OutPorts { get; }
Property Value
Type |
Description |
System.Collections.ObjectModel.ReadOnlyCollection<T><OutPort> |
|
Rng
Gets the instance of random used for processing this node.
Declaration
[Obsolete("Get the random object by calling Get<Rng>() instead. This property will be removed in version 2.0.")]
public Rng Rng { get; }
Property Value
Methods
AddIn(string, Type)
Declaration
protected InPort AddIn(string name, Type type)
Parameters
Type |
Name |
Description |
string |
name |
|
System.Type |
type |
|
Returns
AddIn<T>(string)
Declaration
protected InPort AddIn<T>(string name)
Parameters
Type |
Name |
Description |
string |
name |
|
Returns
Type Parameters
AddOut(string, Type)
Declaration
protected OutPort AddOut(string name, Type type)
Parameters
Type |
Name |
Description |
string |
name |
|
System.Type |
type |
|
Returns
AddOut<T>(string)
Declaration
protected OutPort AddOut<T>(string name)
Parameters
Type |
Name |
Description |
string |
name |
|
Returns
Type Parameters
ClearPorts()
Declaration
GetInPort(string)
Declaration
public InPort GetInPort(string name)
Parameters
Type |
Name |
Description |
string |
name |
|
Returns
GetOutPort(string)
Declaration
public OutPort GetOutPort(string name)
Parameters
Type |
Name |
Description |
string |
name |
|
Returns
Initialize()
Declaration
public override void Initialize()
Overrides
MoveIn(int, int)
Declaration
public void MoveIn(int oldIndex, int newIndex)
Parameters
Type |
Name |
Description |
int |
oldIndex |
|
int |
newIndex |
|
MoveOut(int, int)
Declaration
public void MoveOut(int oldIndex, int newIndex)
Parameters
Type |
Name |
Description |
int |
oldIndex |
|
int |
newIndex |
|
Declaration
public virtual void OnLoadInputPorts()
OnLoadOutputPorts()
Declaration
public virtual void OnLoadOutputPorts()
OnProcess()
Contains all the processing logic of this node. Called by Process.
Declaration
protected virtual void OnProcess()
OnProcessMainThread()
Contains all the processing logic of this node that must be executed on the main thread.
Called by Process after OnProcess
Declaration
protected virtual void OnProcessMainThread()
OnProcessMainThreadCoroutine()
Declaration
protected virtual IEnumerator OnProcessMainThreadCoroutine()
Returns
Type |
Description |
System.Collections.IEnumerator |
|
Process()
Declaration
RemoveIn(string)
Declaration
public void RemoveIn(string name)
Parameters
Type |
Name |
Description |
string |
name |
|
RemoveOut(string)
Declaration
public void RemoveOut(string name)
Parameters
Type |
Name |
Description |
string |
name |
|
RenameIn(string, string)
Declaration
public void RenameIn(string oldName, string newName)
Parameters
Type |
Name |
Description |
string |
oldName |
|
string |
newName |
|
RenameOut(string, string)
Declaration
public void RenameOut(string oldName, string newName)
Parameters
Type |
Name |
Description |
string |
oldName |
|
string |
newName |
|
Events
NodeProcessingCompleted
Declaration
public static event Action<ProcessorNode> NodeProcessingCompleted
Event Type
OnInPortAdded
Declaration
public event Action<InPort> OnInPortAdded
Event Type
Type |
Description |
System.Action<T><InPort> |
|
OnInPortMoved
Declaration
public event Action<InPort, int> OnInPortMoved
Event Type
Type |
Description |
System.Action<T1, T2><InPort, int> |
|
OnInPortRemoved
Declaration
public event Action<InPort> OnInPortRemoved
Event Type
Type |
Description |
System.Action<T><InPort> |
|
OnInPortRenamed
Declaration
public event Action<InPort, string, string> OnInPortRenamed
Event Type
Type |
Description |
System.Action<T1, T2, T3><InPort, string, string> |
|
OnOutPortAdded
Declaration
public event Action<OutPort> OnOutPortAdded
Event Type
Type |
Description |
System.Action<T><OutPort> |
|
OnOutPortMoved
Declaration
public event Action<OutPort, int> OnOutPortMoved
Event Type
Type |
Description |
System.Action<T1, T2><OutPort, int> |
|
OnOutPortRemoved
Declaration
public event Action<OutPort> OnOutPortRemoved
Event Type
Type |
Description |
System.Action<T><OutPort> |
|
OnOutPortRenamed
Declaration
public event Action<OutPort, string, string> OnOutPortRenamed
Event Type
Type |
Description |
System.Action<T1, T2, T3><OutPort, string, string> |
|
ProcessingCompleted
Declaration
[Obsolete("Please use the static event NodeProcessingCompleted instead.")]
public event Action ProcessingCompleted
Event Type
Type |
Description |
System.Action |
|
Implements