Class Canvas
Syntax
public abstract class Canvas : ICanvas, IDisposable, IDragAndDropHandler
Constructors
Canvas(IGraphContext)
Declaration
protected Canvas(IGraphContext context)
Parameters
Fields
Declaration
protected readonly WidgetList<IGraphElementWidget> elementWidgets
Field Value
Declaration
protected readonly WidgetList<IWidget> visibleWidgetsByAscendingZ
Field Value
Declaration
protected readonly WidgetList<IWidget> visibleWidgetsByDescendingZ
Field Value
Declaration
protected readonly WidgetList<IWidget> widgets
Field Value
Declaration
protected readonly WidgetList<IWidget> widgetsByAscendingZ
Field Value
Properties
alignableAndDistributable
Declaration
public IEnumerable<IGraphElementWidget> alignableAndDistributable { get; }
Property Value
context
Declaration
public IGraphContext context { get; }
Property Value
Implements
currentSearchResult
Declaration
public IGraphElement currentSearchResult { get; }
Property Value
dragAndDropVisualMode
Declaration
public virtual DragAndDropVisualMode dragAndDropVisualMode { get; }
Property Value
Type |
Description |
DragAndDropVisualMode |
|
Implements
e
Declaration
protected EventWrapper e { get; }
Property Value
eventDeltaTime
Declaration
[DoNotSerialize]
public float eventDeltaTime { get; }
Property Value
Implements
frameDeltaTime
Declaration
[DoNotSerialize]
public float frameDeltaTime { get; }
Property Value
Implements
fullViewport
Declaration
public virtual Rect fullViewport { get; }
Property Value
Implements
graph
Declaration
protected IGraph graph { get; }
Property Value
groupArea
Declaration
public Rect groupArea { get; }
Property Value
Implements
hasSearchResults
Declaration
public bool hasSearchResults { get; }
Property Value
Implements
Declaration
public IWidget hoveredWidget { get; }
Property Value
Implements
isConnecting
Declaration
public virtual bool isConnecting { get; }
Property Value
Implements
isDragging
Declaration
public bool isDragging { get; }
Property Value
Implements
isGrouping
Declaration
public bool isGrouping { get; }
Property Value
Implements
isInspectable
Declaration
protected virtual bool isInspectable { get; }
Property Value
isLassoing
Declaration
public bool isLassoing { get; }
Property Value
Implements
isMouseOver
Declaration
public bool isMouseOver { get; }
Property Value
Implements
isMouseOverBackground
Declaration
public bool isMouseOverBackground { get; }
Property Value
Implements
isScreenshotting
Declaration
public bool isScreenshotting { get; }
Property Value
Implements
isSelecting
Declaration
public bool isSelecting { get; }
Property Value
Implements
lassoArea
Declaration
public Rect lassoArea { get; }
Property Value
Implements
mousePosition
Declaration
public Vector2 mousePosition { get; }
Property Value
Implements
pan
Declaration
public Vector2 pan { get; set; }
Property Value
Implements
reference
Declaration
protected GraphReference reference { get; }
Property Value
repaintDeltaTime
Declaration
[DoNotSerialize]
public float repaintDeltaTime { get; }
Property Value
Implements
selection
Declaration
protected GraphSelection selection { get; }
Property Value
selectionArea
Declaration
public Rect selectionArea { get; }
Property Value
Implements
shouldEdgePan
Declaration
protected virtual bool shouldEdgePan { get; }
Property Value
unclipCallbacks
Declaration
public Queue<Action> unclipCallbacks { get; }
Property Value
Type |
Description |
Queue<Action> |
|
viewport
Declaration
public Rect viewport { get; set; }
Property Value
Implements
window
Declaration
public ICanvasWindow window { get; set; }
Property Value
Implements
zoom
Declaration
public float zoom { get; set; }
Property Value
Implements
Methods
AcceptsDragAndDrop()
Declaration
public virtual bool AcceptsDragAndDrop()
Returns
Implements
Align(AlignOperation)
Declaration
public void Align(AlignOperation operation)
Parameters
Implements
BeforeFrame()
Declaration
public void BeforeFrame()
Implements
BeginDrag(EventWrapper)
Declaration
public void BeginDrag(EventWrapper e)
Parameters
Implements
BeginScreenshot(IEnumerable<IGraphChild>)
Declaration
public void BeginScreenshot(IEnumerable<IGraphChild> group)
Parameters
Implements
Cache()
Declaration
Implements
Declaration
public void CacheWidgetCollections()
Implements
Declaration
public void CacheWidgetModels()
Declaration
public void CacheWidgetPositions()
Implements
Declaration
public void CacheWidgetVisibility()
CanCollapse(IEnumerable<IGraphElement>)
Declaration
public virtual bool CanCollapse(IEnumerable<IGraphElement> elements)
Parameters
Returns
Implements
ClearPing()
Declaration
Implements
Close()
Declaration
public virtual void Close()
Implements
CreateCollapseRequest()
Declaration
protected abstract ICollapseRequest CreateCollapseRequest()
Returns
DeleteSelection()
Declaration
public void DeleteSelection()
Implements
Dispose()
Declaration
public virtual void Dispose()
Distribute(DistributeOperation)
Declaration
public void Distribute(DistributeOperation operation)
Parameters
Implements
Drag(EventWrapper)
Declaration
public void Drag(EventWrapper e)
Parameters
Implements
DrawBackground()
Declaration
protected virtual void DrawBackground()
DrawDragAndDropPreview()
Declaration
public virtual void DrawDragAndDropPreview()
Implements
DrawOverlay()
Declaration
protected virtual void DrawOverlay()
Declaration
protected void DrawWidgetsBackground()
Declaration
protected void DrawWidgetsForeground()
Declaration
protected void DrawWidgetsOverlay()
EndDrag(EventWrapper)
Declaration
public void EndDrag(EventWrapper e)
Parameters
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
FilterCollapseGroup(HashSet<IGraphElement>)
Declaration
protected virtual void FilterCollapseGroup(HashSet<IGraphElement> group)
Parameters
Frame(IEnumerable<IGraphElement>)
Declaration
public void Frame(IEnumerable<IGraphElement> elements)
Parameters
Implements
Declaration
protected virtual float GetActionToolbarWidth()
Returns
GetCollapseHandlers()
Declaration
public virtual IEnumerable<ICollapseHandler> GetCollapseHandlers()
Returns
Implements
GetContextOptions()
Declaration
protected virtual IEnumerable<DropdownOption> GetContextOptions()
Returns
Declaration
protected virtual float GetDisplayToolbarWidth()
Returns
GetSelectionCollapseRequest()
Declaration
public virtual ICollapseRequest GetSelectionCollapseRequest()
Returns
Implements
Declaration
public virtual float GetToolbarWidth()
Returns
Implements
HandleCollapsing()
Declaration
protected virtual void HandleCollapsing()
HandleEventCapture()
Declaration
protected void HandleEventCapture()
HandleEventRelease()
Declaration
protected void HandleEventRelease()
Declaration
protected virtual void HandleHighPriorityInput()
Declaration
protected virtual void HandleLowPriorityInput()
HandleMaximization()
Declaration
protected virtual void HandleMaximization()
HandleSelectionShortcuts()
Declaration
protected virtual void HandleSelectionShortcuts()
Declaration
protected void HandleWidgetInput()
Declaration
public void InvalidateWidgetCollections()
Implements
Declaration
public bool IsVisible(IWidget widget)
Parameters
Type |
Name |
Description |
IWidget |
widget |
|
Returns
Implements
NextSearchResult()
Declaration
public void NextSearchResult()
Implements
Declaration
protected virtual void OnActionToolbarGUI(bool closeLeft, bool closeRight)
Parameters
OnContext()
Declaration
protected virtual void OnContext()
Declaration
protected virtual void OnDisplayToolbarGUI(bool closeLeft, bool closeRight)
Parameters
OnGraphElementsChanged(Object, NotifyCollectionChangedEventArgs)
Declaration
protected virtual void OnGraphElementsChanged(object sender, NotifyCollectionChangedEventArgs args)
Parameters
Type |
Name |
Description |
Object |
sender |
|
NotifyCollectionChangedEventArgs |
args |
|
OnGUI()
Declaration
Implements
Declaration
protected virtual void OnHoveredWidgetChange()
Declaration
public virtual void OnToolbarGUI()
Implements
Open(ICanvasWindow)
Declaration
public virtual void Open(ICanvasWindow window)
Parameters
Implements
Declaration
public void OrderWidgetsZ()
Implements
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
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
RepositionAll()
Declaration
public void RepositionAll()
Implements
Search(Boolean)
Declaration
public void Search(bool ping)
Parameters
Implements
SearchResults(SearchQuery)
Declaration
protected virtual IEnumerable<IGraphElement> SearchResults(SearchQuery query)
Parameters
Returns
ShowInspector()
Declaration
public void ShowInspector()
ShrinkCopyGroup(HashSet<IGraphElement>)
Declaration
public virtual void ShrinkCopyGroup(HashSet<IGraphElement> copyGroup)
Parameters
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
Implements
UpdateDragAndDrop()
Declaration
public virtual void UpdateDragAndDrop()
Implements
UpdateViewport()
Declaration
public void UpdateViewport()
Implements
WouldDrag(IGraphElement)
Declaration
public bool WouldDrag(IGraphElement element)
Parameters
Returns
Implements
Events
whenUnclipped
Declaration
public event Action whenUnclipped
Event Type
Implements
Explicit Interface Implementations
Declaration
IEnumerable<IWidget> ICanvas.widgets { get; }
Returns
Implements
Extension Methods