docs.unity3d.com
    Show / Hide Table of Contents

    Class UnitPortWidget<TPort>

    Inheritance
    Object
    Widget<FlowCanvas, TPort>
    UnitPortWidget<TPort>
    UnitInputPortWidget<TPort>
    UnitOutputPortWidget<TPort>
    Inherited Members
    Widget<FlowCanvas, TPort>.context
    Widget<FlowCanvas, TPort>.reference
    Widget<FlowCanvas, TPort>.graph
    Widget<FlowCanvas, TPort>.canvas
    Widget<FlowCanvas, TPort>.IWidget.canvas
    Widget<FlowCanvas, TPort>.selection
    Widget<FlowCanvas, TPort>.window
    Widget<FlowCanvas, TPort>.mousePosition
    Widget<FlowCanvas, TPort>.disposed
    Widget<FlowCanvas, TPort>.Dispose()
    Widget<FlowCanvas, TPort>.e
    Widget<FlowCanvas, TPort>.ToString()
    Widget<FlowCanvas, TPort>.subWidgets
    Widget<FlowCanvas, TPort>.SubWidgetsChanged()
    Widget<FlowCanvas, TPort>.item
    Widget<FlowCanvas, TPort>.IWidget.item
    Widget<FlowCanvas, TPort>.hasDescriptor
    Widget<FlowCanvas, TPort>.metadata
    Widget<FlowCanvas, TPort>.FetchMetadata()
    Widget<FlowCanvas, TPort>.CacheItemFirstTime()
    Widget<FlowCanvas, TPort>.CacheItem()
    Widget<FlowCanvas, TPort>.CacheMetadata()
    Widget<FlowCanvas, TPort>.CacheDescription()
    Widget<FlowCanvas, TPort>.RegisterControl()
    Widget<FlowCanvas, TPort>.BeforeFrame()
    Widget<FlowCanvas, TPort>.HandleCapture()
    Widget<FlowCanvas, TPort>.HandleInput()
    Widget<FlowCanvas, TPort>.HandleRelease()
    Widget<FlowCanvas, TPort>.Update()
    Widget<FlowCanvas, TPort>.snapToGrid
    Widget<FlowCanvas, TPort>.isPositionValid
    Widget<FlowCanvas, TPort>.positionDependers
    Widget<FlowCanvas, TPort>.positionDependencies
    Widget<FlowCanvas, TPort>.position
    Widget<FlowCanvas, TPort>.zIndex
    Widget<FlowCanvas, TPort>.Reposition()
    Widget<FlowCanvas, TPort>.CachePositionFirstPass()
    Widget<FlowCanvas, TPort>.CachePosition()
    Widget<FlowCanvas, TPort>.BringToFront()
    Widget<FlowCanvas, TPort>.SendToBack()
    Widget<FlowCanvas, TPort>.canClip
    Widget<FlowCanvas, TPort>.clippingPosition
    Widget<FlowCanvas, TPort>.OnViewportChange()
    Widget<FlowCanvas, TPort>.isVisible
    Widget<FlowCanvas, TPort>.hotArea
    Widget<FlowCanvas, TPort>.isMouseThrough
    Widget<FlowCanvas, TPort>.isMouseOver
    Widget<FlowCanvas, TPort>.OnContext()
    Widget<FlowCanvas, TPort>.HandleContext()
    Widget<FlowCanvas, TPort>.contextOptions
    Widget<FlowCanvas, TPort>.debug
    Widget<FlowCanvas, TPort>.foregroundRequiresInput
    Widget<FlowCanvas, TPort>.backgroundRequiresInput
    Widget<FlowCanvas, TPort>.overlayRequiresInput
    Widget<FlowCanvas, TPort>.DrawForeground()
    Widget<FlowCanvas, TPort>.DrawBackground()
    Widget<FlowCanvas, TPort>.DrawOverlay()
    Widget<FlowCanvas, TPort>.dim
    Widget<FlowCanvas, TPort>.BeginDim()
    Widget<FlowCanvas, TPort>.EndDim()
    Widget<FlowCanvas, TPort>.UpdateDim()
    Namespace: Unity.VisualScripting
    Syntax
    [Widget(typeof(IUnitPort))]
    public abstract class UnitPortWidget<TPort> : Widget<FlowCanvas, TPort>, IUnitPortWidget, IWidget, IDisposable where TPort : class, IUnitPort
    Type Parameters
    Name Description
    TPort

    Constructors

    UnitPortWidget(FlowCanvas, TPort)

    Declaration
    protected UnitPortWidget(FlowCanvas canvas, TPort port)
    Parameters
    Type Name Description
    FlowCanvas canvas
    TPort port

    Properties

    canClip

    Declaration
    public override bool canClip { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.canClip
    Implements
    IWidget.canClip

    canStartConnection

    Declaration
    protected virtual bool canStartConnection { get; }
    Property Value
    Type Description
    Boolean

    color

    Declaration
    public virtual Color color { get; }
    Property Value
    Type Description
    Color

    colorIfActive

    Declaration
    protected virtual bool colorIfActive { get; }
    Property Value
    Type Description
    Boolean

    description

    Declaration
    protected UnitPortDescription description { get; }
    Property Value
    Type Description
    UnitPortDescription

    dim

    Declaration
    protected override bool dim { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.dim

    edge

    Declaration
    protected abstract Edge edge { get; }
    Property Value
    Type Description
    Edge

    foregroundRequiresInput

    Declaration
    public override bool foregroundRequiresInput { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.foregroundRequiresInput
    Implements
    IWidget.foregroundRequiresInput

    handlePosition

    Declaration
    public Rect handlePosition { get; }
    Property Value
    Type Description
    Rect
    Implements
    IUnitPortWidget.handlePosition

    handleTextureConnected

    Declaration
    protected abstract Texture handleTextureConnected { get; }
    Property Value
    Type Description
    Texture

    handleTextureUnconnected

    Declaration
    protected abstract Texture handleTextureUnconnected { get; }
    Property Value
    Type Description
    Texture

    hotArea

    Declaration
    public override Rect hotArea { get; }
    Property Value
    Type Description
    Rect
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.hotArea
    Implements
    IWidget.hotArea

    iconPosition

    Declaration
    public Rect iconPosition { get; }
    Property Value
    Type Description
    Rect

    identifierPosition

    Declaration
    public Rect identifierPosition { get; }
    Property Value
    Type Description
    Rect

    inspector

    Declaration
    protected Inspector inspector { get; }
    Property Value
    Type Description
    Inspector

    inspectorMetadata

    Declaration
    public Metadata inspectorMetadata { get; }
    Property Value
    Type Description
    Metadata

    inspectorPosition

    Declaration
    public Rect inspectorPosition { get; }
    Property Value
    Type Description
    Rect

    labelPosition

    Declaration
    public Rect labelPosition { get; }
    Property Value
    Type Description
    Rect

    port

    Declaration
    public TPort port { get; }
    Property Value
    Type Description
    TPort

    position

    Declaration
    public override Rect position { get; set; }
    Property Value
    Type Description
    Rect
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.position
    Implements
    IWidget.position

    positionDependencies

    Declaration
    public override IEnumerable<IWidget> positionDependencies { get; }
    Property Value
    Type Description
    IEnumerable<IWidget>
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.positionDependencies
    Implements
    IWidget.positionDependencies

    positionDependers

    Declaration
    public override IEnumerable<IWidget> positionDependers { get; }
    Property Value
    Type Description
    IEnumerable<IWidget>
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.positionDependers
    Implements
    IWidget.positionDependers

    showIcon

    Declaration
    protected bool showIcon { get; }
    Property Value
    Type Description
    Boolean

    showInspector

    Declaration
    protected virtual bool showInspector { get; }
    Property Value
    Type Description
    Boolean

    showLabel

    Declaration
    protected bool showLabel { get; }
    Property Value
    Type Description
    Boolean

    surroundPosition

    Declaration
    public Rect surroundPosition { get; }
    Property Value
    Type Description
    Rect

    unit

    Declaration
    public IUnit unit { get; }
    Property Value
    Type Description
    IUnit

    unitWidget

    Declaration
    public IUnitWidget unitWidget { get; }
    Property Value
    Type Description
    IUnitWidget

    willDisconnect

    Declaration
    public bool willDisconnect { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IUnitPortWidget.willDisconnect

    wouldDisconnect

    Declaration
    public bool wouldDisconnect { get; }
    Property Value
    Type Description
    Boolean

    y

    Declaration
    public float y { get; set; }
    Property Value
    Type Description
    Single
    Implements
    IUnitPortWidget.y

    zIndex

    Declaration
    public override float zIndex { get; set; }
    Property Value
    Type Description
    Single
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.zIndex
    Implements
    IWidget.zIndex

    Methods

    CacheDescription()

    Declaration
    protected override void CacheDescription()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.CacheDescription()

    CacheMetadata()

    Declaration
    protected override void CacheMetadata()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.CacheMetadata()

    CachePosition()

    Declaration
    public override void CachePosition()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.CachePosition()
    Implements
    IWidget.CachePosition()

    DrawBackground()

    Declaration
    public override void DrawBackground()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.DrawBackground()
    Implements
    IWidget.DrawBackground()

    DrawForeground()

    Declaration
    public override void DrawForeground()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.DrawForeground()
    Implements
    IWidget.DrawForeground()

    DrawOverlay()

    Declaration
    public override void DrawOverlay()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.DrawOverlay()
    Implements
    IWidget.DrawOverlay()

    FetchInspectorMetadata()

    Declaration
    public virtual Metadata FetchInspectorMetadata()
    Returns
    Type Description
    Metadata

    FetchMetadata()

    Declaration
    public override Metadata FetchMetadata()
    Returns
    Type Description
    Metadata
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.FetchMetadata()

    GetHeight()

    Declaration
    public float GetHeight()
    Returns
    Type Description
    Single
    Implements
    IUnitPortWidget.GetHeight()

    GetInnerWidth()

    Declaration
    public float GetInnerWidth()
    Returns
    Type Description
    Single
    Implements
    IUnitPortWidget.GetInnerWidth()

    HandleInput()

    Declaration
    public override void HandleInput()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TPort>.HandleInput()
    Implements
    IWidget.HandleInput()

    Explicit Interface Implementations

    IUnitPortWidget.port

    Declaration
    IUnitPort IUnitPortWidget.port { get; }
    Returns
    Type Description
    IUnitPort
    Implements
    IUnitPortWidget.port

    Extension Methods

    XAnalyserProvider.Analyser(Object, IGraphContext)
    XAnalyserProvider.Analyser<TAnalyser>(Object, IGraphContext)
    XAnalyserProvider.Analysis(Object, IGraphContext)
    XAnalyserProvider.Analysis<TAnalysis>(Object, IGraphContext)
    XAnalyserProvider.Analyser(Object, GraphReference)
    XAnalyserProvider.Analyser<TAnalyser>(Object, GraphReference)
    XAnalyserProvider.Analysis(Object, GraphReference)
    XAnalyserProvider.Analysis<TAnalysis>(Object, GraphReference)
    XDescriptorProvider.Describe(Object)
    XDescriptorProvider.HasDescriptor(Object)
    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    XDescriptorProvider.Description(Object)
    XDescriptorProvider.Description<TDescription>(Object)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.CloneViaFakeSerialization(Object)
    Cloning.CloneViaFakeSerialization<T>(T)
    ConversionUtility.IsConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsConvertibleTo<T>(Object, Boolean)
    ConversionUtility.ConvertTo(Object, Type)
    ConversionUtility.ConvertTo<T>(Object)
    TypeUtility.ToShortString(Object, Int32)
    Serialization.CloneViaSerialization<T>(T, Boolean)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, Boolean)
    Serialization.Serialize(Object, Boolean)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.ToSafeString(Object)
    Back to top
    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