Static Public Member Functions

CL_LineMath Class Reference
[clanCore Math]

Math operations on 2D lines. More...

#include <line_math.h>

List of all members.

Static Public Member Functions

static CL_Pointf closest_point (const CL_Pointf &P, const CL_Pointf &A, const CL_Pointf &B)
 Return the Point on the line from A to B closest to point P.
static float closest_point_relative (const CL_Pointf &P, const CL_Pointf &A, const CL_Pointf &B)
 Return the relative position (0-1) of the point R on the line from A to B closest to point P.
static CL_Pointf midpoint (const CL_Pointf &A, const CL_Pointf &B)
 Return the midpoint of the line from point A to point B.
static float point_right_of_line (float x, float y, float line_x1, float line_y1, float line_x2, float line_y2)
 Point right of line.
static float point_right_of_line (const CL_Pointf &A, const CL_Pointf &B, const CL_Pointf &P)
 Point right of line.
static float point_right_of_line (float x, float y, float *line)
 Return [<0, 0, >0] if the Point P is right, on or left of the line trough A,B.

Detailed Description

Math operations on 2D lines.

Obsolete - Use CL_Line, CL_LineRay, CL_LineSegment


Member Function Documentation

static CL_Pointf CL_LineMath::closest_point ( const CL_Pointf P,
const CL_Pointf A,
const CL_Pointf B 
) [static]

Return the Point on the line from A to B closest to point P.

Parameters:
P point P
A point A
B point B
static float CL_LineMath::closest_point_relative ( const CL_Pointf P,
const CL_Pointf A,
const CL_Pointf B 
) [static]

Return the relative position (0-1) of the point R on the line from A to B closest to point P.

Parameters:
P point P
A point A
B point B
static CL_Pointf CL_LineMath::midpoint ( const CL_Pointf A,
const CL_Pointf B 
) [static]

Return the midpoint of the line from point A to point B.

Also See CL_LineSegment

Parameters:
A = point A
B = point B
Returns:
The point
static float CL_LineMath::point_right_of_line ( float  x,
float  y,
float  line_x1,
float  line_y1,
float  line_x2,
float  line_y2 
) [static]

Point right of line.

Parameters:
x = value
y = value
line_x1 = value
line_y1 = value
line_x2 = value
line_y2 = value
Returns:
float
static float CL_LineMath::point_right_of_line ( const CL_Pointf A,
const CL_Pointf B,
const CL_Pointf P 
) [static]

Point right of line.

Parameters:
A = Pointf
B = Pointf
P = Pointf
Returns:
float
static float CL_LineMath::point_right_of_line ( float  x,
float  y,
float *  line 
) [static]

Return [<0, 0, >0] if the Point P is right, on or left of the line trough A,B.

Also See CL_Line and CL_LineSegment

Parameters:
x = x coordinate of the point being tested.
y = y coordinate of the point being tested.
line = The line. A pointer to a float array with the elements {x1,y1,x2,y2}.

The documentation for this class was generated from the following file: