Class Canvas

Inheritance
Object
Canvas
FlowCanvas
StateCanvas
Namespace: Ludiq.Bolt
Syntax
public abstract class Canvas : ICanvas, IDisposable, IDragAndDropHandler

Constructors

Canvas(IGraphContext)

Declaration
protected Canvas(IGraphContext context)
Parameters
Type Name Description
IGraphContext context

Fields

elementWidgets

Declaration
protected readonly WidgetList<IGraphElementWidget> elementWidgets
Field Value
Type Description
WidgetList<IGraphElementWidget>

visibleWidgetsByAscendingZ

Declaration
protected readonly WidgetList<IWidget> visibleWidgetsByAscendingZ
Field Value
Type Description
WidgetList<IWidget>

visibleWidgetsByDescendingZ

Declaration
protected readonly WidgetList<IWidget> visibleWidgetsByDescendingZ
Field Value
Type Description
WidgetList<IWidget>

widgets

Declaration
protected readonly WidgetList<IWidget> widgets
Field Value
Type Description
WidgetList<IWidget>

widgetsByAscendingZ

Declaration
protected readonly WidgetList<IWidget> widgetsByAscendingZ
Field Value
Type Description
WidgetList<IWidget>

Properties

alignableAndDistributable

Declaration
public IEnumerable<IGraphElementWidget> alignableAndDistributable { get; }
Property Value
Type Description
IEnumerable<IGraphElementWidget>

context

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

currentSearchResult

Declaration
public IGraphElement currentSearchResult { get; }
Property Value
Type Description
IGraphElement

dragAndDropVisualMode

Declaration
public virtual DragAndDropVisualMode dragAndDropVisualMode { get; }
Property Value
Type Description
DragAndDropVisualMode
Implements

e

Declaration
protected EventWrapper e { get; }
Property Value
Type Description
EventWrapper

eventDeltaTime

Declaration
[DoNotSerialize]
public float eventDeltaTime { get; }
Property Value
Type Description
Single
Implements

frameDeltaTime

Declaration
[DoNotSerialize]
public float frameDeltaTime { get; }
Property Value
Type Description
Single
Implements

fullViewport

Declaration
public virtual Rect fullViewport { get; }
Property Value
Type Description
Rect
Implements

graph

Declaration
protected IGraph graph { get; }
Property Value
Type Description
IGraph

groupArea

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

hasSearchResults

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

hoveredWidget

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

isConnecting

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

isDragging

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

isGrouping

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

isInspectable

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

isLassoing

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

isMouseOver

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

isMouseOverBackground

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

isScreenshotting

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

isSelecting

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

lassoArea

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

mousePosition

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

pan

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

reference

Declaration
protected GraphReference reference { get; }
Property Value
Type Description
GraphReference

repaintDeltaTime

Declaration
[DoNotSerialize]
public float repaintDeltaTime { get; }
Property Value
Type Description
Single
Implements

selection

Declaration
protected GraphSelection selection { get; }
Property Value
Type Description
GraphSelection

selectionArea

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

shouldEdgePan

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

unclipCallbacks

Declaration
public Queue<Action> unclipCallbacks { get; }
Property Value
Type Description
Queue<Action>

viewport

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

window

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

zoom

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

Methods

AcceptsDragAndDrop()

Declaration
public virtual bool AcceptsDragAndDrop()
Returns
Type Description
Boolean
Implements

Align(AlignOperation)

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

BeforeFrame()

Declaration
public void BeforeFrame()
Implements

BeginDrag(EventWrapper)

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

BeginScreenshot(IEnumerable<IGraphChild>)

Declaration
public void BeginScreenshot(IEnumerable<IGraphChild> group)
Parameters
Type Name Description
IEnumerable<IGraphChild> group
Implements

Cache()

Declaration
public void Cache()
Implements

CacheWidgetCollections()

Declaration
public void CacheWidgetCollections()
Implements

CacheWidgetModels()

Declaration
public void CacheWidgetModels()

CacheWidgetPositions()

Declaration
public void CacheWidgetPositions()
Implements

CacheWidgetVisibility()

Declaration
public void CacheWidgetVisibility()

CanCollapse(IEnumerable<IGraphElement>)

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

ClearPing()

Declaration
public void ClearPing()
Implements

Close()

Declaration
public virtual void Close()
Implements

CreateCollapseRequest()

Declaration
protected abstract ICollapseRequest CreateCollapseRequest()
Returns
Type Description
ICollapseRequest

DeleteSelection()

Declaration
public void DeleteSelection()
Implements

Dispose()

Declaration
public virtual void Dispose()

Distribute(DistributeOperation)

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

Drag(EventWrapper)

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

DrawBackground()

Declaration
protected virtual void DrawBackground()

DrawDragAndDropPreview()

Declaration
public virtual void DrawDragAndDropPreview()
Implements

DrawOverlay()

Declaration
protected virtual void DrawOverlay()

DrawWidgetsBackground()

Declaration
protected void DrawWidgetsBackground()

DrawWidgetsForeground()

Declaration
protected void DrawWidgetsForeground()

DrawWidgetsOverlay()

Declaration
protected void DrawWidgetsOverlay()

EndDrag(EventWrapper)

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

EndScreenshot()

Declaration
public void EndScreenshot()
Implements

ExitDragAndDrop()

Declaration
public virtual void ExitDragAndDrop()
Implements

ExpandCollapseGroup(HashSet<IGraphElement>)

Declaration
protected virtual void ExpandCollapseGroup(HashSet<IGraphElement> group)
Parameters
Type Name Description
HashSet<IGraphElement> group

