Class Widget<TCanvas, TItem>

Inheritance

Object

Widget<TCanvas, TItem>

GraphElementWidget<TCanvas, TElement>

UnitPortWidget<TPort>

Namespace: Unity.VisualScripting

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
Boolean

Properties

backgroundRequiresInput

Declaration

public virtual bool backgroundRequiresInput { get; }

Property Value

Type	Description
Boolean

Implements

IWidget.backgroundRequiresInput

canClip

Declaration

public virtual bool canClip { get; }

Property Value

Type	Description
Boolean

Implements

IWidget.canClip

canvas

Declaration

protected TCanvas canvas { get; }

Property Value

Type	Description
TCanvas

clippingPosition

Declaration

public virtual Rect clippingPosition { get; }

Property Value

Type	Description
Rect

Implements

IWidget.clippingPosition

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
Boolean

disposed

Declaration

public bool disposed { get; }

Property Value

Type	Description
Boolean

e

Declaration

protected EventWrapper e { get; }

Property Value

Type	Description
EventWrapper

foregroundRequiresInput

Declaration

public virtual bool foregroundRequiresInput { get; }

Property Value

Type	Description
Boolean

Implements

IWidget.foregroundRequiresInput

graph

Declaration

protected IGraph graph { get; }

Property Value

Type	Description
IGraph

hotArea

Declaration

public virtual Rect hotArea { get; }

Property Value

Type	Description
Rect

Implements

IWidget.hotArea

isMouseOver

Declaration

public bool isMouseOver { get; }

Property Value

Type	Description
Boolean

Implements

IWidget.isMouseOver

isMouseThrough

Declaration

public bool isMouseThrough { get; }

Property Value

Type	Description
Boolean

Implements

IWidget.isMouseThrough

isPositionValid

Declaration

public bool isPositionValid { get; set; }

Property Value

Type	Description
Boolean

Implements

IWidget.isPositionValid

isVisible

Declaration

public bool isVisible { get; set; }

Property Value

Type	Description
Boolean

Implements

IWidget.isVisible

item

Declaration

protected TItem item { get; }

Property Value

Type	Description
TItem

metadata

Declaration

public Metadata metadata { get; }

Property Value

Type	Description
Metadata

Implements

IWidget.metadata

mousePosition

Declaration

protected Vector2 mousePosition { get; }

Property Value

Type	Description
Vector2

overlayRequiresInput

Declaration

public virtual bool overlayRequiresInput { get; }

Property Value

Type	Description
Boolean

Implements

IWidget.overlayRequiresInput

position

Declaration

public abstract Rect position { get; set; }

Property Value

Type	Description
Rect

Implements

IWidget.position

positionDependencies

Declaration

public virtual IEnumerable<IWidget> positionDependencies { get; }

Property Value

Type	Description
IEnumerable<IWidget>

Implements

IWidget.positionDependencies

positionDependers

Declaration

public virtual IEnumerable<IWidget> positionDependers { get; }

Property Value

Type	Description
IEnumerable<IWidget>

Implements

IWidget.positionDependers

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
Boolean

subWidgets

Declaration

public virtual IEnumerable<IWidget> subWidgets { get; }

Property Value

Type	Description
IEnumerable<IWidget>

Implements

IWidget.subWidgets

window

Declaration

protected ICanvasWindow window { get; }

Property Value

Type	Description
ICanvasWindow

zIndex

Declaration

public abstract float zIndex { get; set; }

Property Value

Type	Description
Single

Implements

IWidget.zIndex

Methods

BeforeFrame()

Declaration

public virtual void BeforeFrame()

Implements

IWidget.BeforeFrame()

BeginDim()

Declaration

protected void BeginDim()

BringToFront()

Declaration

public void BringToFront()

Implements

IWidget.BringToFront()

CacheDescription()

Declaration

protected virtual void CacheDescription()

CacheItem()

Declaration

public virtual void CacheItem()

Implements

IWidget.CacheItem()

CacheItemFirstTime()

Declaration

protected virtual void CacheItemFirstTime()

