AdjustableComponent.md

AdjustableComponent

Utility Component that provides access to "global" values that may be adjusted at runtime, e.g. by an ImGuiAdjustableManager.

Currently supported types are bool, int, float, putils::NormalizedColor and enum types.

The maximum length of the adjustable's name (stored as a putils::string) defaults to 64, and can be adjusted by defining the KENGINE_ADJUSTABLE_NAME_MAX_LENGTH macro.

Specs

• Reflectible
• Not serializable as it contains pointers, but the adjustable system you use may externally save adjustable values
• Processed by the ImGuiAdjustableSystem

Usage

static bool globalBool = false;
static int globalInt = 42;

em += [&](kengine::Entity e) {
    e += kengine::AdjustableComponent(
        "Globals", // "Category", for these adjustables to be grouped under
        { // vector of adjustables
            { "Bool name", &globalBool },
            { "Int name", &globalInt }
        }
};

// ... Later on, once adjustable system has been processed

std::cout << globalBool << std::endl; // May be true, if user modified it