Class Widget<TCanvas, TItem>

Inheritance
object
Widget<TCanvas, TItem>
GraphElementWidget<TCanvas, TElement>
UnitPortWidget<TPort>
Implements
Inherited Members
Namespace: Unity.VisualScripting
Assembly: Unity.VisualScripting.Core.Editor.dll
Syntax
public abstract class Widget<TCanvas, TItem> : IWidget, IDisposable where TCanvas : class, ICanvas where TItem : class, IGraphItem
Type Parameters
Name Description
TCanvas
TItem

Constructors

Widget(TCanvas, TItem)

Declaration
protected Widget(TCanvas canvas, TItem item)
Parameters
Type Name Description
TCanvas canvas
TItem item

Fields

hasDescriptor

Declaration
protected readonly bool hasDescriptor
Field Value
Type Description
bool

Properties

backgroundRequiresInput

Declaration
public virtual bool backgroundRequiresInput { get; }
Property Value
Type Description
bool

canClip

Declaration
public virtual bool canClip { get; }
Property Value
Type Description
bool

canvas

Declaration
protected TCanvas canvas { get; }
Property Value
Type Description
TCanvas

clippingPosition

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

context

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

contextOptions

Declaration
protected virtual IEnumerable<DropdownOption> contextOptions { get; }
Property Value
Type Description
IEnumerable<DropdownOption>

debug

Declaration
protected string debug { get; set; }
Property Value
Type Description
string

dim

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

disposed

Declaration
public bool disposed { get; }
Property Value
Type Description
bool

e

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

foregroundRequiresInput

Declaration
public virtual bool foregroundRequiresInput { get; }
Property Value
Type Description
bool

graph

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

hotArea

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

isMouseOver

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

isMouseThrough

Declaration
public bool isMouseThrough { get; }
Property Value
Type Description
bool

isPositionValid

Declaration
public bool isPositionValid { get; set; }
Property Value
Type Description
bool

isVisible

Declaration
public bool isVisible { get; set; }
Property Value
Type Description
bool

item

Declaration
protected TItem item { get; }
Property Value
Type Description
TItem

metadata

Declaration
public Metadata metadata { get; }
Property Value
Type Description
Metadata

mousePosition

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

overlayRequiresInput

Declaration
public virtual bool overlayRequiresInput { get; }
Property Value
Type Description
bool

position

Declaration
public abstract Rect position { get; set; }
Property Value
Type Description
Rect

positionDependencies

Declaration
public virtual IEnumerable<IWidget> positionDependencies { get; }
Property Value
Type Description
IEnumerable<IWidget>

positionDependers

Declaration
public virtual IEnumerable<IWidget> positionDependers { get; }
Property Value
Type Description
IEnumerable<IWidget>

reference

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

selection

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

snapToGrid

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

subWidgets

Declaration
public virtual IEnumerable<IWidget> subWidgets { get; }
Property Value
Type Description
IEnumerable<IWidget>

window

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

zIndex

Declaration
public abstract float zIndex { get; set; }
Property Value
Type Description
float

Methods

BeforeFrame()

Declaration
public virtual void BeforeFrame()

BeginDim()

Declaration
protected void BeginDim()

BringToFront()

Declaration
public void BringToFront()

CacheDescription()

Declaration
protected virtual void CacheDescription()

CacheItem()

Declaration
public virtual void CacheItem()

CacheItemFirstTime()

Declaration
protected virtual void CacheItemFirstTime()

CacheMetadata()

Declaration
protected virtual void CacheMetadata()

CachePosition()

Declaration
public virtual void CachePosition()

CachePositionFirstPass()

Declaration
public virtual void CachePositionFirstPass()

Dispose()

Declaration
public virtual void Dispose()

DrawBackground()

Declaration
public virtual void DrawBackground()

DrawForeground()

Declaration
public virtual void DrawForeground()

DrawOverlay()

Declaration
public virtual void DrawOverlay()

EndDim()

Declaration
protected void EndDim()

FetchMetadata()

Declaration
public virtual Metadata FetchMetadata()
Returns
Type Description
Metadata

HandleCapture()

Declaration
public virtual void HandleCapture()

HandleContext()

Declaration
protected void HandleContext()

HandleInput()

Declaration
public virtual void HandleInput()

HandleRelease()

Declaration
public virtual void HandleRelease()

OnContext()

Declaration
protected virtual void OnContext()

OnViewportChange()

Declaration
public virtual void OnViewportChange()

RegisterControl()

Declaration
public void RegisterControl()

Reposition()

Declaration
public void Reposition()

SendToBack()

Declaration
public void SendToBack()

SubWidgetsChanged()

Declaration
protected void SubWidgetsChanged()

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Update()

Declaration
public virtual void Update()

UpdateDim()

Declaration
protected void UpdateDim()

Implements

Extension Methods