Interface INodeFunctionality

Base interface of all nodes. NodeFunctionality

Inherited Members
Namespace: Unity.DataFlowGraph
Syntax
public interface INodeFunctionality : IDisposable

Properties

BaseTraits

Declaration
NodeTraitsBase BaseTraits { get; }
Property Value
Type Description
NodeTraitsBase

Set

Declaration
NodeSet Set { get; set; }
Property Value
Type Description
NodeSet

Methods

Destroy(NodeHandle)

Destructor, provides an opportunity to clean up resources related to this instance. Destroy(NodeHandle)

Declaration
void Destroy(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Remarks

It is undefined behaviour to throw an exception from this method.

GeneratePortDescriptions()

Declaration
void GeneratePortDescriptions()

GetPortDescription(NodeHandle)

Declaration
PortDescription GetPortDescription(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
PortDescription

Init(InitContext)

Constructor function, called for each instantiation of this type. Create<TDefinition>()

Declaration
void Init(InitContext ctx)
Parameters
Type Name Description
InitContext ctx

Provides initialization context and do-once operations for this particular node. Init(InitContext)
Remarks

It is undefined behaviour to throw an exception from this method.

OnMessage<T>(MessageContext, T)

Declaration
void OnMessage<T>(in MessageContext ctx, in T msg)
Parameters
Type Name Description
MessageContext ctx
T msg
Type Parameters
Name Description
T

OnUpdate(NodeHandle)

Declaration
void OnUpdate(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Remarks

It is undefined behaviour to throw an exception from this method.