docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class FlowCanvas

    Inheritance
    object
    VisualScriptingCanvas<FlowGraph>
    FlowCanvas
    Implements
    ICanvas
    IDisposable
    IDragAndDropHandler
    Inherited Members
    VisualScriptingCanvas<FlowGraph>.Dispose()
    VisualScriptingCanvas<FlowGraph>.Cache()
    VisualScriptingCanvas<FlowGraph>.CacheWidgetItems()
    VisualScriptingCanvas<FlowGraph>.Recollect()
    VisualScriptingCanvas<FlowGraph>.CacheWidgetCollections()
    VisualScriptingCanvas<FlowGraph>.Open()
    VisualScriptingCanvas<FlowGraph>.RegisterControls()
    VisualScriptingCanvas<FlowGraph>.Update()
    VisualScriptingCanvas<FlowGraph>.BeforeFrame()
    VisualScriptingCanvas<FlowGraph>.OnGUI()
    VisualScriptingCanvas<FlowGraph>.UpdateViewport()
    VisualScriptingCanvas<FlowGraph>.TweenViewport(Vector2, float, float)
    VisualScriptingCanvas<FlowGraph>.CacheWidgetVisibility()
    VisualScriptingCanvas<FlowGraph>.ViewElements(IEnumerable<IGraphElement>)
    VisualScriptingCanvas<FlowGraph>.IsVisible(IWidget)
    VisualScriptingCanvas<FlowGraph>.CacheWidgetPositions()
    VisualScriptingCanvas<FlowGraph>.BeginDrag(EventWrapper)
    VisualScriptingCanvas<FlowGraph>.Drag(EventWrapper)
    VisualScriptingCanvas<FlowGraph>.EndDrag(EventWrapper)
    VisualScriptingCanvas<FlowGraph>.DeleteSelection()
    VisualScriptingCanvas<FlowGraph>.Align(AlignOperation)
    VisualScriptingCanvas<FlowGraph>.Distribute(DistributeOperation)
    VisualScriptingCanvas<FlowGraph>.UpdateDragAndDrop()
    VisualScriptingCanvas<FlowGraph>.ExitDragAndDrop()
    VisualScriptingCanvas<FlowGraph>.widgetProvider
    VisualScriptingCanvas<FlowGraph>.selection
    VisualScriptingCanvas<FlowGraph>.window
    VisualScriptingCanvas<FlowGraph>.graph
    VisualScriptingCanvas<FlowGraph>.zoom
    VisualScriptingCanvas<FlowGraph>.pan
    VisualScriptingCanvas<FlowGraph>.viewport
    VisualScriptingCanvas<FlowGraph>.mousePosition
    VisualScriptingCanvas<FlowGraph>.isMouseOver
    VisualScriptingCanvas<FlowGraph>.isMouseOverBackground
    VisualScriptingCanvas<FlowGraph>.hoveredWidget
    VisualScriptingCanvas<FlowGraph>.isLassoing
    VisualScriptingCanvas<FlowGraph>.lassoArea
    VisualScriptingCanvas<FlowGraph>.isSelecting
    VisualScriptingCanvas<FlowGraph>.selectionArea
    VisualScriptingCanvas<FlowGraph>.isGrouping
    VisualScriptingCanvas<FlowGraph>.groupArea
    VisualScriptingCanvas<FlowGraph>.isDragging
    VisualScriptingCanvas<FlowGraph>.alignableAndDistributable
    VisualScriptingCanvas<FlowGraph>.dragAndDropVisualMode
    VisualScriptingCanvas<FlowGraph>.frameDeltaTime
    VisualScriptingCanvas<FlowGraph>.eventDeltaTime
    VisualScriptingCanvas<FlowGraph>.repaintDeltaTime
    VisualScriptingCanvas<FlowGraph>.delayedCalls
    VisualScriptingCanvas<FlowGraph>.delayCall
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.VisualScripting
    Assembly: Unity.VisualScripting.Flow.Editor.dll
    Syntax
    [Canvas(typeof(FlowGraph))]
    public sealed class FlowCanvas : VisualScriptingCanvas<FlowGraph>, ICanvas, IDisposable, IDragAndDropHandler

    Constructors

    FlowCanvas(FlowGraph)

    Declaration
    public FlowCanvas(FlowGraph graph)
    Parameters
    Type Name Description
    FlowGraph graph

    Fields

    inspectorZoomThreshold

    Declaration
    public const float inspectorZoomThreshold = 0.7
    Field Value
    Type Description
    float

    Properties

    connectionEnd

    Declaration
    public Vector2 connectionEnd { get; set; }
    Property Value
    Type Description
    Vector2

    connectionSource

    Declaration
    public IUnitPort connectionSource { get; set; }
    Property Value
    Type Description
    IUnitPort

    isCreatingConnection

    Declaration
    public bool isCreatingConnection { get; }
    Property Value
    Type Description
    bool

    shouldEdgePan

    Declaration
    protected override bool shouldEdgePan { get; }
    Property Value
    Type Description
    bool
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.shouldEdgePan

    showRelations

    Declaration
    public bool showRelations { get; set; }
    Property Value
    Type Description
    bool

    Methods

    AcceptsDragAndDrop()

    Declaration
    public override bool AcceptsDragAndDrop()
    Returns
    Type Description
    bool
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.AcceptsDragAndDrop()

    AddUnit(IUnit, Vector2)

    Declaration
    public void AddUnit(IUnit unit, Vector2 position)
    Parameters
    Type Name Description
    IUnit unit
    Vector2 position

    CancelConnection()

    Declaration
    public void CancelConnection()

    Close()

    Declaration
    public override void Close()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.Close()

    DrawDragAndDropPreview()

    Declaration
    public override void DrawDragAndDropPreview()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.DrawDragAndDropPreview()

    GetContextOptions()

    Declaration
    protected override IEnumerable<DropdownOption> GetContextOptions()
    Returns
    Type Description
    IEnumerable<DropdownOption>
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.GetContextOptions()

    HandleHighPriorityInput()

    Declaration
    protected override void HandleHighPriorityInput()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.HandleHighPriorityInput()

    NewUnitContextual()

    Declaration
    public void NewUnitContextual()

    OnContext()

    Declaration
    protected override void OnContext()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.OnContext()

    OnToolbarGUI()

    Declaration
    public override void OnToolbarGUI()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.OnToolbarGUI()

    PerformDragAndDrop()

    Declaration
    public override void PerformDragAndDrop()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.FlowGraph>.PerformDragAndDrop()

    ShrinkCopyGroup(HashSet<IGraphElement>)

    Declaration
    public override void ShrinkCopyGroup(HashSet<IGraphElement> copyGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> copyGroup
    Overrides
    VisualScriptingCanvas<FlowGraph>.ShrinkCopyGroup(HashSet<IGraphElement>)

    Implements

    ICanvas
    IDisposable
    IDragAndDropHandler

    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)