This is the documentation for Enlighten.

struct Geo GeoPoint2D

struct Geo::GeoPoint2D

Integer 2 dimensional point class.

Functions

Name Description
GeoPoint2D()

Constructors.

GeoPoint2D(Geo::s32, Geo::s32)

Constructors.

operator-(GeoPoint2D const &)

Component-wise subtraction (translation).

operator*(s32)

Scalar multiplication.

operator*=(s32)

Scalar multiplication.

operator/(s32)

Scalar division.

operator/=(s32)

Scalar division.

operator+(GeoPoint2D const &)

Component-wise addition (translation).

operator+=(const GeoPoint2D &)

Component-wise addition (translation).

operator<(const GeoPoint2D &)

Comparison operator, required to use this class as a key in an STL-style container.

operator-=(const GeoPoint2D &)

Component-wise subtraction (translation).

operator==(const GeoPoint2D &)

Equality operator.

Variables

Name Description
Geo::s32 X

X coordinate.

Geo::s32 Y

Y coordinate.


Geo::GeoPoint2D::GeoPoint2D


public: GeoPoint2D()


Constructors.


Geo::GeoPoint2D::GeoPoint2D


public: GeoPoint2D
(
    Geo::s32 x,
    Geo::s32 y
)


Constructors.


GeoPoint2D Geo::GeoPoint2D::operator-


public: GeoPoint2D operator-
(
    GeoPoint2D const & rhs
) const


Component-wise subtraction (translation).


GeoPoint2D Geo::GeoPoint2D::operator*


public: GeoPoint2D operator*
(
    s32 Scale
) const


Scalar multiplication.


GeoPoint2D& Geo::GeoPoint2D::operator*=


public: GeoPoint2D & operator*=
(
    s32 Scale
)


Scalar multiplication.


GeoPoint2D Geo::GeoPoint2D::operator/


public: GeoPoint2D operator/
(
    s32 Divisor
) const


Scalar division.


GeoPoint2D& Geo::GeoPoint2D::operator/=


public: GeoPoint2D & operator/=
(
    s32 Divisor
)


Scalar division.


GeoPoint2D Geo::GeoPoint2D::operator+


public: GeoPoint2D operator+
(
    GeoPoint2D const & rhs
) const


Component-wise addition (translation).


GeoPoint2D& Geo::GeoPoint2D::operator+=


public: GeoPoint2D & operator+=
(
    const GeoPoint2D & Other
)


Component-wise addition (translation).


bool Geo::GeoPoint2D::operator<


public: bool operator<
(
    const GeoPoint2D & rhs
) const


Comparison operator, required to use this class as a key in an STL-style container.


GeoPoint2D& Geo::GeoPoint2D::operator-=


public: GeoPoint2D & operator-=
(
    const GeoPoint2D & Other
)


Component-wise subtraction (translation).


bool Geo::GeoPoint2D::operator==


public: bool operator==
(
    const GeoPoint2D & rhs
) const


Equality operator.