Class CompositorGraphStencil | Compositor | 0.7.0-preview.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class CompositorGraphStencil

    Inheritance
    Object
    UnityEditor.VisualScripting.Model.Stencils.Stencil
    CompositorGraphStencil
    AnimationCompositorGraphStencil
    DummyCompositorGraphStencil
    Inherited Members
    UnityEditor.VisualScripting.Model.Stencils.Stencil.m_BlackboardProvider
    UnityEditor.VisualScripting.Model.Stencils.Stencil.addCreateAssetMenuAttribute
    UnityEditor.VisualScripting.Model.Stencils.Stencil.fileName
    UnityEditor.VisualScripting.Model.Stencils.Stencil.menuName
    UnityEditor.VisualScripting.Model.Stencils.Stencil.CreateGraphContext()
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetThisType()
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetBaseClass()
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetDefaultStackModelType()
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetAssemblies()
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetAssembliesTypesMetadata()
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetSearcherAdapter(UnityEditor.VisualScripting.GraphViewModel.IStackModel, System.String)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.OnCompilationSucceeded(UnityEditor.VisualScripting.Model.VSGraphModel, UnityEditor.VisualScripting.Model.CompilationResult)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.OnCompilationFailed(UnityEditor.VisualScripting.Model.VSGraphModel, UnityEditor.VisualScripting.Model.CompilationResult)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetCompilationPluginHandlers(UnityEngine.VisualScripting.CompilationOptions)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GenerateTypeHandle(System.Type)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.RequiresInitialization(UnityEditor.VisualScripting.Model.IVariableDeclarationModel)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.RequiresInspectorInitialization(UnityEditor.VisualScripting.Model.IVariableDeclarationModel)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetConstantNodeModelType(System.Type)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.SpawnAllNodes(UnityEditor.VisualScripting.Model.VSGraphModel)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetEntryPoints(UnityEditor.VisualScripting.Model.VSGraphModel)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.OnInspectorGUI()
    UnityEditor.VisualScripting.Model.Stencils.Stencil.CreateDependencyFromEdge(UnityEditor.VisualScripting.GraphViewModel.IEdgeModel, UnityEditor.VisualScripting.Editor.LinkedNodesDependency, UnityEditor.VisualScripting.GraphViewModel.INodeModel)
    UnityEditor.VisualScripting.Model.Stencils.Stencil.RuntimeReference
    UnityEditor.VisualScripting.Model.Stencils.Stencil.RecompilationRequested
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GraphContext
    UnityEditor.VisualScripting.Model.Stencils.Stencil.Capabilities
    UnityEditor.VisualScripting.Model.Stencils.Stencil.MoveNodeDependenciesByDefault
    UnityEditor.VisualScripting.Model.Stencils.Stencil.Debugger
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GeneratesCode
    Namespace: Unity.Compositor.Stencils
    Syntax
    public abstract class CompositorGraphStencil : Stencil, ISearcherDatabaseProvider, IAuthoringContextProvider

    Properties

    Builder

    Declaration
    public override IBuilder Builder { get; }
    Property Value
    Type Description
    UnityEditor.VisualScripting.Model.Compilation.IBuilder
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.Builder

    Context

    Declaration
    public abstract IAuthoringContext Context { get; }
    Property Value
    Type Description
    IAuthoringContext
    Implements
    IAuthoringContextProvider.Context

    DragNDropHandler

    Declaration
    public override IExternalDragNDropHandler DragNDropHandler { get; }
    Property Value
    Type Description
    UnityEditor.VisualScripting.Editor.IExternalDragNDropHandler
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.DragNDropHandler

    Methods

    ClearGraphElementsSearcherDatabases()

    Declaration
    public void ClearGraphElementsSearcherDatabases()
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.ClearGraphElementsSearcherDatabases()

    ClearGraphVariablesSearcherDatabases()

    Declaration
    public void ClearGraphVariablesSearcherDatabases()
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.ClearGraphVariablesSearcherDatabases()

    ClearReferenceItemsSearcherDatabases()

    Declaration
    public void ClearReferenceItemsSearcherDatabases()
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.ClearReferenceItemsSearcherDatabases()

    ClearTypeMembersSearcherDatabases()

    Declaration
    public void ClearTypeMembersSearcherDatabases()
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.ClearTypeMembersSearcherDatabases()

    ClearTypesItemsSearcherDatabases()

    Declaration
    public void ClearTypesItemsSearcherDatabases()
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.ClearTypesItemsSearcherDatabases()

    CreateCompositorGraph<TStencil>(String)

    Declaration
    public static void CreateCompositorGraph<TStencil>(string assetName)
        where TStencil : CompositorGraphStencil
    Parameters
    Type Name Description
    String assetName
    Type Parameters
    Name Description
    TStencil

    CreateNodesFromPort(Store, IPortModel, Vector2, IEnumerable<IEdgeModel>, IStackModel, Int32)

    Declaration
    public override void CreateNodesFromPort(Store store, IPortModel portModel, Vector2 position, IEnumerable<IEdgeModel> edgesToDelete, IStackModel stackModel, int index)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.Editor.Store store
    UnityEditor.VisualScripting.GraphViewModel.IPortModel portModel
    Vector2 position
    IEnumerable<UnityEditor.VisualScripting.GraphViewModel.IEdgeModel> edgesToDelete
    UnityEditor.VisualScripting.GraphViewModel.IStackModel stackModel
    Int32 index

    CreateTranslator()

    Declaration
    public override ITranslator CreateTranslator()
    Returns
    Type Description
    UnityEditor.VisualScripting.Model.Translators.ITranslator
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.CreateTranslator()

    CreateVariableModelForDeclaration(IGraphModel, IVariableDeclarationModel, Vector2, SpawnFlags, Nullable<GUID>)

    Declaration
    public override IVariableModel CreateVariableModelForDeclaration(IGraphModel graphModel, IVariableDeclarationModel declarationModel, Vector2 position, SpawnFlags spawnFlags = SpawnFlags.Undoable | SpawnFlags.CreateNodeAsset | SpawnFlags.Default, GUID? guid = default(GUID? ))
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.GraphViewModel.IGraphModel graphModel
    UnityEditor.VisualScripting.Model.IVariableDeclarationModel declarationModel
    Vector2 position
    UnityEditor.VisualScripting.GraphViewModel.SpawnFlags spawnFlags
    Nullable<UnityEditor.GUID> guid
    Returns
    Type Description
    UnityEditor.VisualScripting.Model.IVariableModel

    GetBlackboardProvider()

    Declaration
    public override IBlackboardProvider GetBlackboardProvider()
    Returns
    Type Description
    UnityEditor.VisualScripting.Editor.IBlackboardProvider
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetBlackboardProvider()

    GetConstantNodeModelType(TypeHandle)

    Declaration
    public override Type GetConstantNodeModelType(TypeHandle typeHandle)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.Model.Stencils.TypeHandle typeHandle
    Returns
    Type Description
    Type
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetConstantNodeModelType(UnityEditor.VisualScripting.Model.Stencils.TypeHandle)

    GetDynamicSearcherDatabases(IPortModel)

    Declaration
    public List<SearcherDatabase> GetDynamicSearcherDatabases(IPortModel portModel)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.GraphViewModel.IPortModel portModel
    Returns
    Type Description
    List<SearcherDatabase>
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.GetDynamicSearcherDatabases(UnityEditor.VisualScripting.GraphViewModel.IPortModel)

    GetGraphElementsSearcherDatabases()

    Declaration
    public List<SearcherDatabase> GetGraphElementsSearcherDatabases()
    Returns
    Type Description
    List<SearcherDatabase>
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.GetGraphElementsSearcherDatabases()

    GetGraphVariablesSearcherDatabases(IGraphModel, IFunctionModel)

    Declaration
    public List<SearcherDatabase> GetGraphVariablesSearcherDatabases(IGraphModel graphModel, IFunctionModel functionModel = null)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.GraphViewModel.IGraphModel graphModel
    UnityEditor.VisualScripting.Model.IFunctionModel functionModel
    Returns
    Type Description
    List<SearcherDatabase>
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.GetGraphVariablesSearcherDatabases(UnityEditor.VisualScripting.GraphViewModel.IGraphModel, UnityEditor.VisualScripting.Model.IFunctionModel)

    GetPortsSearcherDatabases()

    Declaration
    public List<SearcherDatabase> GetPortsSearcherDatabases()
    Returns
    Type Description
    List<SearcherDatabase>

    GetReferenceItemsSearcherDatabases()

    Declaration
    public List<SearcherDatabase> GetReferenceItemsSearcherDatabases()
    Returns
    Type Description
    List<SearcherDatabase>
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.GetReferenceItemsSearcherDatabases()

    GetSearcherAdapter(IGraphModel, String)

    Declaration
    public override ISearcherAdapter GetSearcherAdapter(IGraphModel graphModel, string title)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.GraphViewModel.IGraphModel graphModel
    String title
    Returns
    Type Description
    ISearcherAdapter
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetSearcherAdapter(UnityEditor.VisualScripting.GraphViewModel.IGraphModel, System.String)

    GetSearcherDatabaseProvider()

    Declaration
    public override ISearcherDatabaseProvider GetSearcherDatabaseProvider()
    Returns
    Type Description
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetSearcherDatabaseProvider()

    GetSearcherFilterProvider()

    Declaration
    public override ISearcherFilterProvider GetSearcherFilterProvider()
    Returns
    Type Description
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherFilterProvider
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetSearcherFilterProvider()

    GetSourceFilePath(VSGraphModel)

    Declaration
    public override string GetSourceFilePath(VSGraphModel graphModel)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.Model.VSGraphModel graphModel
    Returns
    Type Description
    String
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.GetSourceFilePath(UnityEditor.VisualScripting.Model.VSGraphModel)

    GetTypeMembersSearcherDatabases(TypeHandle)

    Declaration
    public List<SearcherDatabase> GetTypeMembersSearcherDatabases(TypeHandle typeHandle)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.Model.Stencils.TypeHandle typeHandle
    Returns
    Type Description
    List<SearcherDatabase>
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.GetTypeMembersSearcherDatabases(UnityEditor.VisualScripting.Model.Stencils.TypeHandle)

    GetTypesSearcherDatabases()

    Declaration
    public List<SearcherDatabase> GetTypesSearcherDatabases()
    Returns
    Type Description
    List<SearcherDatabase>
    Implements
    UnityEditor.VisualScripting.Editor.SmartSearch.ISearcherDatabaseProvider.GetTypesSearcherDatabases()

    PreProcessGraph(VSGraphModel)

    Declaration
    public override void PreProcessGraph(VSGraphModel graphModel)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.Model.VSGraphModel graphModel
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.PreProcessGraph(UnityEditor.VisualScripting.Model.VSGraphModel)

    RegisterReducers(Store)

    Declaration
    public override void RegisterReducers(Store store)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.Editor.Store store
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.RegisterReducers(UnityEditor.VisualScripting.Editor.Store)

    ValidateEdgeConnection(IPortModel, IPortModel)

    Declaration
    public override bool ValidateEdgeConnection(IPortModel inputPort, IPortModel outputPort)
    Parameters
    Type Name Description
    UnityEditor.VisualScripting.GraphViewModel.IPortModel inputPort
    UnityEditor.VisualScripting.GraphViewModel.IPortModel outputPort
    Returns
    Type Description
    Boolean
    Overrides
    UnityEditor.VisualScripting.Model.Stencils.Stencil.ValidateEdgeConnection(UnityEditor.VisualScripting.GraphViewModel.IPortModel, UnityEditor.VisualScripting.GraphViewModel.IPortModel)
    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