Class CompositorNodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>

Inheritance
Object
NodeDefinition
SimulationNodeDefinition<TSimPorts>
SimulationKernelNodeDefinition<TSimPorts, TKernelPorts>
NodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>
CompositorNodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>
AnimationCompositorNodeDefinition
ConversionServiceTests.DummyCompositorNodeDefinition
Inherited Members
Unity.DataFlowGraph.NodeDefinition.BaseTraits
Namespace: Unity.Compositor
Syntax
public abstract class CompositorNodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel> : NodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>, IGraphHandler, ITaskPortMsgHandler<IGraphHandler, BlobAssetReference<Graph>>, ITaskPort<IGraphHandler>, IEntityContextHandler, ITaskPortMsgHandler<IEntityContextHandler, EntityContext>, ITaskPort<IEntityContextHandler>, IMsgHandler<EntityContext>, IComponentNodeHandler, ITaskPortMsgHandler<IComponentNodeHandler, NodeHandle<ComponentNode>>, ITaskPort<IComponentNodeHandler>, IMsgHandler<NodeHandle<ComponentNode>>, IMsgHandler<BlobAssetReference<Graph>> where TSimData : struct, INodeData, ICompositorSimulationData where TSimPorts : struct, ISimulationPortDefinition where TKernelData : struct, IKernelData where TKernelPorts : struct, IKernelPortDefinition where TKernel : struct, IGraphKernel<TKernelData, TKernelPorts>
Type Parameters
Name Description
TSimData
TSimPorts
TKernelData
TKernelPorts
TKernel

Methods

Connect(ref TSimData, ConnectNodesCommand)

Declaration
protected void Connect(ref TSimData data, ConnectNodesCommand connection)
Parameters
Type Name Description
TSimData data
ConnectNodesCommand connection

Destroy(DestroyContext)

Declaration
protected override void Destroy(DestroyContext ctx)
Parameters
Type Name Description
DestroyContext ctx
Overrides

Dispatch<T>(ref TSimData, CompositorNodeID, CompositorPortID, T)

Declaration
protected void Dispatch<T>(ref TSimData nodeData, CompositorNodeID node, CompositorPortID port, in T data)
    where T : struct
Parameters
Type Name Description
TSimData nodeData
CompositorNodeID node
CompositorPortID port
T data
Type Parameters
Name Description
T

GetComponentNodePort(NodeHandle)

Declaration
protected abstract InputPortID GetComponentNodePort(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
InputPortID

GetEntityContextPort(NodeHandle)

Declaration
public abstract InputPortID GetEntityContextPort(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
InputPortID

GetGraphPort(NodeHandle)

Declaration
protected abstract InputPortID GetGraphPort(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
InputPortID

GetInputPort(ICompositorSimulationData, CompositorNodeID, CompositorPortID)

Declaration
protected PortDescription.InputPort GetInputPort(ICompositorSimulationData data, CompositorNodeID Node, CompositorPortID Port)
Parameters
Type Name Description
ICompositorSimulationData data
CompositorNodeID Node
CompositorPortID Port
Returns
Type Description
PortDescription.InputPort

GetOutputPort(ICompositorSimulationData, CompositorNodeID, CompositorPortID)

Declaration
protected PortDescription.OutputPort GetOutputPort(ICompositorSimulationData data, CompositorNodeID Node, CompositorPortID Port)
Parameters
Type Name Description
ICompositorSimulationData data
CompositorNodeID Node
CompositorPortID Port
Returns
Type Description
PortDescription.OutputPort

GetPort(NodeHandle)

Declaration
public InputPortID GetPort(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
InputPortID
Implements

HandleMessage(MessageContext, EntityContext)

Declaration
public void HandleMessage(in MessageContext ctx, in EntityContext msg)
Parameters
Type Name Description
MessageContext ctx
EntityContext msg
Implements

HandleMessage(MessageContext, NodeHandle<ComponentNode>)

Declaration
public void HandleMessage(in MessageContext ctx, in NodeHandle<ComponentNode> msg)
Parameters
Type Name Description
MessageContext ctx
NodeHandle<ComponentNode> msg
Implements

HandleMessage(MessageContext, BlobAssetReference<Graph>)

Declaration
public virtual void HandleMessage(in MessageContext ctx, in BlobAssetReference<Graph> msg)
Parameters
Type Name Description
MessageContext ctx
BlobAssetReference<Graph> msg
Implements

Init(InitContext)

Declaration
protected override void Init(InitContext ctx)
Parameters
Type Name Description
InitContext ctx
Overrides

SendMessage<TMsg, TValue>(NodeHandle, TMsg)

Declaration
protected void SendMessage<TMsg, TValue>(NodeHandle handle, TMsg message)
    where TMsg : struct, ICompositorTarget<TValue> where TValue : struct
Parameters
Type Name Description
NodeHandle handle
TMsg message
Type Parameters
Name Description
TMsg
TValue

SendMessages<TMsg, TValue>(NodeHandle, DynamicBuffer<TMsg>)

Declaration
protected void SendMessages<TMsg, TValue>(NodeHandle handle, DynamicBuffer<TMsg> messages)
    where TMsg : struct, ICompositorTarget<TValue> where TValue : struct
Parameters
Type Name Description
NodeHandle handle
DynamicBuffer<TMsg> messages
Type Parameters
Name Description
TMsg
TValue

SendVariantMessage(ref TSimData, CompositorNodeID, CompositorPortID, GraphVariant)

Declaration
protected void SendVariantMessage(ref TSimData data, CompositorNodeID node, CompositorPortID port, GraphVariant msg)
Parameters
Type Name Description
TSimData data
CompositorNodeID node
CompositorPortID port
GraphVariant msg

Explicit Interface Implementations

ITaskPort<IComponentNodeHandler>.GetPort(NodeHandle)

Declaration
InputPortID ITaskPort<IComponentNodeHandler>.GetPort(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
InputPortID
Implements

ITaskPort<IGraphHandler>.GetPort(NodeHandle)

Declaration
InputPortID ITaskPort<IGraphHandler>.GetPort(NodeHandle handle)
Parameters
Type Name Description
NodeHandle handle
Returns
Type Description
InputPortID
Implements