dpoint2.h File Reference

#include "GeomExport.h"
#include "point2.h"
#include <cassert>
#include <iosfwd>

Classes
class	DPoint2
	Description: This class describes a 2D point using double precision x and y coordinates. More...
class	DRay2
	This class describes a vector in space using an origin point p, and a unit direction vector in double precision. More...

Functions
double	Length (const DPoint2 &p)
	Returns the 'Length' of the point.
constexpr double	LengthSquared (const DPoint2 &p)
	The 'Length' squared of this point.
int	MaxComponent (const DPoint2 &p)
	Returns the component with the maximum absolute value.
int	MinComponent (const DPoint2 &p)
	Returns the component with the minimum absolute value.
DPoint2	Normalize (const DPoint2 &p)
	Returns a unit vector.
constexpr double	DotProd (const DPoint2 &a, const DPoint2 &b)
	Returns the dot product of two DPoint2s.
constexpr DPoint2	operator* (const DPoint2 &a, double f)
	Multiply a DPoint2 by a scalar.
constexpr DPoint2	operator* (double f, const DPoint2 &a)
constexpr DPoint2	operator+ (const DPoint2 &a, double f)
constexpr DPoint2	operator+ (double f, const DPoint2 &a)
constexpr DPoint2	operator- (const DPoint2 &a, float f)
DPoint2	operator/ (const DPoint2 &a, double f)
	Divide a DPoint2 by a scalar.
constexpr Point2	Point2FromDPoint2 (const DPoint2 &from)
int	DoublePrecisionLineSegmentIntersection (const DPoint2 &seg1Start, const DPoint2 &seg1End, const DPoint2 &seg2Start, const DPoint2 &seg2End, DPoint2 &intersectPoint)
	Double-Precision Line Segment Intersection test.
int	DoublePrecisionLineIntersection (const DPoint2 &line1PointA, const DPoint2 &line1PointB, const DPoint2 &line2PointA, const DPoint2 &line2PointB, DPoint2 &intersectPoint)
	Double-Precision Line Intersection test.

Function Documentation

Length()

double Length ( const DPoint2 &  p )

inline

Returns the 'Length' of the point.

This is sqrt(v.x*v.x+v.y*v.y)

Parameters

p	the DPoint2 to test

Returns

the length value

{
    return p.Length();
}

LengthSquared()

constexpr double LengthSquared ( const DPoint2 &  p )

constexpr

The 'Length' squared of this point.

This is v.x*v.x+v.y*v.y.

Parameters

p	the DPoint2 to test

Returns

the length value

{
    return p.LengthSquared();
}

MaxComponent()

int MaxComponent ( const DPoint2 &  p )

inline

Returns the component with the maximum absolute value.

Parameters

p	the DPoint2 to test

Returns

the maximum component (0=x, 1=y).

{
    return p.MaxComponent();
}

MinComponent()

int MinComponent ( const DPoint2 &  p )

inline

Returns the component with the minimum absolute value.

0=x, 1=y.

Parameters

p	the DPoint2 to test

Returns

the minimum component (0=x, 1=y).

{
    return p.MinComponent();
}

Normalize()

DPoint2 Normalize ( const DPoint2 &  p )

inline

Returns a unit vector.

This is a DPoint2 with each component divided by the point Length().

Parameters

p	the DPoint2 to test

Returns

the unit vector for the specified DPoint2

{
    return p.Normalize();
}

DotProd()

constexpr double DotProd ( const DPoint2 &  a, const DPoint2 &  b  )

constexpr

Returns the dot product of two DPoint2s.

{
    return a % b;
}

operator*() [1/2]

constexpr DPoint2 operator* ( const DPoint2 &  a, double  f  )

constexpr

Multiply a DPoint2 by a scalar.

Parameters

a	the DPoint2
f	the multiplier

Returns

the resulting DPoint2

{
    return DPoint2(a.x * f, a.y * f);
}

operator*() [2/2]

constexpr DPoint2 operator* ( double  f, const DPoint2 &  a  )

constexpr

{
    return a * f;
}

operator+() [1/2]

constexpr DPoint2 operator+ ( const DPoint2 &  a, double  f  )

constexpr

Remarks

Returns a copy of the DPoint2 argument offset by (f, f).

{
    return DPoint2(a.x + f, a.y + f);
}

operator+() [2/2]

constexpr DPoint2 operator+ ( double  f, const DPoint2 &  a  )

constexpr

{
    return a + f;
}

operator-()

constexpr DPoint2 operator- ( const DPoint2 &  a, float  f  )

constexpr

Remarks

Returns a copy of the DPoint2 argument offset by (-f, -f).

{
    return a + -f;
}

operator/()

DPoint2 operator/ ( const DPoint2 &  a, double  f  )

inline

Divide a DPoint2 by a scalar.

Parameters

a	the DPoint2
f	the divisor

Returns

the resulting DPoint2

{
    assert(f != 0.0);
    return a * (1.0 / f);
}

Point2FromDPoint2()

constexpr Point2 Point2FromDPoint2 ( const DPoint2 &  from )

constexpr

{
    return Point2(from.x, from.y);
}

DoublePrecisionLineSegmentIntersection()

int DoublePrecisionLineSegmentIntersection	(	const DPoint2 &	seg1Start,
		const DPoint2 &	seg1End,
		const DPoint2 &	seg2Start,
		const DPoint2 &	seg2End,
		DPoint2 &	intersectPoint
	)

Double-Precision Line Segment Intersection test.

Determines if two line segments intersect.

Parameters

seg1Start	endpoint 1 for the first line segment
seg1End	endpoint 2 for the first line segment
seg2Start	endpoint 1 for the second line segment
seg2End	endpoint 2 for the second line segment
intersectPoint	if the lines intersect, this will return the intersection point.

Returns

Intersection determination (0: No intersection, 1: Lines intersect (intersection location in 'intersectPoint'), 2: Lines parallel (no intersection))

DoublePrecisionLineIntersection()

int DoublePrecisionLineIntersection	(	const DPoint2 &	line1PointA,
		const DPoint2 &	line1PointB,
		const DPoint2 &	line2PointA,
		const DPoint2 &	line2PointB,
		DPoint2 &	intersectPoint
	)

Double-Precision Line Intersection test.

Determines if two infinite lines cross, and if so, where.

Parameters

line1PointA	point 1 on the first line
line1PointB	point 2 on the first line
line2PointA	point 1 on the second line
line2PointB	point 2 on the second line
intersectPoint	if the lines intersect, this will return the intersection point.

Returns

Intersection determination (0: Lines parallel, 1: Lines intersect (intersection location in 'intersectPoint'))