Class Node | Asset Graph | 1.6.0-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class Node

    Node.

    Inheritance
    Object
    Node
    AddressableAssetAddress
    AddressableAssetGroup
    AddressableAssetLabel
    AssertUnwantedAssetsInBundle
    AssetGenerator
    BundleBuilder
    BundleConfigurator
    Error
    Exporter
    ExtractSharedAssets
    Filter
    Grouping
    GroupingByFile
    GroupingBySize
    Imported
    ImportSetting
    Label
    Loader
    LoaderBySearch
    MirrorDirectory
    Modifier
    PlayerBuilder
    PrefabBuilder
    Namespace: UnityEngine.AssetGraph
    Syntax
    public abstract class Node

    Properties

    ActiveStyle

    Gets the active style name in GUISkin.

    Declaration
    public abstract string ActiveStyle { get; }
    Property Value
    Type Description
    String

    The active style.

    Category

    Category returns label string displayed at bottom of node.

    Declaration
    public abstract string Category { get; }
    Property Value
    Type Description
    String

    The category.

    InactiveStyle

    Gets the inactive style name in GUISkin.

    Declaration
    public abstract string InactiveStyle { get; }
    Property Value
    Type Description
    String

    The inactive style.

    NodeInputType

    Gets the valid type of the node input.

    Declaration
    public virtual NodeOutputSemantics NodeInputType { get; }
    Property Value
    Type Description
    NodeOutputSemantics

    The type of the node input.

    NodeOutputType

    Gets the valid type of the node output.

    Declaration
    public virtual NodeOutputSemantics NodeOutputType { get; }
    Property Value
    Type Description
    NodeOutputSemantics

    The type of the node output.

    Methods

    Build(BuildTarget, NodeData, IEnumerable<PerformGraph.AssetGroups>, IEnumerable<ConnectionData>, PerformGraph.Output, Action<NodeData, String, Single>)

    Build is the method which actualy performs the build. It is always called after Setup() is performed.

    Declaration
    public virtual void Build(BuildTarget target, NodeData nodeData, IEnumerable<PerformGraph.AssetGroups> incoming, IEnumerable<ConnectionData> connectionsToOutput, PerformGraph.Output outputFunc, Action<NodeData, string, float> progressFunc)
    Parameters
    Type Name Description
    BuildTarget target

    Target platform.

    NodeData nodeData

    NodeData instance for this node.

    IEnumerable<PerformGraph.AssetGroups> incoming

    Incoming group of assets for this node on executing graph.

    IEnumerable<ConnectionData> connectionsToOutput

    Outgoing connections from this node.

    PerformGraph.Output outputFunc

    An interface to set outgoing group of assets.

    Action<NodeData, String, Single> progressFunc

    An interface to display progress.

    Build(NodeBuildContext)

    Declaration
    public virtual void Build(NodeBuildContext ctx)
    Parameters
    Type Name Description
    NodeBuildContext ctx

    Clone(NodeData)

    Clone the node using newData.

    Declaration
    public abstract Node Clone(NodeData newData)
    Parameters
    Type Name Description
    NodeData newData

    New data.

    Returns
    Type Description
    Node

    Initialize(NodeData)

    Initialize Node with given NodeData.

    Declaration
    public abstract void Initialize(NodeData data)
    Parameters
    Type Name Description
    NodeData data

    Data.

    IsValidInputConnectionPoint(ConnectionPointData)

    Determines whether this instance is valid input connection point the specified point.

    Declaration
    public virtual bool IsValidInputConnectionPoint(ConnectionPointData point)
    Parameters
    Type Name Description
    ConnectionPointData point

    Point.

    Returns
    Type Description
    Boolean

    true if this instance is valid input connection point the specified point; otherwise, false.

    OnAssetsReimported(NodeData, AssetReferenceStreamManager, BuildTarget, AssetPostprocessorContext, Boolean)

    OnAssetsReimported() is called when there are changes of assets during editing graph.

    Declaration
    public virtual bool OnAssetsReimported(NodeData nodeData, AssetReferenceStreamManager streamManager, BuildTarget target, AssetPostprocessorContext ctx, bool isBuilding)
    Parameters
    Type Name Description
    NodeData nodeData

    NodeGUI instance for this node.

    AssetReferenceStreamManager streamManager

    Manager instance to retrieve graph's incoming/outgoing group.

    BuildTarget target

    Target platform.

    AssetPostprocessorContext ctx

    Reimport context.

    Boolean isBuilding
    Returns
    Type Description
    Boolean

    OnContextMenuGUI(GenericMenu)

    OnContextMenuGUI() is called when Node is clicked for context menu.

    Declaration
    public virtual void OnContextMenuGUI(GenericMenu menu)
    Parameters
    Type Name Description
    GenericMenu menu

    Context menu instance.

    OnInspectorGUI(NodeGUI, AssetReferenceStreamManager, NodeGUIEditor, Action)

    Raises the inspector GU event.

    Declaration
    public abstract void OnInspectorGUI(NodeGUI node, AssetReferenceStreamManager streamManager, NodeGUIEditor editor, Action onValueChanged)
    Parameters
    Type Name Description
    NodeGUI node

    NodeGUI instance for this node.

    AssetReferenceStreamManager streamManager

    Manager instance to retrieve graph's incoming/outgoing group of assets.

    NodeGUIEditor editor

    Helper instance to draw inspector.

    Action onValueChanged

    Action to call when OnInspectorGUI() changed value of this node.

    OnNodeDelete(NodeData)

    OnNodeDelete() is called when node is about to be deleted.

    Declaration
    public virtual void OnNodeDelete(NodeData nodeData)
    Parameters
    Type Name Description
    NodeData nodeData

    NodeGUI instance for this node.

    Prepare(BuildTarget, NodeData, IEnumerable<PerformGraph.AssetGroups>, IEnumerable<ConnectionData>, PerformGraph.Output)

    Prepare is the method which validates and perform necessary setups in order to build.

    Declaration
    public virtual void Prepare(BuildTarget target, NodeData nodeData, IEnumerable<PerformGraph.AssetGroups> incoming, IEnumerable<ConnectionData> connectionsToOutput, PerformGraph.Output outputFunc)
    Parameters
    Type Name Description
    BuildTarget target

    Target platform.

    NodeData nodeData

    NodeData instance for this node.

    IEnumerable<PerformGraph.AssetGroups> incoming

    Incoming group of assets for this node on executing graph.

    IEnumerable<ConnectionData> connectionsToOutput

    Outgoing connections from this node.

    PerformGraph.Output outputFunc

    An interface to set outgoing group of assets.

    Prepare(NodeBuildContext)

    Declaration
    public virtual void Prepare(NodeBuildContext ctx)
    Parameters
    Type Name Description
    NodeBuildContext ctx
    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