Class VisualScriptingCanvas<TGraph>
Inheritance
VisualScriptingCanvas<TGraph>
Assembly: Unity.VisualScripting.Core.Editor.dll
Syntax
public abstract class VisualScriptingCanvas<TGraph> : ICanvas, IDisposable, IDragAndDropHandler where TGraph : class, IGraph
Type Parameters
Constructors
VisualScriptingCanvas(TGraph)
Declaration
protected VisualScriptingCanvas(TGraph graph)
Parameters
| Type |
Name |
Description |
| TGraph |
graph |
|
Properties
alignableAndDistributable
Declaration
public IEnumerable<IGraphElementWidget> alignableAndDistributable { get; }
Property Value
context
Declaration
protected IGraphContext context { get; }
Property Value
delayedCalls
Declaration
public Queue<Action> delayedCalls { get; }
Property Value
dragAndDropVisualMode
Declaration
public virtual DragAndDropVisualMode dragAndDropVisualMode { get; }
Property Value
e
Declaration
protected EventWrapper e { get; }
Property Value
eventDeltaTime
Declaration
[DoNotSerialize]
public float eventDeltaTime { get; }
Property Value
frameDeltaTime
Declaration
[DoNotSerialize]
public float frameDeltaTime { get; }
Property Value
graph
Declaration
public TGraph graph { get; }
Property Value
groupArea
Declaration
public Rect groupArea { get; }
Property Value
Declaration
public IWidget hoveredWidget { get; }
Property Value
isDragging
Declaration
public bool isDragging { get; }
Property Value
isGrouping
Declaration
public bool isGrouping { get; }
Property Value
isLassoing
Declaration
public bool isLassoing { get; }
Property Value
isMouseOver
Declaration
public bool isMouseOver { get; }
Property Value
isMouseOverBackground
Declaration
public bool isMouseOverBackground { get; }
Property Value
isSelecting
Declaration
public bool isSelecting { get; }
Property Value
lassoArea
Declaration
public Rect lassoArea { get; }
Property Value
mousePosition
Declaration
public Vector2 mousePosition { get; }
Property Value
pan
Declaration
public Vector2 pan { get; }
Property Value
reference
Declaration
protected GraphReference reference { get; }
Property Value
repaintDeltaTime
Declaration
[DoNotSerialize]
public float repaintDeltaTime { get; }
Property Value
selection
Declaration
public GraphSelection selection { get; }
Property Value
selectionArea
Declaration
public Rect selectionArea { get; }
Property Value
shouldEdgePan
Declaration
protected virtual bool shouldEdgePan { get; }
Property Value
viewport
Declaration
public Rect viewport { get; set; }
Property Value
Declaration
public WidgetProvider widgetProvider { get; }
Property Value
window
Declaration
public ICanvasWindow window { get; set; }
Property Value
zoom
Declaration
public float zoom { get; }
Property Value
Methods
AcceptsDragAndDrop()
Declaration
public virtual bool AcceptsDragAndDrop()
Returns
Align(AlignOperation)
Declaration
public void Align(AlignOperation operation)
Parameters
BeforeFrame()
Declaration
public void BeforeFrame()
BeginDrag(EventWrapper)
Declaration
public void BeginDrag(EventWrapper e)
Parameters
Cache()
Declaration
Declaration
public void CacheWidgetCollections()
Declaration
public void CacheWidgetItems()
Declaration
public void CacheWidgetPositions()
Declaration
public void CacheWidgetVisibility()
Close()
Declaration
public virtual void Close()
DeleteSelection()
Declaration
public void DeleteSelection()
Dispose()
Declaration
public virtual void Dispose()
Distribute(DistributeOperation)
Declaration
public void Distribute(DistributeOperation operation)
Parameters
Drag(EventWrapper)
Declaration
public void Drag(EventWrapper e)
Parameters
DrawBackground()
Declaration
protected virtual void DrawBackground()
DrawDragAndDropPreview()
Declaration
public virtual void DrawDragAndDropPreview()
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
ExitDragAndDrop()
Declaration
public virtual void ExitDragAndDrop()
GetContextOptions()
Declaration
protected virtual IEnumerable<DropdownOption> GetContextOptions()
Returns
GetExtendedContextOptions()
Declaration
protected IEnumerable<DropdownOption> GetExtendedContextOptions()
Returns
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()
Declaration
protected void HandleWidgetInput()
Declaration
public bool IsVisible(IWidget widget)
Parameters
| Type |
Name |
Description |
| IWidget |
widget |
|
Returns
OnContext()
Declaration
protected virtual void OnContext()
OnGUI()
Declaration
Declaration
public virtual void OnToolbarGUI()
Open()
Declaration
public virtual void Open()
Declaration
public virtual void PerformDragAndDrop()
Recollect()
Declaration
RegisterControls()
Declaration
public void RegisterControls()
ShrinkCopyGroup(HashSet<IGraphElement>)
Declaration
public virtual void ShrinkCopyGroup(HashSet<IGraphElement> copyGroup)
Parameters
ToggleMaximized()
Declaration
protected void ToggleMaximized()
TweenViewport(Vector2, float, float)
Declaration
public void TweenViewport(Vector2 pan, float zoom, float duration)
Parameters
Update()
Declaration
UpdateDragAndDrop()
Declaration
public virtual void UpdateDragAndDrop()
UpdateViewport()
Declaration
public void UpdateViewport()
ViewElements(IEnumerable<IGraphElement>)
Declaration
public void ViewElements(IEnumerable<IGraphElement> elements)
Parameters
Events
delayCall
Declaration
public event Action delayCall
Event Type
Implements
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.