Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a way to specify custom id types #234

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

giucam
Copy link

@giucam giucam commented Jun 8, 2023

NodeId, LinkId and PinId are just glorified pointers. In some cases
32/64 bits of data may not be enough to identify an object, or the
objects may lack a stable pointer/id value.
This commit adds a way to specify custom data types for them:
similarly to ImGui, a IMGUI_NODE_EDITOR_USER_CONFIG macro can be set
before including imgui_node_editor.h. If defined, its value will be
used as a filename to be included at the top of imgui_node_editor.h.

In it, the macros IMGUI_NODE_EDITOR_CUSTOM_NODEID,
IMGUI_NODE_EDITOR_CUSTOM_PINID and IMGUI_NODE_EDITOR_CUSTOM_LINKID
may be defined as the names of the types to be used for them.
If one or more of them are not defined the old types will be used,
old code does not need to be changed.

The types used must be copy contructible, assignable and must provide
a few more functions, as in this example:
struct CustomId
{
CustomId(const CustomId &id);
CustomId &operator=(const CustomId &id);;

bool operator<(const CustomId &id) const;
bool operator==(const CustomId &id) const;;

std::string AsString() const;
static CustomId FromString(const char *str, const char *end);
bool IsValid() const;

static const CustomId Invalid;

};

A new example showcasing the functionality is added.

giucam and others added 2 commits June 8, 2023 10:31
NodeId, LinkId and PinId are just glorified pointers. In some cases
32/64 bits of data may not be enough to identify an object, or the
objects may lack a stable pointer/id value.
This commit adds a way to specify custom data types for them:
similarly to ImGui, a IMGUI_NODE_EDITOR_USER_CONFIG macro can be set
before including imgui_node_editor.h. If defined, its value will be
used as a filename to be included at the top of imgui_node_editor.h.

In it, the macros IMGUI_NODE_EDITOR_CUSTOM_NODEID,
IMGUI_NODE_EDITOR_CUSTOM_PINID and IMGUI_NODE_EDITOR_CUSTOM_LINKID
may be defined as the names of the types to be used for them.
If one or more of them are not defined the old types will be used,
old code does not need to be changed.

The types used must be copy contructible, assignable and must provide
a few more functions, as in this example:
struct CustomId
{
    CustomId(const CustomId &id);
    CustomId &operator=(const CustomId &id);;

    bool operator<(const CustomId &id) const;
    bool operator==(const CustomId &id) const;;

    std::string AsString() const;
    static CustomId FromString(std::string_view str);
    bool IsValid() const;

    static const CustomId Invalid;
};

A new example showcasing the functionality is added.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant