Loading...
Searching...
No Matches
Classes |
Public Member Functions |
Protected Member Functions |
Private Attributes |
List of all members
MayaFlux::Nodes::Constant Class Referencefinal
Zero-overhead scalar source node that emits a fixed value on every tick. More...
#include <Constant.hpp>
Inheritance diagram for MayaFlux::Nodes::Constant:
Collaboration diagram for MayaFlux::Nodes::Constant:
Classes | |
| struct | ConstantContext |
| Minimal concrete context for Constant — no extra fields beyond the base. More... | |
Public Member Functions | |
| Constant (double value=0.0) | |
| Construct with an initial constant value. | |
| double | process_sample (double input=0.0) override |
| Return the constant value, ignoring input. | |
| std::vector< double > | process_batch (unsigned int num_samples) override |
| Fill a buffer with the constant value. | |
| void | set_constant (double value) |
| Update the emitted value. | |
| double | get_constant () const |
| Read the current constant value without triggering processing. | |
| void | save_state () override |
| Snapshot the current value for later restoration. | |
| void | restore_state () override |
| Restore value from last save_state() call. | |
| NodeContext & | get_last_context () override |
| Return the cached NodeContext from the last process_sample() call. | |
| Public Member Functions inherited from MayaFlux::Nodes::Node | |
| virtual | ~Node ()=default |
| Virtual destructor for proper cleanup of derived classes. | |
| virtual void | on_tick (const NodeHook &callback) |
| Registers a callback to be called on each tick. | |
| virtual void | on_tick_if (const NodeCondition &condition, const NodeHook &callback) |
| Registers a conditional callback. | |
| virtual bool | remove_hook (const NodeHook &callback) |
| Removes a previously registered callback. | |
| virtual bool | remove_conditional_hook (const NodeCondition &callback) |
| Removes a previously registered conditional callback. | |
| virtual void | remove_all_hooks () |
| Removes all registered callbacks. | |
| virtual void | reset_processed_state () |
| Resets the processed state of the node and any attached input nodes. | |
| virtual double | get_last_output () |
| Retrieves the most recent output value produced by the node. | |
| void | register_channel_usage (uint32_t channel_id) |
| Mark the specificed channel as a processor/user. | |
| void | unregister_channel_usage (uint32_t channel_id) |
| Removes the specified channel from the usage tracking. | |
| bool | is_used_by_channel (uint32_t channel_id) const |
| Checks if the node is currently used by a specific channel. | |
| void | request_reset_from_channel (uint32_t channel_id) |
| Requests a reset of the processed state from a specific channel. | |
| const std::atomic< uint32_t > & | get_channel_mask () const |
| Retrieves the current bitmask of active channels using this node. | |
| void | set_gpu_compatible (bool compatible) |
| Sets whether the node is compatible with GPU processing. | |
| bool | is_gpu_compatible () const |
| Checks if the node supports GPU processing. | |
| std::span< const float > | get_gpu_data_buffer () const |
| Provides access to the GPU data buffer. | |
| void | set_sample_rate (uint32_t sample_rate) |
| uint32_t | get_sample_rate () const |
| bool | try_claim_snapshot_context (uint64_t context_id) |
| Attempt to claim snapshot context for this processing cycle. | |
| bool | is_in_snapshot_context (uint64_t context_id) const |
| Check if currently in a snapshot context. | |
| void | release_snapshot_context (uint64_t context_id) |
| Release snapshot context. | |
| bool | has_active_snapshot () const |
| Check if node is currently being snapshotted by any context. | |
| uint64_t | get_active_snapshot_context () const |
| Get the active snapshot context ID. | |
| void | add_buffer_reference () |
| Increments the buffer reference count This method is called when a new buffer starts using this node to ensure proper lifecycle management. | |
| void | remove_buffer_reference () |
| Decrements the buffer reference count This method is called when a buffer stops using this node to ensure proper lifecycle management. | |
| bool | mark_buffer_processed () |
| Marks the node as having been processed by a buffer. | |
| void | request_buffer_reset () |
| Requests a reset of the buffer state. | |
| bool | is_buffer_processed () const |
| Checks if the buffer has been processed. | |
| bool | is_in_network () const |
| Sets whether the node is part of a NodeNetwork. | |
| void | set_in_network (bool networked) |
| Marks the node as being part of a NodeNetwork. | |
| const RoutingState & | get_routing_state () const |
| Retrieves the current routing state of the network. | |
| RoutingState & | get_routing_state () |
| Retrieves the current routing state of the network (non-const) | |
| bool | needs_channel_routing () const |
| Checks if the network is currently in a routing transition phase. | |
Protected Member Functions | |
| void | update_context (double value) override |
| Update m_context with the latest value. | |
| void | notify_tick (double value) override |
| Fire all registered on_tick() and on_tick_if() callbacks. | |
| Protected Member Functions inherited from MayaFlux::Nodes::Node | |
| virtual void | reset_processed_state_internal () |
| Resets the processed state of the node directly. | |
Private Attributes | |
| double | m_value |
| double | m_saved_value {} |
| ConstantContext | m_context |
Additional Inherited Members | |
| Public Attributes inherited from MayaFlux::Nodes::Node | |
| bool | m_fire_events_during_snapshot = false |
| Internal flag controlling whether notify_tick fires during state snapshots Default: false (events don't fire during isolated buffer processing) Can be exposed in future if needed via concrete implementation in parent. | |
| std::atomic< NodeState > | m_state { NodeState::INACTIVE } |
| Atomic state flag tracking the node's processing status. | |
| std::atomic< uint32_t > | m_modulator_count { 0 } |
| Counter tracking how many other nodes are using this node as a modulator. | |
| Protected Attributes inherited from MayaFlux::Nodes::Node | |
| double | m_last_output { 0 } |
| The most recent sample value generated by this oscillator. | |
| bool | m_gpu_compatible {} |
| Flag indicating if the node supports GPU processing This flag is set by derived classes to indicate whether the node can be processed on the GPU. | |
| std::vector< float > | m_gpu_data_buffer |
| GPU data buffer for context objects. | |
| std::vector< NodeHook > | m_callbacks |
| Collection of standard callback functions. | |
| std::vector< std::pair< NodeHook, NodeCondition > > | m_conditional_callbacks |
| Collection of conditional callback functions with their predicates. | |
| bool | m_networked_node {} |
| Flag indicating if the node is part of a NodeNetwork This flag is used to disable event firing when the node is managed within a NodeNetwork, preventing redundant or conflicting event notifications. | |
| bool | m_state_saved {} |
| tracks if the node's state has been saved by a snapshot operation | |
| uint32_t | m_sample_rate { 48000 } |
| Sample rate for audio processing, used for normalization. | |
Detailed Description
Zero-overhead scalar source node that emits a fixed value on every tick.
Constant is the identity element of the node graph: it ignores all input, holds a single double, and returns it unconditionally from every processing call. No state history, no coefficient arrays, no oscillator phase — just a number in, number out.
Primary uses:
- bias a signal by a fixed amount (DC offset injection)
- Static parameter supply for parameter-mapping systems (e.g., feed a fixed
- frequency into ResonatorNetwork::map_parameter("frequency", ...))
- Push constants into GPU shader pipelines via NodeTextureBuffer
- Test fixture / mock node that stands in for any scalar source
- Sentinel value in node graphs during live-coding sessions where a real source node has not yet been wired in
The node is intentionally minimal. save_state()/restore_state() snapshot the value so that buffer snapshot cycles remain consistent. notify_tick() fires the standard callback chain so that on_tick() listeners work identically to any other node.
Definition at line 30 of file Constant.hpp.
The documentation for this class was generated from the following files:
