USINGZ

_{Home › USINGZ}

USINGZ

#define USINGZ

Occasionally users may wish to assign user-defined data to vertices, including vertices created at path intersections during clipping operations. To facilitate this, in addition to the X and Y members in Point64 and PointD structures, the pre-processor directive USINGZ will add an int64_t Z member to these structures. (Z will only contain user-defined data, so don't confuse the additional Z member in these point structures with 3D coordinates.)

With the USINGZ directive set, users can assign user-defined data to every Point64 or PointD in both subject and clip paths, and these values will be retained if these vertices are returned in clipping solutions. Additionally, a ZCallback function can be assigned to Clipper64 and ClipperD objects that will allow users to assign user-defined Z values when new vertices are created at path intersections.

The CMake option CLIPPER2_USINGZ (ON, OFF or ONLY) controls whether the Clipper2Z library, which is compiled with USINGZ defined, is built. See the UsingZ example.

Note: USINGZ will have a small impact on performance, so the library's default is to leave this directive undefined.

See Also

Clipper64.ZCallback, ClipperD.ZCallback, Point64, PointD