Class BaseGraph

Inheritance

System.Object

UnityEngine.Object

UnityEngine.ScriptableObject

BaseGraph

Implements

UnityEngine.ISerializationCallbackReceiver

Inherited Members

UnityEngine.ScriptableObject.SetDirty()

UnityEngine.ScriptableObject.CreateInstance(System.String)

UnityEngine.ScriptableObject.CreateInstance(System.Type)

UnityEngine.ScriptableObject.CreateInstance<T>()

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

Namespace: GraphProcessor

Assembly: com.alelievr.NodeGraphProcessor.Runtime.dll

Syntax

[Serializable]
public class BaseGraph : ScriptableObject, ISerializationCallbackReceiver

Fields

| Improve this Doc View Source

commentBlocks

All groups in the graph

Declaration

[SerializeField]
public List<CommentBlock> commentBlocks

Field Value

Type	Description
System.Collections.Generic.List<CommentBlock>

| Improve this Doc View Source

edges

Json list of edges

Declaration

[SerializeField]
public List<SerializableEdge> edges

Field Value

Type	Description
System.Collections.Generic.List<SerializableEdge>

| Improve this Doc View Source

edgesPerGUID

Dictionary of edges per GUID, faster than a search in a list

Declaration

[NonSerialized]
public Dictionary<string, SerializableEdge> edgesPerGUID

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, SerializableEdge>

| Improve this Doc View Source

exposedParameters

All exposed parameters in the graph

Declaration

[SerializeField]
public List<ExposedParameter> exposedParameters

Field Value

Type	Description
System.Collections.Generic.List<ExposedParameter>

| Improve this Doc View Source

nodes

List of all the nodes in the graph.

Declaration

[NonSerialized]
public List<BaseNode> nodes

Field Value

Type	Description
System.Collections.Generic.List<BaseNode>

| Improve this Doc View Source

nodesPerGUID

Dictionary to access node per GUID, faster than a search in a list

Declaration

[NonSerialized]
public Dictionary<string, BaseNode> nodesPerGUID

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, BaseNode>

| Improve this Doc View Source

pinnedElements

All pinned elements in the graph

Declaration

[SerializeField]
public List<PinnedElement> pinnedElements

Field Value

Type	Description
System.Collections.Generic.List<PinnedElement>

| Improve this Doc View Source

position

Declaration

public Vector3 position

Field Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

scale

Declaration

public Vector3 scale

Field Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

serializedNodes

Json list of nodes (Serialized)

Declaration

[SerializeField]
public List<JsonElement> serializedNodes

Field Value

Type	Description
System.Collections.Generic.List<JsonElement>

Properties

| Improve this Doc View Source

isEnabled

Declaration

