docs.unity3d.com
    Show / Hide Table of Contents

    Class StateWidget<TState>

    Inheritance
    Object
    Widget<StateCanvas, TState>
    GraphElementWidget<StateCanvas, TState>
    NodeWidget<StateCanvas, TState>
    StateWidget<TState>
    AnyStateWidget
    NesterStateWidget<TNesterState>
    Inherited Members
    NodeWidget<StateCanvas, TState>.outerPosition
    NodeWidget<StateCanvas, TState>.edgePosition
    NodeWidget<StateCanvas, TState>.innerPosition
    NodeWidget<StateCanvas, TState>.clippingPosition
    NodeWidget<StateCanvas, TState>.EdgeToOuterPosition(Rect)
    NodeWidget<StateCanvas, TState>.OuterToEdgePosition(Rect)
    NodeWidget<StateCanvas, TState>.EdgeToInnerPosition(Rect)
    NodeWidget<StateCanvas, TState>.InnerToEdgePosition(Rect)
    NodeWidget<StateCanvas, TState>.shape
    NodeWidget<StateCanvas, TState>.color
    NodeWidget<StateCanvas, TState>.invertForeground
    NodeWidget<StateCanvas, TState>.DrawForeground()
    NodeWidget<StateCanvas, TState>.DrawOverlay()
    GraphElementWidget<StateCanvas, TState>.headerPosition
    GraphElementWidget<StateCanvas, TState>.ToString()
    GraphElementWidget<StateCanvas, TState>.Dispose()
    GraphElementWidget<StateCanvas, TState>.element
    GraphElementWidget<StateCanvas, TState>.IGraphElementWidget.element
    GraphElementWidget<StateCanvas, TState>.FetchMetadata()
    GraphElementWidget<StateCanvas, TState>.GetData<T>()
    GraphElementWidget<StateCanvas, TState>.GetDebugData<T>()
    GraphElementWidget<StateCanvas, TState>.BeforeFrame()
    GraphElementWidget<StateCanvas, TState>.HandleCapture()
    GraphElementWidget<StateCanvas, TState>.HandleInput()
    GraphElementWidget<StateCanvas, TState>.canAlignAndDistribute
    GraphElementWidget<StateCanvas, TState>.zIndex
    GraphElementWidget<StateCanvas, TState>.contextOptions
    GraphElementWidget<StateCanvas, TState>.HandleDoubleClick()
    GraphElementWidget<StateCanvas, TState>.OnDoubleClick()
    GraphElementWidget<StateCanvas, TState>.canSelect
    GraphElementWidget<StateCanvas, TState>.isSelected
    GraphElementWidget<StateCanvas, TState>.OnContext()
    GraphElementWidget<StateCanvas, TState>.resizeInnerOffset
    GraphElementWidget<StateCanvas, TState>.resizeOuterOffset
    GraphElementWidget<StateCanvas, TState>.minResizeSize
    GraphElementWidget<StateCanvas, TState>.maxResizeSize
    GraphElementWidget<StateCanvas, TState>.canResizeHorizontal
    GraphElementWidget<StateCanvas, TState>.canResizeVertical
    GraphElementWidget<StateCanvas, TState>.canResize
    GraphElementWidget<StateCanvas, TState>.isResizing
    GraphElementWidget<StateCanvas, TState>.resizeArea
    GraphElementWidget<StateCanvas, TState>.isMouseOverHeaderArea
    GraphElementWidget<StateCanvas, TState>.AddCursorRect(Rect, MouseCursor)
    GraphElementWidget<StateCanvas, TState>.canDrag
    GraphElementWidget<StateCanvas, TState>.isDragging
    GraphElementWidget<StateCanvas, TState>.BeginDrag()
    GraphElementWidget<StateCanvas, TState>.Drag(Vector2, Vector2)
    GraphElementWidget<StateCanvas, TState>.EndDrag()
    GraphElementWidget<StateCanvas, TState>.LockDragOrigin()
    GraphElementWidget<StateCanvas, TState>.ExpandDragGroup(HashSet<IGraphElement>)
    GraphElementWidget<StateCanvas, TState>.canDelete
    GraphElementWidget<StateCanvas, TState>.Delete()
    GraphElementWidget<StateCanvas, TState>.ExpandDeleteGroup(HashSet<IGraphElement>)
    GraphElementWidget<StateCanvas, TState>.canCopy
    GraphElementWidget<StateCanvas, TState>.ExpandCopyGroup(HashSet<IGraphElement>)
    Widget<StateCanvas, TState>.context
    Widget<StateCanvas, TState>.reference
    Widget<StateCanvas, TState>.graph
    Widget<StateCanvas, TState>.canvas
    Widget<StateCanvas, TState>.IWidget.canvas
    Widget<StateCanvas, TState>.selection
    Widget<StateCanvas, TState>.window
    Widget<StateCanvas, TState>.mousePosition
    Widget<StateCanvas, TState>.disposed
    Widget<StateCanvas, TState>.e
    Widget<StateCanvas, TState>.subWidgets
    Widget<StateCanvas, TState>.SubWidgetsChanged()
    Widget<StateCanvas, TState>.item
    Widget<StateCanvas, TState>.IWidget.item
    Widget<StateCanvas, TState>.hasDescriptor
    Widget<StateCanvas, TState>.metadata
    Widget<StateCanvas, TState>.CacheItemFirstTime()
    Widget<StateCanvas, TState>.CacheItem()
    Widget<StateCanvas, TState>.CacheMetadata()
    Widget<StateCanvas, TState>.CacheDescription()
    Widget<StateCanvas, TState>.RegisterControl()
    Widget<StateCanvas, TState>.HandleRelease()
    Widget<StateCanvas, TState>.Update()
    Widget<StateCanvas, TState>.snapToGrid
    Widget<StateCanvas, TState>.isPositionValid
    Widget<StateCanvas, TState>.positionDependers
    Widget<StateCanvas, TState>.positionDependencies
    Widget<StateCanvas, TState>.position
    Widget<StateCanvas, TState>.Reposition()
    Widget<StateCanvas, TState>.CachePositionFirstPass()
    Widget<StateCanvas, TState>.CachePosition()
    Widget<StateCanvas, TState>.BringToFront()
    Widget<StateCanvas, TState>.SendToBack()
    Widget<StateCanvas, TState>.canClip
    Widget<StateCanvas, TState>.OnViewportChange()
    Widget<StateCanvas, TState>.isVisible
    Widget<StateCanvas, TState>.hotArea
    Widget<StateCanvas, TState>.isMouseThrough
    Widget<StateCanvas, TState>.isMouseOver
    Widget<StateCanvas, TState>.HandleContext()
    Widget<StateCanvas, TState>.debug
    Widget<StateCanvas, TState>.foregroundRequiresInput
    Widget<StateCanvas, TState>.backgroundRequiresInput
    Widget<StateCanvas, TState>.overlayRequiresInput
    Widget<StateCanvas, TState>.DrawBackground()
    Widget<StateCanvas, TState>.dim
    Widget<StateCanvas, TState>.BeginDim()
    Widget<StateCanvas, TState>.EndDim()
    Widget<StateCanvas, TState>.UpdateDim()
    Namespace: Unity.VisualScripting
    Syntax
    public abstract class StateWidget<TState> : NodeWidget<StateCanvas, TState>, INodeWidget, IStateWidget, IGraphElementWidget, IWidget, IDisposable where TState : class, IState
    Type Parameters
    Name Description
    TState

    Constructors

    StateWidget(StateCanvas, TState)

    Declaration
    protected StateWidget(StateCanvas canvas, TState state)
    Parameters
    Type Name Description
    StateCanvas canvas
    TState state

    Properties

    analysis

    Declaration
    protected StateAnalysis analysis { get; }
    Property Value
    Type Description
    StateAnalysis

    baseColor

    Declaration
    protected virtual NodeColorMix baseColor { get; }
    Property Value
    Type Description
    NodeColorMix

    canDelete

    Declaration
    public override bool canDelete { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.canDelete
    Implements
    IGraphElementWidget.canDelete

    canDrag

    Declaration
    public override bool canDrag { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.canDrag
    Implements
    IGraphElementWidget.canDrag

    canForceEnter

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

    canForceExit

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

    canResizeHorizontal

    Declaration
    public override bool canResizeHorizontal { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.canResizeHorizontal
    Implements
    IGraphElementWidget.canResizeHorizontal

    canSelect

    Declaration
    public override bool canSelect { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.canSelect
    Implements
    IGraphElementWidget.canSelect

    canToggleStart

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

    color

    Declaration
    protected override NodeColorMix color { get; }
    Property Value
    Type Description
    NodeColorMix
    Overrides
    Unity.VisualScripting.NodeWidget<Unity.VisualScripting.StateCanvas, TState>.color

    contentBackgroundPosition

    Declaration
    public Rect contentBackgroundPosition { get; }
    Property Value
    Type Description
    Rect

    contentInnerPosition

    Declaration
    public Rect contentInnerPosition { get; }
    Property Value
    Type Description
    Rect

    contentOuterPosition

    Declaration
    public Rect contentOuterPosition { get; }
    Property Value
    Type Description
    Rect

    contextOptions

    Declaration
    protected override IEnumerable<DropdownOption> contextOptions { get; }
    Property Value
    Type Description
    IEnumerable<DropdownOption>
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.contextOptions

    description

    Declaration
    protected StateDescription description { get; }
    Property Value
    Type Description
    StateDescription

    dim

    Declaration
    protected override bool dim { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.StateCanvas, TState>.dim

    position

    Declaration
    public override Rect position { get; set; }
    Property Value
    Type Description
    Rect
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.StateCanvas, TState>.position
    Implements
    IWidget.position

    positionDependers

    Declaration
    public override IEnumerable<IWidget> positionDependers { get; }
    Property Value
    Type Description
    IEnumerable<IWidget>
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.StateCanvas, TState>.positionDependers
    Implements
    IWidget.positionDependers

    shape

    Declaration
    protected override NodeShape shape { get; }
    Property Value
    Type Description
    NodeShape
    Overrides
    Unity.VisualScripting.NodeWidget<Unity.VisualScripting.StateCanvas, TState>.shape

    showContent

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

    showSummary

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

    showTitle

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

    snapToGrid

    Declaration
    protected override bool snapToGrid { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.StateCanvas, TState>.snapToGrid

    state

    Declaration
    protected TState state { get; }
    Property Value
    Type Description
    TState

    stateData

    Declaration
    protected State.Data stateData { get; }
    Property Value
    Type Description
    State.Data

    stateDebugData

    Declaration
    protected IStateDebugData stateDebugData { get; }
    Property Value
    Type Description
    IStateDebugData

    summary

    Declaration
    protected virtual string summary { get; set; }
    Property Value
    Type Description
    String

    summaryPosition

    Declaration
    public Rect summaryPosition { get; }
    Property Value
    Type Description
    Rect

    title

    Declaration
    protected virtual string title { get; set; }
    Property Value
    Type Description
    String

    titlePosition

    Declaration
    public Rect titlePosition { get; }
    Property Value
    Type Description
    Rect

    Methods

    BeforeFrame()

    Declaration
    public override void BeforeFrame()
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.BeforeFrame()
    Implements
    IWidget.BeforeFrame()

    CacheDescription()

    Declaration
    protected override void CacheDescription()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.StateCanvas, TState>.CacheDescription()

    CachePosition()

    Declaration
    public override void CachePosition()
    Overrides
    Unity.VisualScripting.Widget<Unity.VisualScripting.StateCanvas, TState>.CachePosition()
    Implements
    IWidget.CachePosition()

    DrawContent()

    Declaration
    protected virtual void DrawContent()

    DrawContentBackground()

    Declaration
    protected virtual void DrawContentBackground()

    DrawForeground()

    Declaration
    public override void DrawForeground()
    Overrides
    Unity.VisualScripting.NodeWidget<Unity.VisualScripting.StateCanvas, TState>.DrawForeground()
    Implements
    IWidget.DrawForeground()

    ExpandCopyGroup(HashSet<IGraphElement>)

    Declaration
    public override void ExpandCopyGroup(HashSet<IGraphElement> copyGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> copyGroup
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.ExpandCopyGroup(System.Collections.Generic.HashSet<Unity.VisualScripting.IGraphElement>)
    Implements
    IGraphElementWidget.ExpandCopyGroup(HashSet<IGraphElement>)

    ExpandDragGroup(HashSet<IGraphElement>)

    Declaration
    public override void ExpandDragGroup(HashSet<IGraphElement> dragGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> dragGroup
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.ExpandDragGroup(System.Collections.Generic.HashSet<Unity.VisualScripting.IGraphElement>)
    Implements
    IGraphElementWidget.ExpandDragGroup(HashSet<IGraphElement>)

    GetContentHeight(Single)

    Declaration
    protected virtual float GetContentHeight(float width)
    Parameters
    Type Name Description
    Single width
    Returns
    Type Description
    Single

    HandleInput()

    Declaration
    public override void HandleInput()
    Overrides
    Unity.VisualScripting.GraphElementWidget<Unity.VisualScripting.StateCanvas, TState>.HandleInput()
    Implements
    IWidget.HandleInput()

    MakeSelfTransition()

    Declaration
    protected void MakeSelfTransition()

    MakeTransition()

    Declaration
    protected void MakeTransition()

    ToggleStart()

    Declaration
    protected void ToggleStart()

    Explicit Interface Implementations

    IStateWidget.state

    Declaration
    IState IStateWidget.state { get; }
    Returns
    Type Description
    IState
    Implements
    IStateWidget.state

    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)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023