docs.unity3d.com
    Show / Hide Table of Contents

    Class UnitPort<TData, TValidOther, TInvalidOther, TExternalConnection, TDefinition>

    Inheritance
    Object
    UnitPort<TData, TValidOther, TInvalidOther, TExternalConnection, TDefinition>
    ControlInput
    ControlOutput
    InvalidInput
    InvalidOutput
    ValueInput
    ValueOutput
    Namespace: Ludiq.Bolt
    Syntax
    public abstract class UnitPort<TData, TValidOther, TInvalidOther, TExternalConnection, TDefinition> : IUnitPort, IGraphElementModule, IGraphChild, IObservableDisposable, IDisposable, ICollectionChild<IGraphElement>, ICollectionChild<IUnit>, INotifyPropertyChanged where TData : IUnitPortData where TValidOther : IUnitPort where TInvalidOther : IUnitPort where TExternalConnection : IUnitConnection where TDefinition : IUnitPortDefinition
    Type Parameters
    Name Description
    TData
    TValidOther
    TInvalidOther
    TExternalConnection
    TDefinition

    Constructors

    UnitPort(String)

    Declaration
    protected UnitPort(string key)
    Parameters
    Type Name Description
    String key

    Properties

    connectedPorts

    Declaration
    public IEnumerable<IUnitPort> connectedPorts { get; }
    Property Value
    Type Description
    IEnumerable<IUnitPort>
    Implements
    IUnitPort.connectedPorts

    connections

    Declaration
    public IEnumerable<IUnitConnection> connections { get; }
    Property Value
    Type Description
    IEnumerable<IUnitConnection>
    Implements
    IUnitPort.connections

    data

    Declaration
    public abstract TData data { get; }
    Property Value
    Type Description
    TData

    definition

    Declaration
    public TDefinition definition { get; protected set; }
    Property Value
    Type Description
    TDefinition

    hasAnyConnection

    Declaration
    public bool hasAnyConnection { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPort.hasAnyConnection

    hasData

    Declaration
    public bool hasData { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPort.hasData

    hasInvalidConnection

    Declaration
    public virtual bool hasInvalidConnection { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPort.hasInvalidConnection

    hasValidConnection

    Declaration
    public virtual bool hasValidConnection { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPort.hasValidConnection

    invalidConnectedPorts

    Declaration
    public abstract IEnumerable<TInvalidOther> invalidConnectedPorts { get; }
    Property Value
    Type Description
    IEnumerable<TInvalidOther>

    invalidConnections

    Declaration
    public abstract IEnumerable<InvalidConnection> invalidConnections { get; }
    Property Value
    Type Description
    IEnumerable<InvalidConnection>
    Implements
    IUnitPort.invalidConnections

    IsDisposed

    Declaration
    public bool IsDisposed { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IObservableDisposable.IsDisposed

    key

    Declaration
    public string key { get; }
    Property Value
    Type Description
    String
    Implements
    IUnitPort.key

    parentGraph

    Declaration
    public FlowGraph parentGraph { get; }
    Property Value
    Type Description
    FlowGraph

    relations

    Declaration
    public IEnumerable<IUnitRelation> relations { get; }
    Property Value
    Type Description
    IEnumerable<IUnitRelation>
    Implements
    IUnitPort.relations

    unit

    Declaration
    public IUnit unit { get; set; }
    Property Value
    Type Description
    IUnit
    Implements
    IUnitPort.unit

    validConnectedPorts

    Declaration
    public abstract IEnumerable<TValidOther> validConnectedPorts { get; }
    Property Value
    Type Description
    IEnumerable<TValidOther>

    validConnections

    Declaration
    public abstract IEnumerable<TExternalConnection> validConnections { get; }
    Property Value
    Type Description
    IEnumerable<TExternalConnection>

    Methods

    CanConnectToInvalid(TInvalidOther)

    Declaration
    public bool CanConnectToInvalid(TInvalidOther port)
    Parameters
    Type Name Description
    TInvalidOther port
    Returns
    Type Description
    Boolean

    CanConnectToValid(TValidOther)

    Declaration
    public abstract bool CanConnectToValid(TValidOther port)
    Parameters
    Type Name Description
    TValidOther port
    Returns
    Type Description
    Boolean

    CanInvalidlyConnectTo(IUnitPort)

    Declaration
    public bool CanInvalidlyConnectTo(IUnitPort port)
    Parameters
    Type Name Description
    IUnitPort port
    Returns
    Type Description
    Boolean
    Implements
    IUnitPort.CanInvalidlyConnectTo(IUnitPort)

    CanValidlyConnectTo(IUnitPort)

    Declaration
    public bool CanValidlyConnectTo(IUnitPort port)
    Parameters
    Type Name Description
    IUnitPort port
    Returns
    Type Description
    Boolean
    Implements
    IUnitPort.CanValidlyConnectTo(IUnitPort)

    CompatiblePort(IUnit)

    Declaration
    public abstract IUnitPort CompatiblePort(IUnit unit)
    Parameters
    Type Name Description
    IUnit unit
    Returns
    Type Description
    IUnitPort
    Implements
    IUnitPort.CompatiblePort(IUnit)

    ConnectInvalid(IUnitOutputPort, IUnitInputPort)

    Declaration
    protected InvalidConnection ConnectInvalid(IUnitOutputPort source, IUnitInputPort destination)
    Parameters
    Type Name Description
    IUnitOutputPort source
    IUnitInputPort destination
    Returns
    Type Description
    InvalidConnection

    ConnectToInvalid(TInvalidOther)

    Declaration
    public abstract InvalidConnection ConnectToInvalid(TInvalidOther port)
    Parameters
    Type Name Description
    TInvalidOther port
    Returns
    Type Description
    InvalidConnection

    ConnectToValid(TValidOther)

    Declaration
    public abstract TExternalConnection ConnectToValid(TValidOther port)
    Parameters
    Type Name Description
    TValidOther port
    Returns
    Type Description
    TExternalConnection

    Disconnect()

    Declaration
    public void Disconnect()
    Implements
    IUnitPort.Disconnect()

    DisconnectFromInvalid(TInvalidOther)

    Declaration
    public abstract void DisconnectFromInvalid(TInvalidOther port)
    Parameters
    Type Name Description
    TInvalidOther port

    DisconnectFromValid(TValidOther)

    Declaration
    public abstract void DisconnectFromValid(TValidOther port)
    Parameters
    Type Name Description
    TValidOther port

    DisconnectInvalid(IUnitOutputPort, IUnitInputPort)

    Declaration
    protected void DisconnectInvalid(IUnitOutputPort source, IUnitInputPort destination)
    Parameters
    Type Name Description
    IUnitOutputPort source
    IUnitInputPort destination

    Dispose()

    Declaration
    public void Dispose()

    InvalidlyConnectTo(IUnitPort)

    Declaration
    public InvalidConnection InvalidlyConnectTo(IUnitPort port)
    Parameters
    Type Name Description
    IUnitPort port
    Returns
    Type Description
    InvalidConnection
    Implements
    IUnitPort.InvalidlyConnectTo(IUnitPort)

    OnPropertyChanged(Object, PropertyChangedEventArgs)

    Declaration
    protected virtual void OnPropertyChanged(object sender, PropertyChangedEventArgs args)
    Parameters
    Type Name Description
    Object sender
    PropertyChangedEventArgs args

    OnPropertyChanged(String)

    Declaration
    protected void OnPropertyChanged(string propertyName = "")
    Parameters
    Type Name Description
    String propertyName

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    Object.ToString()

    ValidlyConnectTo(IUnitPort)

    Declaration
    public IUnitConnection ValidlyConnectTo(IUnitPort port)
    Parameters
    Type Name Description
    IUnitPort port
    Returns
    Type Description
    IUnitConnection
    Implements
    IUnitPort.ValidlyConnectTo(IUnitPort)

    Events

    PropertyChanged

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    PropertyChangedEventHandler

    Explicit Interface Implementations

    IGraphChild.associatedElement

    Declaration
    IGraphElement IGraphChild.associatedElement { get; }
    Returns
    Type Description
    IGraphElement
    Implements
    IGraphChild.associatedElement

    IGraphChild.parentGraph

    Declaration
    IGraph IGraphChild.parentGraph { get; }
    Returns
    Type Description
    IGraph
    Implements
    IGraphChild.parentGraph

    IUnitPort.data

    Declaration
    IUnitPortData IUnitPort.data { get; }
    Returns
    Type Description
    IUnitPortData
    Implements
    IUnitPort.data

    IUnitPort.definition

    Declaration
    IUnitPortDefinition IUnitPort.definition { get; }
    Returns
    Type Description
    IUnitPortDefinition
    Implements
    IUnitPort.definition

    IUnitPort.invalidConnectedPorts

    Declaration
    IEnumerable<IUnitPort> IUnitPort.invalidConnectedPorts { get; }
    Returns
    Type Description
    IEnumerable<IUnitPort>
    Implements
    IUnitPort.invalidConnectedPorts

    IUnitPort.validConnectedPorts

    Declaration
    IEnumerable<IUnitPort> IUnitPort.validConnectedPorts { get; }
    Returns
    Type Description
    IEnumerable<IUnitPort>
    Implements
    IUnitPort.validConnectedPorts

    IUnitPort.validConnections

    Declaration
    IEnumerable<IUnitConnection> IUnitPort.validConnections { get; }
    Returns
    Type Description
    IEnumerable<IUnitConnection>
    Implements
    IUnitPort.validConnections

    ICollectionChild<IGraphElement>.parent

    Declaration
    IGraphElement ICollectionChild<IGraphElement>.parent { get; set; }
    Returns
    Type Description
    IGraphElement
    Implements
    ICollectionChild<TParent>.parent

    ICollectionChild<IUnit>.parent

    Declaration
    IUnit ICollectionChild<IUnit>.parent { get; set; }
    Returns
    Type Description
    IUnit
    Implements
    ICollectionChild<TParent>.parent

    Extension Methods

    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    LiteralUtility.ToLiteralString(Object)
    LiteralUtility.ToLiteralStringOrDefault(Object)
    LiteralUtility.TryToLiteralString(Object, out String)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone(Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy(Object)
    Cloning.CloneViaSerializationPolicy(Object, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy<T>(T)
    Cloning.CloneViaSerializationPolicy<T>(T, out Dictionary<Object, Object>)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneValueType(Object)
    ConversionUtility.ConvertTo<TSource>(TSource, Type)
    ConversionUtility.IsLateConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsLateConvertibleTo<T>(Object, Boolean)
    ConversionUtility.LateConvertTo(Object, Type)
    ConversionUtility.LateConvertTo<T>(Object)
    ConversionUtility.TryLateConvertTo(Object, Type, out Object, Boolean)
    ConversionUtility.TryLateConvertTo<T>(Object, out T, Boolean)
    TypeUtility.ToShortString(Object, Int32)
    TypeUtility.CastTo<T>(Object)
    Serialization.FullSerialize(Object, Boolean)
    Serialization.OdinSerialize<T>(T, DataFormat)
    Serialization.OdinSerialize<T>(T, ref SerializationData, DataFormat)
    XObservableDisposable.EnsureNotDisposed(IObservableDisposable)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.UnityNullCoalesce(Object, Object)
    UnityObjectUtility.ToSafeString(Object)
    XFilterProvider.Filter(Object)
    XFilterProvider.Filter<TFilter>(Object)
    XUnitPortReference.ToReference(IUnitPort)
    BoltGenerationUtility.GenerateLiteral(Object, IGeneration)
    XGeneratorProvider.Generator(Object, IGeneration)
    XGeneratorProvider.Generator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.HasGenerator(Object, IGeneration)
    XGeneratorProvider.HasGenerator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.TryGetGenerator(Object, out IGenerator, IGeneration)
    XGeneratorProvider.TryGetGenerator<TGenerator>(Object, IGeneration, out TGenerator)
    FlowGenerationUtility.CodeName(IUnitPort)
    FlowGenerationUtility.ErrorName(IUnitPort)
    FlowGenerationUtility.GenerateValueInputDependencies(IUnitPort, MethodGeneration)
    XUnitPortDescriptor.Descriptor(IUnitPort)
    XUnitPortDescriptor.Descriptor<TDescriptor>(IUnitPort)
    HybridConversionUtility.ConvertTo(Object, HybridType, HybridType)
    HybridConversionUtility.IsLateConvertibleTo(Object, HybridType, Boolean)
    HybridConversionUtility.LateConvertTo(Object, HybridType)
    HybridConversionUtility.TryLateConvertTo(Object, HybridType, out Object, Boolean)
    HybridTypeUtility.GetHybridType(Object)
    IsUtility.Is<TO, TC>(TO, out TC)
    XUnitPort.ConnectedPortsByConnection(IUnitPort)
    XUnitPortProxy.CreateProxy(IUnitPort)
    PrivateReflectionUsingDynamicExtensions.AsDynamic(Object)
    JsonWriter.ToJson(Object)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023