Class FlowCanvas | Bolt Visual Scripting | 1.4.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class FlowCanvas

    Inheritance
    Object
    Canvas
    FlowCanvas
    Inherited Members
    Canvas.window
    Canvas.e
    Canvas.graph
    Canvas.reference
    Canvas.selection
    Canvas.Dispose()
    Canvas.OnGraphElementsChanged(Object, NotifyCollectionChangedEventArgs)
    Canvas.Cache()
    Canvas.CacheWidgetModels()
    Canvas.ICanvas.widgets
    Canvas.widgets
    Canvas.elementWidgets
    Canvas.InvalidateWidgetCollections()
    Canvas.CacheWidgetCollections()
    Canvas.OrderWidgetsZ()
    Canvas.Open(ICanvasWindow)
    Canvas.RegisterControls()
    Canvas.Update()
    Canvas.BeforeFrame()
    Canvas.OnGUI()
    Canvas.HandleEventCapture()
    Canvas.HandleWidgetInput()
    Canvas.HandleEventRelease()
    Canvas.HandleMaximization()
    Canvas.ToggleMaximized()
    Canvas.zoom
    Canvas.pan
    Canvas.viewport
    Canvas.fullViewport
    Canvas.mousePosition
    Canvas.isMouseOver
    Canvas.isMouseOverBackground
    Canvas.widgetsByAscendingZ
    Canvas.visibleWidgetsByAscendingZ
    Canvas.visibleWidgetsByDescendingZ
    Canvas.UpdateViewport()
    Canvas.IsVisible(IWidget)
    Canvas.TweenViewport(Vector2, Single, Single)
    Canvas.TweenViewport(Rect, Single)
    Canvas.CacheWidgetVisibility()
    Canvas.Frame(IEnumerable<IGraphElement>)
    Canvas.Ping(IEnumerable<IGraphElement>, PingMode, Boolean, Boolean)
    Canvas.ClearPing()
    Canvas.RepositionAll()
    Canvas.CacheWidgetPositions()
    Canvas.hoveredWidget
    Canvas.OnHoveredWidgetChange()
    Canvas.isLassoing
    Canvas.lassoArea
    Canvas.isSelecting
    Canvas.selectionArea
    Canvas.HandleSelectionShortcuts()
    Canvas.isGrouping
    Canvas.groupArea
    Canvas.isDragging
    Canvas.WouldDrag(IGraphElement)
    Canvas.RegisterSnappingSets(SnappingSystem)
    Canvas.BeginDrag(EventWrapper)
    Canvas.Drag(EventWrapper)
    Canvas.EndDrag(EventWrapper)
    Canvas.DeleteSelection()
    Canvas.isInspectable
    Canvas.ShowInspector()
    Canvas.alignableAndDistributable
    Canvas.Align(AlignOperation)
    Canvas.Distribute(DistributeOperation)
    Canvas.hasSearchResults
    Canvas.currentSearchResult
    Canvas.Search(Boolean)
    Canvas.PingSearchResults()
    Canvas.NextSearchResult()
    Canvas.PreviousSearchResult()
    Canvas.SearchResults(SearchQuery)
    Canvas.DrawBackground()
    Canvas.DrawWidgetsBackground()
    Canvas.DrawWidgetsForeground()
    Canvas.DrawWidgetsOverlay()
    Canvas.DrawOverlay()
    Canvas.dragAndDropVisualMode
    Canvas.UpdateDragAndDrop()
    Canvas.ExitDragAndDrop()
    Canvas.frameDeltaTime
    Canvas.eventDeltaTime
    Canvas.repaintDeltaTime
    Canvas.GetToolbarWidth()
    Canvas.GetActionToolbarWidth()
    Canvas.OnActionToolbarGUI(Boolean, Boolean)
    Canvas.OnToolbarGUI()
    Canvas.unclipCallbacks
    Canvas.whenUnclipped
    Canvas.ProcessUnclipCallbacks()
    Canvas.GetSelectionCollapseRequest()
    Canvas.ExpandCollapseGroup(HashSet<IGraphElement>)
    Canvas.HandleCollapsing()
    Canvas.isScreenshotting
    Canvas.BeginScreenshot(IEnumerable<IGraphChild>)
    Canvas.EndScreenshot()
    Namespace: Ludiq.Bolt
    Syntax
    public sealed class FlowCanvas : Canvas, ICanvas, IDisposable, IDragAndDropHandler

    Constructors

    FlowCanvas(FlowGraphContext)

    Declaration
    public FlowCanvas(FlowGraphContext context)
    Parameters
    Type Name Description
    FlowGraphContext context

    Fields

    inspectorZoomThreshold

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

    Properties

    allowProxyConnection

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

    connectionEndPosition

    Declaration
    public Vector2 connectionEndPosition { get; }
    Property Value
    Type Description
    Vector2

    connectionSource

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

    connectViaProxy

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

    context

    Declaration
    public FlowGraphContext context { get; }
    Property Value
    Type Description
    FlowGraphContext

    isConnecting

    Declaration
    public override bool isConnecting { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Canvas.isConnecting

    shouldEdgePan

    Declaration
    protected override bool shouldEdgePan { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Canvas.shouldEdgePan

    Methods

    AcceptsDragAndDrop()

    Declaration
    public override bool AcceptsDragAndDrop()
    Returns
    Type Description
    Boolean
    Overrides
    Canvas.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()

    CanCollapse(IEnumerable<IGraphElement>)

    Declaration
    public override bool CanCollapse(IEnumerable<IGraphElement> elements)
    Parameters
    Type Name Description
    IEnumerable<IGraphElement> elements
    Returns
    Type Description
    Boolean
    Overrides
    Canvas.CanCollapse(IEnumerable<IGraphElement>)

    CanCompleteConnectionTo(IUnitPort, Boolean)

    Declaration
    public bool CanCompleteConnectionTo(IUnitPort destination, bool allowStructural = false)
    Parameters
    Type Name Description
    IUnitPort destination
    Boolean allowStructural
    Returns
    Type Description
    Boolean

    Close()

    Declaration
    public override void Close()
    Overrides
    Canvas.Close()

    CompleteConnection(IUnitPort, IUnitPort)

    Declaration
    public void CompleteConnection(IUnitPort source, IUnitPort destination)
    Parameters
    Type Name Description
    IUnitPort source
    IUnitPort destination

    CreateCollapseRequest()

    Declaration
    protected override ICollapseRequest CreateCollapseRequest()
    Returns
    Type Description
    ICollapseRequest
    Overrides
    Canvas.CreateCollapseRequest()

    DrawDragAndDropPreview()

    Declaration
    public override void DrawDragAndDropPreview()
    Overrides
    Canvas.DrawDragAndDropPreview()

    FilterCollapseGroup(HashSet<IGraphElement>)

    Declaration
    protected override void FilterCollapseGroup(HashSet<IGraphElement> group)
    Parameters
    Type Name Description
    HashSet<IGraphElement> group
    Overrides
    Canvas.FilterCollapseGroup(HashSet<IGraphElement>)

    GetCollapseHandlers()

    Declaration
    public override IEnumerable<ICollapseHandler> GetCollapseHandlers()
    Returns
    Type Description
    IEnumerable<ICollapseHandler>
    Overrides
    Canvas.GetCollapseHandlers()

    GetContextOptions()

    Declaration
    protected override IEnumerable<DropdownOption> GetContextOptions()
    Returns
    Type Description
    IEnumerable<DropdownOption>
    Overrides
    Canvas.GetContextOptions()

    GetDisplayToolbarWidth()

    Declaration
    protected override float GetDisplayToolbarWidth()
    Returns
    Type Description
    Single
    Overrides
    Canvas.GetDisplayToolbarWidth()

    HandleHighPriorityInput()

    Declaration
    protected override void HandleHighPriorityInput()
    Overrides
    Canvas.HandleHighPriorityInput()

    HandleLowPriorityInput()

    Declaration
    protected override void HandleLowPriorityInput()
    Overrides
    Canvas.HandleLowPriorityInput()

    MoveConnectionEnd()

    Declaration
    public void MoveConnectionEnd()

    NewUnit(Vector2, UnitOptionTree, Action<IUnit>)

    Declaration
    public void NewUnit(Vector2 position, UnitOptionTree options, Action<IUnit> then = null)
    Parameters
    Type Name Description
    Vector2 position
    UnitOptionTree options
    Action<IUnit> then

    NewUnitContextual()

    Declaration
    public void NewUnitContextual()

    OnContext()

    Declaration
    protected override void OnContext()
    Overrides
    Canvas.OnContext()

    OnDisplayToolbarGUI(Boolean, Boolean)

    Declaration
    protected override void OnDisplayToolbarGUI(bool closeLeft, bool closeRight)
    Parameters
    Type Name Description
    Boolean closeLeft
    Boolean closeRight
    Overrides
    Canvas.OnDisplayToolbarGUI(Boolean, Boolean)

    PerformDragAndDrop()

    Declaration
    public override void PerformDragAndDrop()
    Overrides
    Canvas.PerformDragAndDrop()

    ReplaceConnectionByProxy(IUnitConnection)

    Declaration
    public void ReplaceConnectionByProxy(IUnitConnection connection)
    Parameters
    Type Name Description
    IUnitConnection connection

    ShrinkCopyGroup(HashSet<IGraphElement>)

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

    StartConnection(IUnitPort)

    Declaration
    public void StartConnection(IUnitPort connectionSource)
    Parameters
    Type Name Description
    IUnitPort connectionSource

    Extension Methods

    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    LiteralUtility.ToLiteralString(Object)
    LiteralUtility.ToLiteralStringOrDefault(Object)
    LiteralUtility.TryToLiteralString(Object, out String)
    XFilterProvider.Filter(Object)
    XFilterProvider.Filter<TFilter>(Object)
    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 OdinSerializer.SerializationData, DataFormat)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.UnityNullCoalesce(Object, Object)
    UnityObjectUtility.ToSafeString(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)
    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 Copyright © 2020 Unity Technologies
    Generated by DocFX