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

Move ContainmentMode enum to public h3api.h.in #956

Open
ajfriend opened this issue Dec 22, 2024 · 1 comment · May be fixed by #958
Open

Move ContainmentMode enum to public h3api.h.in #956

ajfriend opened this issue Dec 22, 2024 · 1 comment · May be fixed by #958

Comments

@ajfriend
Copy link
Contributor

I think we need to move the ContainmentMode enum from polygon.h to the public API in h3api.h.in:

/**
 * Values representing polyfill containment modes, to be used in
 * the `flags` bit field.
 */
typedef enum {
    CONTAINMENT_CENTER = 0,       ///< Cell center is contained in the shape
    CONTAINMENT_FULL = 1,         ///< Cell is fully contained in the shape
    CONTAINMENT_OVERLAPPING = 2,  ///< Cell overlaps the shape at any point
    CONTAINMENT_OVERLAPPING_BBOX = 3,  ///< Cell bounding box overlaps shape
    CONTAINMENT_INVALID = 4  ///< This mode is invalid and should not be used
} ContainmentMode;
@ajfriend
Copy link
Contributor Author

Should we also indicate that it is experimental in the naming?

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 a pull request may close this issue.

1 participant