public bool isEnabled { get; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

AddCommentBlock(CommentBlock)

Add a group

Declaration

public void AddCommentBlock(CommentBlock block)

Parameters

Type	Name	Description
CommentBlock	block

| Improve this Doc View Source

AddExposedParameter(String, Type, Object)

Add an exposed parameter

Declaration

public string AddExposedParameter(string name, Type type, object value)

Parameters

Type	Name	Description
System.String	name	parameter name
System.Type	type	parameter type
System.Object	value	default value

Returns

Type	Description
System.String

| Improve this Doc View Source

AddNode(BaseNode)

Adds a node to the graph

Declaration

public BaseNode AddNode(BaseNode node)

Parameters

Type	Name	Description
BaseNode	node

Returns

Type	Description
BaseNode

| Improve this Doc View Source

ClosePinned(Type)

Closes a pinned element of type viewType

Declaration

public void ClosePinned(Type viewType)

Parameters

Type	Name	Description
System.Type	viewType	type of the pinned element

| Improve this Doc View Source

Connect(NodePort, NodePort, Boolean)

Connect two ports with an edge

Declaration

public SerializableEdge Connect(NodePort inputPort, NodePort outputPort, bool autoDisconnectInputs = true)

Parameters

Type	Name	Description
NodePort	inputPort	input port
NodePort	outputPort	output port
System.Boolean	autoDisconnectInputs

Returns

Type	Description
SerializableEdge	the connecting edge

| Improve this Doc View Source

Deserialize()

Declaration

public void Deserialize()

| Improve this Doc View Source

Disconnect(BaseNode, String, BaseNode, String)

Disconnect two ports

Declaration

public void Disconnect(BaseNode inputNode, string inputFieldName, BaseNode outputNode, string outputFieldName)

Parameters

Type	Name	Description
BaseNode	inputNode	input node
System.String	inputFieldName	input field name
BaseNode	outputNode	output node
System.String	outputFieldName	output field name

| Improve this Doc View Source

Disconnect(SerializableEdge)

Disconnect an edge

Declaration

public void Disconnect(SerializableEdge edge)

Parameters

Type	Name	Description
SerializableEdge	edge

| Improve this Doc View Source

Disconnect(String)

Disconnect an edge

Declaration

public void Disconnect(string edgeGUID)

Parameters

Type	Name	Description
System.String	edgeGUID

| Improve this Doc View Source

GetExposedParameter(String)

Get the exposed parameter from name

Declaration

public ExposedParameter GetExposedParameter(string name)

Parameters

Type	Name	Description
System.String	name	name

Returns

Type	Description
ExposedParameter	the parameter or null

| Improve this Doc View Source

GetExposedParameterFromGUID(String)

Get exposed parameter from GUID

Declaration

public ExposedParameter GetExposedParameterFromGUID(string guid)

Parameters

Type	Name	Description
System.String	guid	GUID of the parameter

Returns

Type	Description
ExposedParameter	The parameter

| Improve this Doc View Source

GetParameterValue(String)

Get the parameter value

Declaration

public object GetParameterValue(string name)

Parameters

Type	Name	Description
System.String	name	parameter name

Returns

Type	Description
System.Object	value

| Improve this Doc View Source

GetParameterValue<T>(String)

Get the parameter value template

Declaration

public T GetParameterValue<T>(string name)

Parameters

Type	Name	Description
System.String	name	parameter name

Returns

Type	Description
T	value

Type Parameters

Name	Description
T	type of the parameter

| Improve this Doc View Source

OnAfterDeserialize()

Declaration

public void OnAfterDeserialize()

| Improve this Doc View Source

OnBeforeSerialize()

Declaration

public void OnBeforeSerialize()

| Improve this Doc View Source

OnEnable()

Declaration

protected virtual void OnEnable()

| Improve this Doc View Source

OpenPinned(Type)

Open a pinned element of type viewType

Declaration

public PinnedElement OpenPinned(Type viewType)

Parameters

Type	Name	Description
System.Type	viewType	type of the pinned element

Returns

Type	Description
PinnedElement	the pinned element

| Improve this Doc View Source

RemoveCommentBlock(CommentBlock)

Removes a group

Declaration

public void RemoveCommentBlock(CommentBlock block)

Parameters

Type	Name	Description
CommentBlock	block

| Improve this Doc View Source

RemoveExposedParameter(ExposedParameter)

Remove an exposed parameter

Declaration

public void RemoveExposedParameter(ExposedParameter ep)

Parameters

Type	Name	Description
ExposedParameter	ep	the parameter to remove

| Improve this Doc View Source

RemoveExposedParameter(String)

Remove an exposed parameter

Declaration

public void RemoveExposedParameter(string guid)

Parameters

Type	Name	Description
System.String	guid	GUID of the parameter

| Improve this Doc View Source

RemoveNode(BaseNode)

Removes a node from the graph

Declaration

public void RemoveNode(BaseNode node)

Parameters

Type	Name	Description
BaseNode	node

| Improve this Doc View Source

SetParameterValue(String, Object)

Set parameter value from name. (Warning: the parameter name can be changed by the user)

Declaration

public bool SetParameterValue(string name, object value)

Parameters

Type	Name	Description
System.String	name	name of the parameter
System.Object	value	new value

Returns

Type	Description
System.Boolean	true if the value have been assigned

| Improve this Doc View Source

TypesAreConnectable(Type, Type)

Tell if two types can be connected in the context of a graph

Declaration

public static bool TypesAreConnectable(Type t1, Type t2)

Parameters

Type	Name	Description
System.Type	t1
System.Type	t2

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

UpdateComputeOrder()

Update the compute order of the nodes in the graph

Declaration

public void UpdateComputeOrder()

| Improve this Doc View Source

UpdateExposedParameter(String, Object)

Update an exposed parameter value

Declaration

public void UpdateExposedParameter(string guid, object value)

Parameters

Type	Name	Description
System.String	guid	GUID of the parameter
System.Object	value	new value

| Improve this Doc View Source

UpdateExposedParameterName(ExposedParameter, String)

Update the exposed parameter name

Declaration

public void UpdateExposedParameterName(ExposedParameter parameter, string name)

Parameters

Type	Name	Description
ExposedParameter	parameter	The parameter
System.String	name	new name

| Improve this Doc View Source

UpdateExposedParameterVisibility(ExposedParameter, Boolean)

Update parameter visibility

Declaration

public void UpdateExposedParameterVisibility(ExposedParameter parameter, bool isHidden)

Parameters

Type	Name	Description
ExposedParameter	parameter	The parameter
System.Boolean	isHidden	is Hidden

Events

| Improve this Doc View Source

onEnabled

Triggered when the graph is enabled

Declaration

public event Action onEnabled

Event Type

Type	Description
System.Action

| Improve this Doc View Source

onExposedParameterListChanged

Triggered when something is changed in the list of exposed parameters

Declaration

public event Action onExposedParameterListChanged

Event Type

Type	Description
System.Action

| Improve this Doc View Source

onExposedParameterModified

Declaration

public event Action<string> onExposedParameterModified

Event Type

Type	Description
System.Action<System.String>

| Improve this Doc View Source

onGraphChanges

Triggered when the graph is changed

Declaration

public event Action<GraphChanges> onGraphChanges

Event Type

Type	Description
System.Action<GraphChanges>

Implements

UnityEngine.ISerializationCallbackReceiver