Class Widget | Bolt Visual Scripting | 1.4.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class Widget

    Inheritance
    Object
    Widget
    GraphElementWidget
    UnitPortWidget<TPort>
    Namespace: Ludiq.Bolt
    Syntax
    public abstract class Widget : IWidget, IDisposable

    Constructors

    Widget(IGraphContext, IGraphChild)

    Declaration
    protected Widget(IGraphContext context, IGraphChild model)
    Parameters
    Type Name Description
    IGraphContext context
    IGraphChild model

    Fields

    descriptor

    Declaration
    protected readonly IDescriptor descriptor
    Field Value
    Type Description
    IDescriptor

    Properties

    accessor

    Declaration
    public Accessor accessor { get; }
    Property Value
    Type Description
    Accessor
    Implements
    IWidget.accessor

    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 ICanvas canvas { get; }
    Property Value
    Type Description
    ICanvas

    clippingPosition

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

    context

    Declaration
    public IGraphContext context { get; }
    Property Value
    Type Description
    IGraphContext
    Implements
    IWidget.context

    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

    dimAlphaTarget

    Declaration
    protected virtual float dimAlphaTarget { get; }
    Property Value
    Type Description
    Single

    disposed

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

    e

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

    editor

    Declaration
    public Editor editor { get; }
    Property Value
    Type Description
    Editor

    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
    protected virtual Rect hotArea { get; }
    Property Value
    Type Description
    Rect

    isDimmed

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

    isFullyDimmed

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

    isMouseOver

    Declaration
    public virtual bool isMouseOver { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IWidget.isMouseOver

    isMouseThrough

    Declaration
    public virtual 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

    model

    Declaration
    public IGraphChild model { get; }
    Property Value
    Type Description
    IGraphChild
    Implements
    IWidget.model

    mousePosition

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

    onGuiCallbacks

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

    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

    updateCallbacks

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

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

    CacheEditor()

    Declaration
    protected virtual void CacheEditor()

    CacheModel()

    Declaration
    public virtual void CacheModel()
    Implements
    IWidget.CacheModel()

    CacheModelFirstTime()

    Declaration
    protected virtual void CacheModelFirstTime()

    CachePosition()

    Declaration
    public virtual void CachePosition()
    Implements
    IWidget.CachePosition()

    CachePositionFirstPass()

    Declaration
    public virtual void CachePositionFirstPass()
    Implements
    IWidget.CachePositionFirstPass()

    CompareZ(IWidget)

    Declaration
    public virtual int CompareZ(IWidget other)
    Parameters
    Type Name Description
    IWidget other
    Returns
    Type Description
    Int32
    Implements
    IWidget.CompareZ(IWidget)

    ConfigureEditor(Editor)

    Declaration
    protected virtual void ConfigureEditor(Editor editor)
    Parameters
    Type Name Description
    Editor editor

    Contains(Vector2)

    Declaration
    public virtual bool Contains(Vector2 point)
    Parameters
    Type Name Description
    Vector2 point
    Returns
    Type Description
    Boolean
    Implements
    IWidget.Contains(Vector2)

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

    ExpandScreenshotGroup(HashSet<IWidget>)

    Declaration
    public virtual void ExpandScreenshotGroup(HashSet<IWidget> group)
    Parameters
    Type Name Description
    HashSet<IWidget> group
    Implements
    IWidget.ExpandScreenshotGroup(HashSet<IWidget>)

    FetchAccessor()

    Declaration
    public virtual Accessor FetchAccessor()
    Returns
    Type Description
    Accessor

    GetDescriptor()

    Declaration
    protected virtual IDescriptor GetDescriptor()
    Returns
    Type Description
    IDescriptor

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

    OnGraphElementsChanged()

    Declaration
    public virtual void OnGraphElementsChanged()
    Implements
    IWidget.OnGraphElementsChanged()

    OnViewportChange()

    Declaration
    public virtual void OnViewportChange()
    Implements
    IWidget.OnViewportChange()

    Overlaps(Rect)

    Declaration
    public virtual bool Overlaps(Rect area)
    Parameters
    Type Name Description
    Rect area
    Returns
    Type Description
    Boolean
    Implements
    IWidget.Overlaps(Rect)

    RegisterControl()

    Declaration
    public void RegisterControl()
    Implements
    IWidget.RegisterControl()

    Reposition()

    Declaration
    public void Reposition()
    Implements
    IWidget.Reposition()

    SendToBack()

    Declaration
    public void SendToBack()
    Implements
    IWidget.SendToBack()

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

    Events

    whenOnGUI

    Declaration
    public event Action whenOnGUI
    Event Type
    Type Description
    Action
    Implements
    IWidget.whenOnGUI

    whenUpdating

    Declaration
    public event Action whenUpdating
    Event Type
    Type Description
    Action
    Implements
    IWidget.whenUpdating

    Extension Methods

    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    LiteralUtility.ToLiteralString(Object)
    LiteralUtility.ToLiteralStringOrDefault(Object)
    LiteralUtility.TryToLiteralString(Object, out String)
    XFilterProvider.Filter(Object)
    XFilterProvider.Filter<TFilter>(Object)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone(Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy(Object)
    Cloning.CloneViaSerializationPolicy(Object, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy<T>(T)
    Cloning.CloneViaSerializationPolicy<T>(T, out Dictionary<Object, Object>)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneValueType(Object)
    ConversionUtility.ConvertTo<TSource>(TSource, Type)
    ConversionUtility.IsLateConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsLateConvertibleTo<T>(Object, Boolean)
    ConversionUtility.LateConvertTo(Object, Type)
    ConversionUtility.LateConvertTo<T>(Object)
    ConversionUtility.TryLateConvertTo(Object, Type, out Object, Boolean)
    ConversionUtility.TryLateConvertTo<T>(Object, out T, Boolean)
    TypeUtility.ToShortString(Object, Int32)
    TypeUtility.CastTo<T>(Object)
    Serialization.FullSerialize(Object, Boolean)
    Serialization.OdinSerialize<T>(T, DataFormat)
    Serialization.OdinSerialize<T>(T, ref OdinSerializer.SerializationData, DataFormat)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.UnityNullCoalesce(Object, Object)
    UnityObjectUtility.ToSafeString(Object)
    BoltGenerationUtility.GenerateLiteral(Object, IGeneration)
    XGeneratorProvider.Generator(Object, IGeneration)
    XGeneratorProvider.Generator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.HasGenerator(Object, IGeneration)
    XGeneratorProvider.HasGenerator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.TryGetGenerator(Object, out IGenerator, IGeneration)
    XGeneratorProvider.TryGetGenerator<TGenerator>(Object, IGeneration, out TGenerator)
    XWidget.ImmediatelyCachePosition(IWidget)
    HybridConversionUtility.ConvertTo(Object, HybridType, HybridType)
    HybridConversionUtility.IsLateConvertibleTo(Object, HybridType, Boolean)
    HybridConversionUtility.LateConvertTo(Object, HybridType)
    HybridConversionUtility.TryLateConvertTo(Object, HybridType, out Object, Boolean)
    HybridTypeUtility.GetHybridType(Object)
    IsUtility.Is<TO, TC>(TO, out TC)
    PrivateReflectionUsingDynamicExtensions.AsDynamic(Object)
    JsonWriter.ToJson(Object)
    Back to top Copyright © 2020 Unity Technologies
    Generated by DocFX