Class VisualScriptingCanvas<TGraph>

Inheritance
Object
VisualScriptingCanvas<TGraph>
FlowCanvas
StateCanvas
Namespace: Unity.VisualScripting
Syntax
public abstract class VisualScriptingCanvas<TGraph> : ICanvas, IDisposable, IDragAndDropHandler where TGraph : class, IGraph
Type Parameters
Name Description
TGraph

Constructors

VisualScriptingCanvas(TGraph)

Declaration
protected VisualScriptingCanvas(TGraph graph)
Parameters
Type Name Description
TGraph graph

Properties

alignableAndDistributable

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

context

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

delayedCalls

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

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

graph

Declaration
public TGraph graph { get; }
Property Value
Type Description
TGraph

groupArea

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

hoveredWidget

Declaration
public IWidget hoveredWidget { get; }
Property Value
Type Description
IWidget
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

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

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; }
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
public GraphSelection selection { get; }
Property Value
Type Description
GraphSelection
Implements

selectionArea

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

shouldEdgePan

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

viewport

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

widgetProvider

Declaration
public WidgetProvider widgetProvider { get; }
Property Value
Type Description
WidgetProvider
Implements

window

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

zoom

Declaration
public float zoom { get; }
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

Cache()

Declaration
public void Cache()
Implements

CacheWidgetCollections()

Declaration
public void CacheWidgetCollections()
Implements

CacheWidgetItems()

Declaration
public void CacheWidgetItems()

CacheWidgetPositions()

Declaration
public void CacheWidgetPositions()
Implements

CacheWidgetVisibility()

Declaration
public void CacheWidgetVisibility()

Close()

Declaration
public virtual void Close()
Implements

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

ExitDragAndDrop()

Declaration
public virtual void ExitDragAndDrop()
Implements

GetContextOptions()

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

GetExtendedContextOptions()

Declaration
protected IEnumerable<DropdownOption> GetExtendedContextOptions()
Returns
Type Description
IEnumerable<DropdownOption>

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()

HandleWidgetInput()

Declaration
protected void HandleWidgetInput()

IsVisible(IWidget)

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

OnContext()

Declaration
protected virtual void OnContext()

OnGUI()

Declaration
public void OnGUI()
Implements

OnToolbarGUI()

Declaration
public virtual void OnToolbarGUI()
Implements

Open()

Declaration
public virtual void Open()
Implements

PerformDragAndDrop()

Declaration
public virtual void PerformDragAndDrop()
Implements

Recollect()

Declaration
public void Recollect()
Implements

RegisterControls()

Declaration
public void RegisterControls()
Implements

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(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

ViewElements(IEnumerable<IGraphElement>)

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

Events

delayCall

Declaration
public event Action delayCall
Event Type
Type Description
Action
Implements

Explicit Interface Implementations

ICanvas.graph

Declaration
IGraph ICanvas.graph { get; }
Returns
Type Description
IGraph
Implements

ICanvas.widgets

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

Extension Methods