FilterCollapseGroup(HashSet<IGraphElement>)

Declaration
protected virtual void FilterCollapseGroup(HashSet<IGraphElement> group)
Parameters
Type Name Description
HashSet<IGraphElement> group

Frame(IEnumerable<IGraphElement>)

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

GetActionToolbarWidth()

Declaration
protected virtual float GetActionToolbarWidth()
Returns
Type Description
Single

GetCollapseHandlers()

Declaration
public virtual IEnumerable<ICollapseHandler> GetCollapseHandlers()
Returns
Type Description
IEnumerable<ICollapseHandler>
Implements

GetContextOptions()

Declaration
protected virtual IEnumerable<DropdownOption> GetContextOptions()
Returns
Type Description
IEnumerable<DropdownOption>

GetDisplayToolbarWidth()

Declaration
protected virtual float GetDisplayToolbarWidth()
Returns
Type Description
Single

GetSelectionCollapseRequest()

Declaration
public virtual ICollapseRequest GetSelectionCollapseRequest()
Returns
Type Description
ICollapseRequest
Implements

GetToolbarWidth()

Declaration
public virtual float GetToolbarWidth()
Returns
Type Description
Single
Implements

HandleCollapsing()

Declaration
protected virtual void HandleCollapsing()

HandleEventCapture()

Declaration
protected void HandleEventCapture()

HandleEventRelease()

Declaration
protected void HandleEventRelease()

HandleHighPriorityInput()

Declaration
protected virtual void HandleHighPriorityInput()

HandleLowPriorityInput()

Declaration
protected virtual void HandleLowPriorityInput()

HandleMaximization()

Declaration
protected virtual void HandleMaximization()

HandleSelectionShortcuts()

Declaration
protected virtual void HandleSelectionShortcuts()

HandleWidgetInput()

Declaration
protected void HandleWidgetInput()

InvalidateWidgetCollections()

Declaration
public void InvalidateWidgetCollections()
Implements

IsVisible(IWidget)

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

NextSearchResult()

Declaration
public void NextSearchResult()
Implements

OnActionToolbarGUI(Boolean, Boolean)

Declaration
protected virtual void OnActionToolbarGUI(bool closeLeft, bool closeRight)
Parameters
Type Name Description
Boolean closeLeft
Boolean closeRight

OnContext()

Declaration
protected virtual void OnContext()

OnDisplayToolbarGUI(Boolean, Boolean)

Declaration
protected virtual void OnDisplayToolbarGUI(bool closeLeft, bool closeRight)
Parameters
Type Name Description
Boolean closeLeft
Boolean closeRight

OnGraphElementsChanged(Object, NotifyCollectionChangedEventArgs)

Declaration
protected virtual void OnGraphElementsChanged(object sender, NotifyCollectionChangedEventArgs args)
Parameters
Type Name Description
Object sender
NotifyCollectionChangedEventArgs args

OnGUI()

Declaration
public void OnGUI()
Implements

OnHoveredWidgetChange()

Declaration
protected virtual void OnHoveredWidgetChange()

OnToolbarGUI()

Declaration
public virtual void OnToolbarGUI()
Implements

Open(ICanvasWindow)

Declaration
public virtual void Open(ICanvasWindow window)
Parameters
Type Name Description
ICanvasWindow window
Implements

OrderWidgetsZ()

Declaration
public void OrderWidgetsZ()
Implements

PerformDragAndDrop()

Declaration
public virtual void PerformDragAndDrop()
Implements

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

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

PingSearchResults()

Declaration
public void PingSearchResults()

PreviousSearchResult()

Declaration
public void PreviousSearchResult()
Implements

ProcessUnclipCallbacks()

Declaration
public void ProcessUnclipCallbacks()
Implements

RegisterControls()

Declaration
public void RegisterControls()
Implements

RegisterSnappingSets(SnappingSystem)

Declaration
protected virtual void RegisterSnappingSets(SnappingSystem snapping)
Parameters
Type Name Description
SnappingSystem snapping

RepositionAll()

Declaration
public void RepositionAll()
Implements

Search(Boolean)

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

SearchResults(SearchQuery)

Declaration
protected virtual IEnumerable<IGraphElement> SearchResults(SearchQuery query)
Parameters
Type Name Description
SearchQuery query
Returns
Type Description
IEnumerable<IGraphElement>

ShowInspector()

Declaration
public void ShowInspector()

ShrinkCopyGroup(HashSet<IGraphElement>)

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

ToggleMaximized()

Declaration
protected void ToggleMaximized()

TweenViewport(Rect, Single)

Declaration
public void TweenViewport(Rect viewport, float duration)
Parameters
Type Name Description
Rect viewport
Single duration

TweenViewport(Vector2, Single, Single)

Declaration
public void TweenViewport(Vector2 pan, float zoom, float duration)
Parameters
Type Name Description
Vector2 pan
Single zoom
Single duration

Update()

Declaration
public void Update()
Implements

UpdateDragAndDrop()

Declaration
public virtual void UpdateDragAndDrop()
Implements

UpdateViewport()

Declaration
public void UpdateViewport()
Implements

WouldDrag(IGraphElement)

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

Events

whenUnclipped

Declaration
public event Action whenUnclipped
Event Type
Type Description
Action
Implements

Explicit Interface Implementations

ICanvas.widgets

Declaration
IEnumerable<IWidget> ICanvas.widgets { get; }
Returns
Type Description
IEnumerable<IWidget>
Implements

Extension Methods