docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class UnitWidget<TUnit>

    Inheritance
    object
    Widget<FlowCanvas, TUnit>
    GraphElementWidget<FlowCanvas, TUnit>
    NodeWidget<FlowCanvas, TUnit>
    UnitWidget<TUnit>
    EventUnitWidget
    GraphInputWidget
    GraphOutputWidget
    LiteralWidget
    MissingTypeUnitWidget
    NestrerUnitWidget<TNesterUnit>
    TriggerStateTransitionWidget
    UnifiedVariableUnitWidget
    VariableUnitWidget
    Implements
    INodeWidget
    IUnitWidget
    IGraphElementWidget
    IWidget
    IDisposable
    Inherited Members
    NodeWidget<FlowCanvas, TUnit>.invertForeground
    NodeWidget<FlowCanvas, TUnit>.EdgeToOuterPosition(Rect)
    NodeWidget<FlowCanvas, TUnit>.OuterToEdgePosition(Rect)
    NodeWidget<FlowCanvas, TUnit>.EdgeToInnerPosition(Rect)
    NodeWidget<FlowCanvas, TUnit>.InnerToEdgePosition(Rect)
    NodeWidget<FlowCanvas, TUnit>.DrawForeground()
    NodeWidget<FlowCanvas, TUnit>.DrawOverlay()
    NodeWidget<FlowCanvas, TUnit>.outerPosition
    NodeWidget<FlowCanvas, TUnit>.edgePosition
    NodeWidget<FlowCanvas, TUnit>.innerPosition
    NodeWidget<FlowCanvas, TUnit>.clippingPosition
    NodeWidget<FlowCanvas, TUnit>.shape
    NodeWidget<FlowCanvas, TUnit>.color
    GraphElementWidget<FlowCanvas, TUnit>.resizeInnerOffset
    GraphElementWidget<FlowCanvas, TUnit>.resizeOuterOffset
    GraphElementWidget<FlowCanvas, TUnit>.minResizeSize
    GraphElementWidget<FlowCanvas, TUnit>.maxResizeSize
    GraphElementWidget<FlowCanvas, TUnit>.ToString()
    GraphElementWidget<FlowCanvas, TUnit>.Dispose()
    GraphElementWidget<FlowCanvas, TUnit>.FetchMetadata()
    GraphElementWidget<FlowCanvas, TUnit>.GetData<T>()
    GraphElementWidget<FlowCanvas, TUnit>.GetDebugData<T>()
    GraphElementWidget<FlowCanvas, TUnit>.BeforeFrame()
    GraphElementWidget<FlowCanvas, TUnit>.HandleCapture()
    GraphElementWidget<FlowCanvas, TUnit>.HandleInput()
    GraphElementWidget<FlowCanvas, TUnit>.HandleDoubleClick()
    GraphElementWidget<FlowCanvas, TUnit>.OnDoubleClick()
    GraphElementWidget<FlowCanvas, TUnit>.OnContext()
    GraphElementWidget<FlowCanvas, TUnit>.AddCursorRect(Rect, MouseCursor)
    GraphElementWidget<FlowCanvas, TUnit>.BeginDrag()
    GraphElementWidget<FlowCanvas, TUnit>.Drag(Vector2, Vector2)
    GraphElementWidget<FlowCanvas, TUnit>.EndDrag()
    GraphElementWidget<FlowCanvas, TUnit>.LockDragOrigin()
    GraphElementWidget<FlowCanvas, TUnit>.ExpandDragGroup(HashSet<IGraphElement>)
    GraphElementWidget<FlowCanvas, TUnit>.Delete()
    GraphElementWidget<FlowCanvas, TUnit>.ExpandDeleteGroup(HashSet<IGraphElement>)
    GraphElementWidget<FlowCanvas, TUnit>.ExpandCopyGroup(HashSet<IGraphElement>)
    GraphElementWidget<FlowCanvas, TUnit>.headerPosition
    GraphElementWidget<FlowCanvas, TUnit>.element
    GraphElementWidget<FlowCanvas, TUnit>.canAlignAndDistribute
    GraphElementWidget<FlowCanvas, TUnit>.zIndex
    GraphElementWidget<FlowCanvas, TUnit>.contextOptions
    GraphElementWidget<FlowCanvas, TUnit>.canSelect
    GraphElementWidget<FlowCanvas, TUnit>.isSelected
    GraphElementWidget<FlowCanvas, TUnit>.canResizeHorizontal
    GraphElementWidget<FlowCanvas, TUnit>.canResizeVertical
    GraphElementWidget<FlowCanvas, TUnit>.canResize
    GraphElementWidget<FlowCanvas, TUnit>.isResizing
    GraphElementWidget<FlowCanvas, TUnit>.resizeArea
    GraphElementWidget<FlowCanvas, TUnit>.isMouseOverHeaderArea
    GraphElementWidget<FlowCanvas, TUnit>.canDrag
    GraphElementWidget<FlowCanvas, TUnit>.isDragging
    GraphElementWidget<FlowCanvas, TUnit>.canDelete
    GraphElementWidget<FlowCanvas, TUnit>.canCopy
    Widget<FlowCanvas, TUnit>.hasDescriptor
    Widget<FlowCanvas, TUnit>.SubWidgetsChanged()
    Widget<FlowCanvas, TUnit>.CacheItemFirstTime()
    Widget<FlowCanvas, TUnit>.CacheItem()
    Widget<FlowCanvas, TUnit>.CacheMetadata()
    Widget<FlowCanvas, TUnit>.CacheDescription()
    Widget<FlowCanvas, TUnit>.RegisterControl()
    Widget<FlowCanvas, TUnit>.HandleRelease()
    Widget<FlowCanvas, TUnit>.Update()
    Widget<FlowCanvas, TUnit>.Reposition()
    Widget<FlowCanvas, TUnit>.CachePositionFirstPass()
    Widget<FlowCanvas, TUnit>.CachePosition()
    Widget<FlowCanvas, TUnit>.BringToFront()
    Widget<FlowCanvas, TUnit>.SendToBack()
    Widget<FlowCanvas, TUnit>.OnViewportChange()
    Widget<FlowCanvas, TUnit>.HandleContext()
    Widget<FlowCanvas, TUnit>.DrawBackground()
    Widget<FlowCanvas, TUnit>.BeginDim()
    Widget<FlowCanvas, TUnit>.EndDim()
    Widget<FlowCanvas, TUnit>.UpdateDim()
    Widget<FlowCanvas, TUnit>.context
    Widget<FlowCanvas, TUnit>.reference
    Widget<FlowCanvas, TUnit>.graph
    Widget<FlowCanvas, TUnit>.canvas
    Widget<FlowCanvas, TUnit>.selection
    Widget<FlowCanvas, TUnit>.window
    Widget<FlowCanvas, TUnit>.mousePosition
    Widget<FlowCanvas, TUnit>.disposed
    Widget<FlowCanvas, TUnit>.e
    Widget<FlowCanvas, TUnit>.subWidgets
    Widget<FlowCanvas, TUnit>.item
    Widget<FlowCanvas, TUnit>.metadata
    Widget<FlowCanvas, TUnit>.snapToGrid
    Widget<FlowCanvas, TUnit>.isPositionValid
    Widget<FlowCanvas, TUnit>.positionDependers
    Widget<FlowCanvas, TUnit>.positionDependencies
    Widget<FlowCanvas, TUnit>.position
    Widget<FlowCanvas, TUnit>.canClip
    Widget<FlowCanvas, TUnit>.isVisible
    Widget<FlowCanvas, TUnit>.hotArea
    Widget<FlowCanvas, TUnit>.isMouseThrough
    Widget<FlowCanvas, TUnit>.isMouseOver
    Widget<FlowCanvas, TUnit>.debug
    Widget<FlowCanvas, TUnit>.foregroundRequiresInput
    Widget<FlowCanvas, TUnit>.backgroundRequiresInput
    Widget<FlowCanvas, TUnit>.overlayRequiresInput
    Widget<FlowCanvas, TUnit>.dim
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.VisualScripting
    Assembly: Unity.VisualScripting.Flow.Editor.dll
    Syntax
    [Widget(typeof(IUnit))]
    public class UnitWidget<TUnit> : NodeWidget<FlowCanvas, TUnit>, INodeWidget, IUnitWidget, IGraphElementWidget, IWidget, IDisposable where TUnit : class, IUnit
    Type Parameters
    Name Description
    TUnit

    Constructors

    UnitWidget(FlowCanvas, TUnit)

    Declaration
    public UnitWidget(FlowCanvas canvas, TUnit unit)
    Parameters
    Type Name Description
    FlowCanvas canvas
    TUnit unit

    Fields

    _position

    Declaration
    protected Rect _position
    Field Value
    Type Description
    Rect

    inputs

    Declaration
    protected readonly List<IUnitPortWidget> inputs
    Field Value
    Type Description
    List<IUnitPortWidget>

    outputs

    Declaration
    protected readonly List<IUnitPortWidget> outputs
    Field Value
    Type Description
    List<IUnitPortWidget>

    ports

    Declaration
    protected readonly List<IUnitPortWidget> ports
    Field Value
    Type Description
    List<IUnitPortWidget>

    settingLabelsContents

    Declaration
    protected readonly Dictionary<Metadata, GUIContent> settingLabelsContents
    Field Value
    Type Description
    Dictionary<Metadata, GUIContent>

    subtitleContent

    Declaration
    protected readonly GUIContent subtitleContent
    Field Value
    Type Description
    GUIContent

    surtitleContent

    Declaration
    protected readonly GUIContent surtitleContent
    Field Value
    Type Description
    GUIContent

    titleContent

    Declaration
    protected readonly GUIContent titleContent
    Field Value
    Type Description
    GUIContent

    Properties

    baseColor

    Declaration
    protected virtual NodeColorMix baseColor { get; }
    Property Value
    Type Description
    NodeColorMix

    canDelete

    Declaration
    public override bool canDelete { get; }
    Property Value
    Type Description
    bool
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.FlowCanvas, TUnit>.canDelete

    canDrag

    Declaration
    public override bool canDrag { get; }
    Property Value
    Type Description
    bool
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.FlowCanvas, TUnit>.canDrag

    canSelect

    Declaration
    public override bool canSelect { get; }
    Property Value
    Type Description
    bool
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.FlowCanvas, TUnit>.canSelect

    color

    Declaration
    protected override NodeColorMix color { get; }
    Property Value
    Type Description
    NodeColorMix
    Overrides
    Unity.VisualScripting.NodeWidget<Unity.VisualScripting.FlowCanvas, TUnit>.color

    contextOptions

    Declaration
    protected override IEnumerable<DropdownOption> contextOptions { get; }
    Property Value
    Type Description
    IEnumerable<DropdownOption>
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.FlowCanvas, TUnit>.contextOptions

    dim

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

    foregroundRequiresInput

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

    headerAddonPosition

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

    iconPosition

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

    iconsPositions

    Declaration
    public List<Rect> iconsPositions { get; }
    Property Value
    Type Description
    List<Rect>

    portsBackgroundPosition

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

    position

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

    positionDependers

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

    settings

    Declaration
    protected IEnumerable<Metadata> settings { get; }
    Property Value
    Type Description
    IEnumerable<Metadata>

    settingsPositions

    Declaration
    public Dictionary<Metadata, Rect> settingsPositions { get; }
    Property Value
    Type Description
    Dictionary<Metadata, Rect>

    shape

    Declaration
    protected override NodeShape shape { get; }
    Property Value
    Type Description
    NodeShape
    Overrides
    Unity.VisualScripting.NodeWidget<Unity.VisualScripting.FlowCanvas, TUnit>.shape

    showHeaderAddon

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

    showIcons

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

    showPorts

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

    showSettings

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

    showSubtitle

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

    showSurtitle

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

    showTitle

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

    snapToGrid

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

    subWidgets

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

    subtitlePosition

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

    surtitlePosition

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

    titlePosition

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

    unit

    Declaration
    protected TUnit unit { get; }
    Property Value
    Type Description
    TUnit

    unitDebugData

    Declaration
    protected IUnitDebugData unitDebugData { get; }
    Property Value
    Type Description
    IUnitDebugData

    Methods

    CacheDefinition()

    Declaration
    protected virtual void CacheDefinition()

    CacheDescription()

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

    CacheItemFirstTime()

    Declaration
    protected override void CacheItemFirstTime()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.FlowCanvas, TUnit>.CacheItemFirstTime()

    CacheMetadata()

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

    CachePosition()

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

    Dispose()

    Declaration
    public override void Dispose()
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.FlowCanvas, TUnit>.Dispose()

    DrawForeground()

    Declaration
    public override void DrawForeground()
    Overrides
    Unity.VisualScripting.NodeWidget<Unity.VisualScripting.FlowCanvas, TUnit>.DrawForeground()

    DrawHeaderAddon()

    Declaration
    protected virtual void DrawHeaderAddon()

    DrawIcon()

    Declaration
    protected void DrawIcon()

    DrawIcons()

    Declaration
    protected void DrawIcons()

    DrawPortsBackground()

    Declaration
    protected void DrawPortsBackground()

    DrawSetting(Metadata)

    Declaration
    protected void DrawSetting(Metadata setting)
    Parameters
    Type Name Description
    Metadata setting

    DrawSubtitle()

    Declaration
    protected void DrawSubtitle()

    DrawSurtitle()

    Declaration
    protected void DrawSurtitle()

    DrawTitle()

    Declaration
    protected void DrawTitle()

    ExpandCopyGroup(HashSet<IGraphElement>)

    Declaration
    public override void ExpandCopyGroup(HashSet<IGraphElement> copyGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> copyGroup
    Overrides
    GraphElementWidget<FlowCanvas, TUnit>.ExpandCopyGroup(HashSet<IGraphElement>)

    ExpandDragGroup(HashSet<IGraphElement>)

    Declaration
    public override void ExpandDragGroup(HashSet<IGraphElement> dragGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> dragGroup
    Overrides
    GraphElementWidget<FlowCanvas, TUnit>.ExpandDragGroup(HashSet<IGraphElement>)

    GetHeaderAddonHeight(float)

    Declaration
    protected virtual float GetHeaderAddonHeight(float width)
    Parameters
    Type Name Description
    float width
    Returns
    Type Description
    float

    GetHeaderAddonWidth()

    Declaration
    protected virtual float GetHeaderAddonWidth()
    Returns
    Type Description
    float

    GetPortInspector(IUnitPort, Metadata)

    Declaration
    public virtual Inspector GetPortInspector(IUnitPort port, Metadata metadata)
    Parameters
    Type Name Description
    IUnitPort port
    Metadata metadata
    Returns
    Type Description
    Inspector

    HandleInput()

    Declaration
    public override void HandleInput()
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.FlowCanvas, TUnit>.HandleInput()

    Implements

    INodeWidget
    IUnitWidget
    IGraphElementWidget
    IWidget
    IDisposable

    Extension Methods

    Cloning.Clone(object, ICloner, bool)
    Cloning.Clone(object, ICloner, bool)
    Cloning.CloneViaFakeSerialization(object)
    Cloning.CloneViaFakeSerialization(object)
    ConversionUtility.ConvertTo(object, Type)
    ConversionUtility.ConvertTo(object, Type)
    ConversionUtility.ConvertTo<T>(object)
    ConversionUtility.ConvertTo<T>(object)
    ConversionUtility.IsConvertibleTo(object, Type, bool)
    ConversionUtility.IsConvertibleTo(object, Type, bool)
    ConversionUtility.IsConvertibleTo<T>(object, bool)
    ConversionUtility.IsConvertibleTo<T>(object, bool)
    Serialization.Serialize(object, bool)
    Serialization.Serialize(object, bool)
    TypeUtility.ToShortString(object, int)
    TypeUtility.ToShortString(object, int)
    UnityObjectUtility.IsUnityNull(object)
    UnityObjectUtility.IsUnityNull(object)
    UnityObjectUtility.ToSafeString(object)
    UnityObjectUtility.ToSafeString(object)
    XAnalyserProvider.Analyser(object, GraphReference)
    XAnalyserProvider.Analyser(object, IGraphContext)
    XAnalyserProvider.Analyser<TAnalyser>(object, GraphReference)
    XAnalyserProvider.Analyser<TAnalyser>(object, IGraphContext)
    XAnalyserProvider.Analysis(object, GraphReference)
    XAnalyserProvider.Analysis(object, IGraphContext)
    XAnalyserProvider.Analysis<TAnalysis>(object, GraphReference)
    XAnalyserProvider.Analysis<TAnalysis>(object, IGraphContext)
    XDescriptorProvider.Describe(object)
    XDescriptorProvider.Description(object)
    XDescriptorProvider.Description<TDescription>(object)
    XDescriptorProvider.Descriptor(object)
    XDescriptorProvider.Descriptor<TDescriptor>(object)
    XDescriptorProvider.HasDescriptor(object)
    Cloning.CloneViaFakeSerialization<T>(T)
    Cloning.CloneViaFakeSerialization<T>(T)
    Cloning.Clone<T>(T, ICloner, bool)
    Cloning.Clone<T>(T, ICloner, bool)
    LinqUtility.Yield<T>(T)
    LinqUtility.Yield<T>(T)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, bool)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, bool)
    Serialization.CloneViaSerialization<T>(T, bool)
    Serialization.CloneViaSerialization<T>(T, bool)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)