PathEngine home previous: cCollidingLinenext: cPosition
Contents, API Reference, Classes, cHorizontalRange

cHorizontalRange

The cHorizontalRange class definition is provided (in SDKRoot/code/externalAPI/i_pathengine.h) as follows:

class cHorizontalRange
{
public:
    int32_t minX, minY, maxX, maxY;
    bool operator==(const cHorizontalRange& rhs) const
    {
        return minX == rhs.minX && minY == rhs.minY && maxX == rhs.maxX && maxY == rhs.maxY;
    }
    bool operator!=(const cHorizontalRange& rhs) const
    {
        return !((*this) == rhs);
    }
};
        

This class is a POD (plain old data) class with no virtual methods, which was introduced to replace the four component integer data members, which were previously being passed into or out of a number of API methods.

This class is essentially an axis aligned bounding box, (or AABB) in X and Y.

Constraints

In all cases were setting up a horizontal range minX must be less than or equal to maxX and minY must be less than or equal to maxY.

In some cases, zero size regions are permitted (i.e. with minX == maxX or minY == maxY), but in other cases these kinds of regions are considered invalid, so be sure to check the specific documentation for each method before passing zero size regions.

Interop

The equivalent class in the Microsoft CLR interface (for C Sharp or Visual Basic) is PathEngine.HorizontalRange.


Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: cPosition