NodeInstance¶
class NodeInstance
An instance of an Amplimix pipeline node.
This class represents the actual node executed within the Amplimix pipeline. Each node instance has a unique ID assigned to it, that matches the one provided in the pipeline asset.
Variables¶
| Name | Description |
|---|---|
| m_id | The unique identifier for the node instance in the pipeline. |
| m_layer | The Amplimix layer this node instance is currently associated with. |
| m_pipeline | The pipeline this node instance belongs to. |
Functions¶
| Name | Description |
|---|---|
| Initialize | Initializes the node instance. |
| ~NodeInstance | Default destructor. |
| GetId | Gets the unique identifier for the node instance. |
| GetLayer | Gets the Amplimix layer this node instance is currently associated with. |
| Reset | Resets the node instance's internal state. |
Variable Details¶
m_id¶
AmObjectID m_id
The unique identifier for the node instance in the pipeline.
m_layer¶
const AmplimixLayer* m_layer
The Amplimix layer this node instance is currently associated with.
m_pipeline¶
const PipelineInstance* m_pipeline
The pipeline this node instance belongs to.
Function Details¶
GetId¶
[[nodiscard]] AmObjectID GetId() const
Gets the unique identifier for the node instance.
- Return
- The unique identifier for the node instance.
GetLayer¶
[[nodiscard]] const AmplimixLayer* GetLayer() const
Gets the Amplimix layer this node instance is currently associated with.
- Return
- The Amplimix layer this node instance is currently associated with.
- See
- AmplimixLayer
Initialize¶
virtual void Initialize(AmObjectID id, const AmplimixLayer* layer, const PipelineInstance* pipeline)
Initializes the node instance.
- Parameter
id - Unique identifier for the node instance.
- Parameter
layer - The Amplimix layer this node instance is currently associated with.
- Parameter
pipeline - The pipeline this node instance belongs to.
Reset¶
virtual void Reset() = 0
Resets the node instance's internal state.
Warning
This function should be called automatically by Amplimix, each time the pipeline is about to be executed. Call it manually only if you know what you're doing.
~NodeInstance¶
virtual ~NodeInstance() = default
Default destructor.