docs.unity3d.com
    Show / Hide Table of Contents

    Class StateCanvas

    Inheritance
    Object
    VisualScriptingCanvas<StateGraph>
    StateCanvas
    Inherited Members
    VisualScriptingCanvas<StateGraph>.widgetProvider
    VisualScriptingCanvas<StateGraph>.selection
    VisualScriptingCanvas<StateGraph>.window
    VisualScriptingCanvas<StateGraph>.e
    VisualScriptingCanvas<StateGraph>.graph
    VisualScriptingCanvas<StateGraph>.ICanvas.graph
    VisualScriptingCanvas<StateGraph>.Dispose()
    VisualScriptingCanvas<StateGraph>.context
    VisualScriptingCanvas<StateGraph>.reference
    VisualScriptingCanvas<StateGraph>.Cache()
    VisualScriptingCanvas<StateGraph>.CacheWidgetItems()
    VisualScriptingCanvas<StateGraph>.ICanvas.widgets
    VisualScriptingCanvas<StateGraph>.Recollect()
    VisualScriptingCanvas<StateGraph>.CacheWidgetCollections()
    VisualScriptingCanvas<StateGraph>.Open()
    VisualScriptingCanvas<StateGraph>.RegisterControls()
    VisualScriptingCanvas<StateGraph>.Update()
    VisualScriptingCanvas<StateGraph>.BeforeFrame()
    VisualScriptingCanvas<StateGraph>.OnGUI()
    VisualScriptingCanvas<StateGraph>.HandleEventCapture()
    VisualScriptingCanvas<StateGraph>.HandleWidgetInput()
    VisualScriptingCanvas<StateGraph>.HandleEventRelease()
    VisualScriptingCanvas<StateGraph>.HandleLowPriorityInput()
    VisualScriptingCanvas<StateGraph>.HandleMaximization()
    VisualScriptingCanvas<StateGraph>.ToggleMaximized()
    VisualScriptingCanvas<StateGraph>.zoom
    VisualScriptingCanvas<StateGraph>.pan
    VisualScriptingCanvas<StateGraph>.viewport
    VisualScriptingCanvas<StateGraph>.mousePosition
    VisualScriptingCanvas<StateGraph>.isMouseOver
    VisualScriptingCanvas<StateGraph>.isMouseOverBackground
    VisualScriptingCanvas<StateGraph>.UpdateViewport()
    VisualScriptingCanvas<StateGraph>.TweenViewport(Vector2, Single, Single)
    VisualScriptingCanvas<StateGraph>.CacheWidgetVisibility()
    VisualScriptingCanvas<StateGraph>.ViewElements(IEnumerable<IGraphElement>)
    VisualScriptingCanvas<StateGraph>.IsVisible(IWidget)
    VisualScriptingCanvas<StateGraph>.CacheWidgetPositions()
    VisualScriptingCanvas<StateGraph>.hoveredWidget
    VisualScriptingCanvas<StateGraph>.isLassoing
    VisualScriptingCanvas<StateGraph>.lassoArea
    VisualScriptingCanvas<StateGraph>.isSelecting
    VisualScriptingCanvas<StateGraph>.selectionArea
    VisualScriptingCanvas<StateGraph>.isGrouping
    VisualScriptingCanvas<StateGraph>.groupArea
    VisualScriptingCanvas<StateGraph>.isDragging
    VisualScriptingCanvas<StateGraph>.BeginDrag(EventWrapper)
    VisualScriptingCanvas<StateGraph>.Drag(EventWrapper)
    VisualScriptingCanvas<StateGraph>.EndDrag(EventWrapper)
    VisualScriptingCanvas<StateGraph>.DeleteSelection()
    VisualScriptingCanvas<StateGraph>.GetExtendedContextOptions()
    VisualScriptingCanvas<StateGraph>.alignableAndDistributable
    VisualScriptingCanvas<StateGraph>.Align(AlignOperation)
    VisualScriptingCanvas<StateGraph>.Distribute(DistributeOperation)
    VisualScriptingCanvas<StateGraph>.DrawWidgetsBackground()
    VisualScriptingCanvas<StateGraph>.DrawWidgetsForeground()
    VisualScriptingCanvas<StateGraph>.DrawWidgetsOverlay()
    VisualScriptingCanvas<StateGraph>.DrawOverlay()
    VisualScriptingCanvas<StateGraph>.dragAndDropVisualMode
    VisualScriptingCanvas<StateGraph>.UpdateDragAndDrop()
    VisualScriptingCanvas<StateGraph>.ExitDragAndDrop()
    VisualScriptingCanvas<StateGraph>.frameDeltaTime
    VisualScriptingCanvas<StateGraph>.eventDeltaTime
    VisualScriptingCanvas<StateGraph>.repaintDeltaTime
    VisualScriptingCanvas<StateGraph>.delayedCalls
    VisualScriptingCanvas<StateGraph>.delayCall
    Namespace: Unity.VisualScripting
    Syntax
    [Canvas(typeof(StateGraph))]
    public sealed class StateCanvas : VisualScriptingCanvas<StateGraph>, ICanvas, IDisposable, IDragAndDropHandler

    Constructors

    StateCanvas(StateGraph)

    Declaration
    public StateCanvas(StateGraph graph)
    Parameters
    Type Name Description
    StateGraph graph

    Properties

    isCreatingTransition

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

    shouldEdgePan

    Declaration
    protected override bool shouldEdgePan { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.shouldEdgePan

    transitionSource

    Declaration
    public IState transitionSource { get; set; }
    Property Value
    Type Description
    IState

    Methods

    AcceptsDragAndDrop()

    Declaration
    public override bool AcceptsDragAndDrop()
    Returns
    Type Description
    Boolean
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.AcceptsDragAndDrop()

    AddState(IState, Vector2)

    Declaration
    public void AddState(IState state, Vector2 position)
    Parameters
    Type Name Description
    IState state
    Vector2 position

    CancelTransition()

    Declaration
    public void CancelTransition()

    Close()

    Declaration
    public override void Close()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.Close()

    CompleteTransitionToNewState()

    Declaration
    public void CompleteTransitionToNewState()

    DrawBackground()

    Declaration
    protected override void DrawBackground()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.DrawBackground()

    DrawDragAndDropPreview()

    Declaration
    public override void DrawDragAndDropPreview()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.DrawDragAndDropPreview()

    EndTransition(IState)

    Declaration
    public void EndTransition(IState destination)
    Parameters
    Type Name Description
    IState destination

    GetContextOptions()

    Declaration
    protected override IEnumerable<DropdownOption> GetContextOptions()
    Returns
    Type Description
    IEnumerable<DropdownOption>
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.GetContextOptions()

    HandleHighPriorityInput()

    Declaration
    protected override void HandleHighPriorityInput()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.HandleHighPriorityInput()

    OnContext()

    Declaration
    protected override void OnContext()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.OnContext()

    OnToolbarGUI()

    Declaration
    public override void OnToolbarGUI()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.OnToolbarGUI()

    PerformDragAndDrop()

    Declaration
    public override void PerformDragAndDrop()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.PerformDragAndDrop()

    ShrinkCopyGroup(HashSet<IGraphElement>)

    Declaration
    public override void ShrinkCopyGroup(HashSet<IGraphElement> copyGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> copyGroup
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.ShrinkCopyGroup(System.Collections.Generic.HashSet<Unity.VisualScripting.IGraphElement>)

    StartTransition(IState)

    Declaration
    public void StartTransition(IState source)
    Parameters
    Type Name Description
    IState source

    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)
    XCanvasProvider.Widget(ICanvas, IGraphItem)
    XCanvasProvider.Widget<TWidget>(ICanvas, IGraphItem)
    XCanvasProvider.Widget(ICanvas, IGraphElement)
    XCanvasProvider.Widget<TWidget>(ICanvas, IGraphElement)
    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