Class PortMapper

For initialization of runtime ports (they need to have a graph-wide unique index) and optionally mapping them to an authoring unit port The mapping enables debugging to display the recorded values on the right authoring ports and highlight the right authoring nodes Given that node translation is not 1:1, this is required:

  • 1 authoring node could get translated to N runtime nodes
  • 1 port might be translated to 0 or 1 ports
Inheritance
Object
PortMapper
Namespace: Unity.VisualScripting.Interpreter
Syntax
public class PortMapper

Properties

AllPorts

used to fill the PortInfoTable

Declaration
public IEnumerable<KeyValuePair<IUnitPort, PortMapper.MappedPort>> AllPorts { get; }
Property Value
Type Description
IEnumerable<KeyValuePair<IUnitPort, PortMapper.MappedPort>>

MappedPortModels

Declaration
public Dictionary<IUnitPort, PortMapper.MappedPort> MappedPortModels { get; }
Property Value
Type Description
Dictionary<IUnitPort, PortMapper.MappedPort>

Methods

AddMultiPort<TMultiPort>(GraphBuilder, List<IUnitPort>, ref TMultiPort)

Declaration
public void AddMultiPort<TMultiPort>(GraphBuilder graphBuilder, List<IUnitPort> portModels, ref TMultiPort port)
    where TMultiPort : IMultiPort
Parameters
Type Name Description
GraphBuilder graphBuilder
List<IUnitPort> portModels
TMultiPort port
Type Parameters
Name Description
TMultiPort

AddMultiPortIndexed<TMultiPort>(GraphBuilder, Func<Int32, IUnitPort>, ref TMultiPort, Func<UInt32, Nullable<Value>>)

Declaration
public void AddMultiPortIndexed<TMultiPort>(GraphBuilder graphBuilder, Func<int, IUnitPort> portModels, ref TMultiPort port, Func<uint, Value?> defaultValue = null)
    where TMultiPort : IMultiPort
Parameters
Type Name Description
GraphBuilder graphBuilder
Func<Int32, IUnitPort> portModels
TMultiPort port
Func<UInt32, Nullable<Value>> defaultValue
Type Parameters
Name Description
TMultiPort

AddSinglePort<TPort>(GraphBuilder, IUnitPort, ref TPort, Nullable<Value>)

Declaration
public void AddSinglePort<TPort>(GraphBuilder graphBuilder, IUnitPort portModel, ref TPort port, Value? defaultValue = null)
    where TPort : IPort
Parameters
Type Name Description
GraphBuilder graphBuilder
IUnitPort portModel
TPort port
Nullable<Value> defaultValue
Type Parameters
Name Description
TPort

GetPortIndexOfPortModel(IUnitPort)

Declaration
public IPort GetPortIndexOfPortModel(IUnitPort portModel)
Parameters
Type Name Description
IUnitPort portModel
Returns
Type Description
IPort

Merge(PortMapper)

Declaration
public void Merge(PortMapper portToOffsetMapping)
Parameters
Type Name Description
PortMapper portToOffsetMapping

TryGetPortIndexOfPortModel(IUnitPort, out IPort)

Declaration
public bool TryGetPortIndexOfPortModel(IUnitPort portModel, out IPort port)
Parameters
Type Name Description
IUnitPort portModel
IPort port
Returns
Type Description
Boolean

Extension Methods