rigImGui 0.1.1
RigKit pack API - rigImGui
Loading...
Searching...
No Matches
rigkit::ScenePropPatchRequest Struct Reference

Queued "patch this prop into the Node Editor" request. More...

#include <rigImGui/src/PropEditors.h>

Public Attributes

std::string sourceType
 Catalog node wired into the ref (mod.audio, ...). Empty keeps withLfo.
std::string sourcePin
 Output pin on sourceType (level, bass, ...). Empty means out.
bool hasMapRange = false
 When set, the Map in front of the ref uses this output range (the knob's slider limits).
bool unpatch = false
 Remove the ref driving this property (and a Map / LFO that only fed it).
const void * ecsTag = nullptr
 Owning ECS (opaque, see RigScenePropPayload::ecsTag).
uint32_t reuseLfo = 0
 Existing mod.lfo to wire instead of spawning one.

Detailed Description

Queued "patch this prop into the Node Editor" request.

Emitted by the right-click menu on prop drag pins (offerScenePropDrag) as a zero-drag alternative to drag-drop. The Node Editor drains the queue once per frame via takeScenePropPatchRequests and spawns the matching ref.* node (plus a wired LFO when withLfo is set, matching Alt+drop, or the catalog node in sourceType / sourcePin. Sound uses mod.audio). An LFO goes through a Map: input is the LFO span, output is the slider range.

Member Data Documentation

◆ ecsTag

const void* rigkit::ScenePropPatchRequest::ecsTag = nullptr

Owning ECS (opaque, see RigScenePropPayload::ecsTag).

Routes the request to the editor bound to that ECS; null = any editor.

◆ hasMapRange

bool rigkit::ScenePropPatchRequest::hasMapRange = false

When set, the Map in front of the ref uses this output range (the knob's slider limits).

Sound leaves the Map input at 0..1. An LFO patch sets the input from that LFO's span (offset plus or minus amplitude).

◆ reuseLfo

uint32_t rigkit::ScenePropPatchRequest::reuseLfo = 0

Existing mod.lfo to wire instead of spawning one.

0 spawns a new LFO. Ignored unless withLfo is set. The id belongs to ecsTag's graph.


The documentation for this struct was generated from the following file: