Interface ICanvas | Bolt Visual Scripting | 1.4.12
docs.unity3d.com
    Show / Hide Table of Contents

    Interface ICanvas

    Inherited Members
    IDragAndDropHandler.dragAndDropVisualMode
    IDragAndDropHandler.AcceptsDragAndDrop()
    IDragAndDropHandler.PerformDragAndDrop()
    IDragAndDropHandler.UpdateDragAndDrop()
    IDragAndDropHandler.DrawDragAndDropPreview()
    IDragAndDropHandler.ExitDragAndDrop()
    Namespace: Ludiq.Bolt
    Syntax
    public interface ICanvas : IDisposable, IDragAndDropHandler

    Properties

    context

    Declaration
    IGraphContext context { get; }
    Property Value
    Type Description
    IGraphContext

    eventDeltaTime

    Declaration
    float eventDeltaTime { get; }
    Property Value
    Type Description
    Single

    frameDeltaTime

    Declaration
    float frameDeltaTime { get; }
    Property Value
    Type Description
    Single

    fullViewport

    Declaration
    Rect fullViewport { get; }
    Property Value
    Type Description
    Rect

    groupArea

    Declaration
    Rect groupArea { get; }
    Property Value
    Type Description
    Rect

    hasSearchResults

    Declaration
    bool hasSearchResults { get; }
    Property Value
    Type Description
    Boolean

    hoveredWidget

    Declaration
    IWidget hoveredWidget { get; }
    Property Value
    Type Description
    IWidget

    isConnecting

    Declaration
    bool isConnecting { get; }
    Property Value
    Type Description
    Boolean

    isDragging

    Declaration
    bool isDragging { get; }
    Property Value
    Type Description
    Boolean

    isGrouping

    Declaration
    bool isGrouping { get; }
    Property Value
    Type Description
    Boolean

    isLassoing

    Declaration
    bool isLassoing { get; }
    Property Value
    Type Description
    Boolean

    isMouseOver

    Declaration
    bool isMouseOver { get; }
    Property Value
    Type Description
    Boolean

    isMouseOverBackground

    Declaration
    bool isMouseOverBackground { get; }
    Property Value
    Type Description
    Boolean

    isScreenshotting

    Declaration
    bool isScreenshotting { get; }
    Property Value
    Type Description
    Boolean

    isSelecting

    Declaration
    bool isSelecting { get; }
    Property Value
    Type Description
    Boolean

    lassoArea

    Declaration
    Rect lassoArea { get; }
    Property Value
    Type Description
    Rect

    mousePosition

    Declaration
    Vector2 mousePosition { get; }
    Property Value
    Type Description
    Vector2

    pan

    Declaration
    Vector2 pan { get; set; }
    Property Value
    Type Description
    Vector2

    repaintDeltaTime

    Declaration
    float repaintDeltaTime { get; }
    Property Value
    Type Description
    Single

    selectionArea

    Declaration
    Rect selectionArea { get; }
    Property Value
    Type Description
    Rect

    viewport

    Declaration
    Rect viewport { get; set; }
    Property Value
    Type Description
    Rect

    widgets

    Declaration
    IEnumerable<IWidget> widgets { get; }
    Property Value
    Type Description
    IEnumerable<IWidget>

    window

    Declaration
    ICanvasWindow window { get; set; }
    Property Value
    Type Description
    ICanvasWindow

    zoom

    Declaration
    float zoom { get; set; }
    Property Value
    Type Description
    Single

    Methods

    Align(AlignOperation)

    Declaration
    void Align(AlignOperation operation)
    Parameters
    Type Name Description
    AlignOperation operation

    BeforeFrame()

    Declaration
    void BeforeFrame()

    BeginDrag(EventWrapper)

    Declaration
    void BeginDrag(EventWrapper e)
    Parameters
    Type Name Description
    EventWrapper e

    BeginScreenshot(IEnumerable<IGraphChild>)

    Declaration
    void BeginScreenshot(IEnumerable<IGraphChild> screenshotGroup)
    Parameters
    Type Name Description
    IEnumerable<IGraphChild> screenshotGroup

    Cache()

    Declaration
    void Cache()

    CacheWidgetCollections()

    Declaration
    void CacheWidgetCollections()

    CacheWidgetPositions()

    Declaration
    void CacheWidgetPositions()

    CanCollapse(IEnumerable<IGraphElement>)

    Declaration
    bool CanCollapse(IEnumerable<IGraphElement> elements)
    Parameters
    Type Name Description
    IEnumerable<IGraphElement> elements
    Returns
    Type Description
    Boolean

    ClearPing()

    Declaration
    void ClearPing()

    Close()

    Declaration
    void Close()

    DeleteSelection()

    Declaration
    void DeleteSelection()

    Distribute(DistributeOperation)

    Declaration
    void Distribute(DistributeOperation operation)
    Parameters
    Type Name Description
    DistributeOperation operation

    Drag(EventWrapper)

    Declaration
    void Drag(EventWrapper e)
    Parameters
    Type Name Description
    EventWrapper e

    EndDrag(EventWrapper)

    Declaration
    void EndDrag(EventWrapper e)
    Parameters
    Type Name Description
    EventWrapper e

    EndScreenshot()

    Declaration
    void EndScreenshot()

    Frame(IEnumerable<IGraphElement>)

    Declaration
    void Frame(IEnumerable<IGraphElement> elements)
    Parameters
    Type Name Description
    IEnumerable<IGraphElement> elements

    GetCollapseHandlers()

    Declaration
    IEnumerable<ICollapseHandler> GetCollapseHandlers()
    Returns
    Type Description
    IEnumerable<ICollapseHandler>

    GetSelectionCollapseRequest()

    Declaration
    ICollapseRequest GetSelectionCollapseRequest()
    Returns
    Type Description
    ICollapseRequest

    GetToolbarWidth()

    Declaration
    float GetToolbarWidth()
    Returns
    Type Description
    Single

    InvalidateWidgetCollections()

    Declaration
    void InvalidateWidgetCollections()

    IsVisible(IWidget)

    Declaration
    bool IsVisible(IWidget widget)
    Parameters
    Type Name Description
    IWidget widget
    Returns
    Type Description
    Boolean

    NextSearchResult()

    Declaration
    void NextSearchResult()

    OnGUI()

    Declaration
    void OnGUI()

    OnToolbarGUI()

    Declaration
    void OnToolbarGUI()

    Open(ICanvasWindow)

    Declaration
    void Open(ICanvasWindow window)
    Parameters
    Type Name Description
    ICanvasWindow window

    OrderWidgetsZ()

    Declaration
    void OrderWidgetsZ()

    Ping(IEnumerable<IGraphElement>, PingMode, Boolean, Boolean)

    Declaration
    void Ping(IEnumerable<IGraphElement> elements, PingMode mode, bool frame, bool animate)
    Parameters
    Type Name Description
    IEnumerable<IGraphElement> elements
    PingMode mode
    Boolean frame
    Boolean animate

    PreviousSearchResult()

    Declaration
    void PreviousSearchResult()

    ProcessUnclipCallbacks()

    Declaration
    void ProcessUnclipCallbacks()

    RegisterControls()

    Declaration
    void RegisterControls()

    RepositionAll()

    Declaration
    void RepositionAll()

    Search(Boolean)

    Declaration
    void Search(bool ping)
    Parameters
    Type Name Description
    Boolean ping

    ShrinkCopyGroup(HashSet<IGraphElement>)

    Declaration
    void ShrinkCopyGroup(HashSet<IGraphElement> copyGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> copyGroup

    Update()

    Declaration
    void Update()

    UpdateViewport()

    Declaration
    void UpdateViewport()

    WouldDrag(IGraphElement)

    Declaration
    bool WouldDrag(IGraphElement element)
    Parameters
    Type Name Description
    IGraphElement element
    Returns
    Type Description
    Boolean

    Events

    whenUnclipped

    Declaration
    event Action whenUnclipped
    Event Type
    Type Description
    Action

    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