CacheMetadata()

Declaration

protected virtual void CacheMetadata()

CachePosition()

Declaration

public virtual void CachePosition()

Implements

IWidget.CachePosition()

CachePositionFirstPass()

Declaration

public virtual void CachePositionFirstPass()

Implements

IWidget.CachePositionFirstPass()

Dispose()

Declaration

public virtual void Dispose()

DrawBackground()

Declaration

public virtual void DrawBackground()

Implements

IWidget.DrawBackground()

DrawForeground()

Declaration

public virtual void DrawForeground()

Implements

IWidget.DrawForeground()

DrawOverlay()

Declaration

public virtual void DrawOverlay()

Implements

IWidget.DrawOverlay()

EndDim()

Declaration

protected void EndDim()

FetchMetadata()

Declaration

public virtual Metadata FetchMetadata()

Returns

Type	Description
Metadata

HandleCapture()

Declaration

public virtual void HandleCapture()

Implements

IWidget.HandleCapture()

HandleContext()

Declaration

protected void HandleContext()

HandleInput()

Declaration

public virtual void HandleInput()

Implements

IWidget.HandleInput()

HandleRelease()

Declaration

public virtual void HandleRelease()

Implements

IWidget.HandleRelease()

OnContext()

Declaration

protected virtual void OnContext()

OnViewportChange()

Declaration

public virtual void OnViewportChange()

Implements

IWidget.OnViewportChange()

RegisterControl()

Declaration

public void RegisterControl()

Implements

IWidget.RegisterControl()

Reposition()

Declaration

public void Reposition()

Implements

IWidget.Reposition()

SendToBack()

Declaration

public void SendToBack()

Implements

IWidget.SendToBack()

SubWidgetsChanged()

Declaration

protected void SubWidgetsChanged()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Update()

Declaration

public virtual void Update()

Implements

IWidget.Update()

UpdateDim()

Declaration

protected void UpdateDim()

Explicit Interface Implementations

IWidget.canvas

Declaration

ICanvas IWidget.canvas { get; }

Returns

Type	Description
ICanvas

Implements

IWidget.canvas

IWidget.item

Declaration

IGraphItem IWidget.item { get; }

Returns

Type	Description
IGraphItem

Implements

IWidget.item

Extension Methods

XAnalyserProvider.Analyser(Object, IGraphContext)

XAnalyserProvider.Analyser<TAnalyser>(Object, IGraphContext)

XAnalyserProvider.Analysis(Object, IGraphContext)

XAnalyserProvider.Analysis<TAnalysis>(Object, IGraphContext)

XAnalyserProvider.Analyser(Object, GraphReference)

XAnalyserProvider.Analyser<TAnalyser>(Object, GraphReference)

XAnalyserProvider.Analysis(Object, GraphReference)

XAnalyserProvider.Analysis<TAnalysis>(Object, GraphReference)

XDescriptorProvider.Describe(Object)

XDescriptorProvider.HasDescriptor(Object)

XDescriptorProvider.Descriptor(Object)

XDescriptorProvider.Descriptor<TDescriptor>(Object)

XDescriptorProvider.Description(Object)

XDescriptorProvider.Description<TDescription>(Object)

Cloning.Clone(Object, ICloner, Boolean)

Cloning.Clone<T>(T, ICloner, Boolean)

Cloning.CloneViaFakeSerialization(Object)

Cloning.CloneViaFakeSerialization<T>(T)

ConversionUtility.IsConvertibleTo(Object, Type, Boolean)

ConversionUtility.IsConvertibleTo<T>(Object, Boolean)

ConversionUtility.ConvertTo(Object, Type)

ConversionUtility.ConvertTo<T>(Object)

TypeUtility.ToShortString(Object, Int32)

Serialization.CloneViaSerialization<T>(T, Boolean)

Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, Boolean)

Serialization.Serialize(Object, Boolean)

LinqUtility.Yield<T>(T)

UnityObjectUtility.IsUnityNull(Object)

UnityObjectUtility.ToSafeString(Object)