docs.unity3d.com
    Show / Hide Table of Contents

    Class UnitPortDescriptor<TPort>

    Inheritance
    Object
    Descriptor<TPort>
    UnitPortDescriptor<TPort>
    ControlInputDescriptor
    ControlOutputDescriptor
    InvalidInputDescriptor
    InvalidOutputDescriptor
    ValueInputDescriptor
    ValueOutputDescriptor
    Inherited Members
    Descriptor<TPort>.target
    Descriptor<TPort>.IDescriptor.target
    Descriptor<TPort>.Dispose()
    Descriptor<TPort>.SetDirty()
    Descriptor<TPort>.Validate()
    Descriptor<TPort>.StartWatching()
    Descriptor<TPort>.Watch(INotifyPropertyChanged)
    Descriptor<TPort>.Unwatch(INotifyPropertyChanged)
    Descriptor<TPort>.StopWatching()
    Descriptor<TPort>.OnChange(Object, PropertyChangedEventArgs)
    Descriptor<TPort>.Property<T>(Func<T>, Boolean, Boolean)
    Descriptor<TPort>.Property<T>(Func<IEnumerable<T>>, Boolean, Boolean)
    Descriptor<TPort>.RegisterProperty(IReactive)
    Descriptor<TPort>.propertyChanged
    Descriptor<TPort>._title
    Descriptor<TPort>._summary
    Descriptor<TPort>._icon
    Descriptor<TPort>._warnings
    Descriptor<TPort>.Summary()
    Descriptor<TPort>.Icon()
    Descriptor<TPort>.Warnings()
    Descriptor<TPort>.title
    Descriptor<TPort>.summary
    Descriptor<TPort>.icon
    Descriptor<TPort>.warnings
    Namespace: Ludiq.Bolt
    Syntax
    public class UnitPortDescriptor<TPort> : Descriptor<TPort>, IDisposable, IUnitPortDescriptor, IDescriptor where TPort : class, IUnitPort
    Type Parameters
    Name Description
    TPort

    Constructors

    UnitPortDescriptor(TPort)

    Declaration
    public UnitPortDescriptor(TPort port)
    Parameters
    Type Name Description
    TPort port

    UnitPortDescriptor(TPort, IUnitPortDefinition)

    Declaration
    public UnitPortDescriptor(TPort port, IUnitPortDefinition definition)
    Parameters
    Type Name Description
    TPort port
    IUnitPortDefinition definition

    Fields

    _horizontalOrder

    Declaration
    protected Reactive<int?> _horizontalOrder
    Field Value
    Type Description
    Reactive<Nullable<Int32>>

    _horizontalPrimary

    Declaration
    protected Reactive<bool> _horizontalPrimary
    Field Value
    Type Description
    Reactive<Boolean>

    _label

    Declaration
    protected Reactive<string> _label
    Field Value
    Type Description
    Reactive<String>

    _showDocumentation

    Declaration
    protected Reactive<bool> _showDocumentation
    Field Value
    Type Description
    Reactive<Boolean>

    _showLabel

    Declaration
    protected Reactive<bool> _showLabel
    Field Value
    Type Description
    Reactive<Boolean>

    _verticalOrder

    Declaration
    protected Reactive<int?> _verticalOrder
    Field Value
    Type Description
    Reactive<Nullable<Int32>>

    _verticalPrimary

    Declaration
    protected Reactive<bool> _verticalPrimary
    Field Value
    Type Description
    Reactive<Boolean>

    Properties

    definition

    Declaration
    protected virtual IUnitPortDefinition definition { get; }
    Property Value
    Type Description
    IUnitPortDefinition

    displayLabel

    Declaration
    public string displayLabel { get; }
    Property Value
    Type Description
    String
    Implements
    IUnitPortDescriptor.displayLabel

    horizontalOrder

    Declaration
    public int? horizontalOrder { get; }
    Property Value
    Type Description
    Nullable<Int32>
    Implements
    IUnitPortDescriptor.horizontalOrder

    horizontalPrimary

    Declaration
    public bool horizontalPrimary { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPortDescriptor.horizontalPrimary

    label

    Declaration
    public string label { get; }
    Property Value
    Type Description
    String
    Implements
    IUnitPortDescriptor.label

    reflectedDescription

    Declaration
    protected ReflectedUnitPortDescription reflectedDescription { get; }
    Property Value
    Type Description
    ReflectedUnitPortDescription

    showDocumentation

    Declaration
    public bool showDocumentation { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPortDescriptor.showDocumentation

    showLabel

    Declaration
    public bool showLabel { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPortDescriptor.showLabel

    verticalOrder

    Declaration
    public int? verticalOrder { get; }
    Property Value
    Type Description
    Nullable<Int32>
    Implements
    IUnitPortDescriptor.verticalOrder

    verticalPrimary

    Declaration
    public bool verticalPrimary { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPortDescriptor.verticalPrimary

    Methods

    GetAccessor(Accessor)

    Declaration
    public virtual Accessor GetAccessor(Accessor unitAccessor)
    Parameters
    Type Name Description
    Accessor unitAccessor
    Returns
    Type Description
    Accessor
    Implements
    IUnitPortDescriptor.GetAccessor(Accessor)

    HorizontalOrder()

    Declaration
    protected virtual int? HorizontalOrder()
    Returns
    Type Description
    Nullable<Int32>

    HorizontalPrimary()

    Declaration
    protected virtual bool HorizontalPrimary()
    Returns
    Type Description
    Boolean

    Label()

    Declaration
    protected virtual string Label()
    Returns
    Type Description
    String

    RegisterProperties()

    Declaration
    protected override void RegisterProperties()
    Overrides
    Ludiq.Descriptor<TPort>.RegisterProperties()

    ShowDocumentation()

    Declaration
    protected virtual bool ShowDocumentation()
    Returns
    Type Description
    Boolean

    ShowLabel()

    Declaration
    protected virtual bool ShowLabel()
    Returns
    Type Description
    Boolean

    Title()

    Declaration
    protected sealed override string Title()
    Returns
    Type Description
    String
    Overrides
    Ludiq.Descriptor<TPort>.Title()

    VerticalOrder()

    Declaration
    protected virtual int? VerticalOrder()
    Returns
    Type Description
    Nullable<Int32>

    VerticalPrimary()

    Declaration
    protected virtual bool VerticalPrimary()
    Returns
    Type Description
    Boolean

    Extension Methods

    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    XDescriptor.ToGUIContent(IDescriptor, Int32)
    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)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.UnityNullCoalesce(Object, Object)
    UnityObjectUtility.ToSafeString(Object)
    XFilterProvider.Filter(Object)
    XFilterProvider.Filter<TFilter>(Object)
    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)
    XUnitPortDescriptor.GetOrder(IUnitPortDescriptor, Axis2)
    XUnitPortDescriptor.IsPrimary(IUnitPortDescriptor, Axis2)
    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)
    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