2D line segment More...
#include <line_segment.h>
Public Member Functions | |
CL_LineSegment2x () | |
CL_LineSegment2x (const CL_Vec2< Type > &point_p, const CL_Vec2< Type > &point_q) | |
CL_LineSegment2x (const CL_LineSegment2x< Type > ©) | |
Attributes | |
CL_Vec2< Type > | get_midpoint () const |
Get the midpoint of this line. | |
Type | point_distance (const CL_Vec2< Type > &point) |
Return the distance from a point to a line. | |
bool | collinear (const CL_LineSegment2x< Type > &second) const |
Return true if two line segments are collinear. (All points are on the same line.). | |
bool | intersects (const CL_LineSegment2x< Type > &second, bool collinear_intersect) const |
Return true if two line segments intersect. | |
CL_Vec2< Type > | get_intersection (const CL_LineSegment2x< Type > &second, bool &intersect) const |
Return the intersection point of two lines. | |
Type | point_right_of_line (const CL_Vec2< Type > &point) const |
Return [<0, 0, >0] if the Point P is right, on or left of the line trough A,B. | |
CL_Vec2< Type > | normal () const |
Return the normal vector of the line from point A to point B. | |
Operations | |
CL_LineSegment2x< Type > & | clip (const CL_Rectx< Type > &rect, bool &clipped) |
Clip this line to a rectangle. | |
Operators | |
CL_LineSegment2x< Type > & | operator= (const CL_LineSegment2x< Type > ©) |
= operator. | |
bool | operator== (const CL_LineSegment2x< Type > &line) const |
== operator. | |
bool | operator!= (const CL_LineSegment2x< Type > &line) const |
!= operator. | |
Public Attributes | |
CL_Vec2< Type > | p |
Start point on the line. | |
CL_Vec2< Type > | q |
2D line segment
A line segment has a start point and an end point
These line templates are defined for: int (CL_LineSegment2i), float (CL_LineSegment2f), double (CL_LineSegment2d)
CL_LineSegment2x< Type >::CL_LineSegment2x | ( | ) | [inline] |
CL_LineSegment2x< Type >::CL_LineSegment2x | ( | const CL_LineSegment2x< Type > & | copy | ) | [inline] |
CL_LineSegment2x< Type >::CL_LineSegment2x | ( | const CL_Vec2< Type > & | point_p, | |
const CL_Vec2< Type > & | point_q | |||
) | [inline] |
CL_LineSegment2x<Type>& CL_LineSegment2x< Type >::clip | ( | const CL_Rectx< Type > & | rect, | |
bool & | clipped | |||
) |
Clip this line to a rectangle.
If clipping was not successful, this object is undefined
rect | = Rectangle to clip to | |
clipped | = On Return: true if the line could be clipped, false if line exists outside the rectangle |
bool CL_LineSegment2x< Type >::collinear | ( | const CL_LineSegment2x< Type > & | second | ) | const |
Return true if two line segments are collinear. (All points are on the same line.).
second | = The second line to check with |
CL_Vec2<Type> CL_LineSegment2x< Type >::get_intersection | ( | const CL_LineSegment2x< Type > & | second, | |
bool & | intersect | |||
) | const |
Return the intersection point of two lines.
second | = Second line. | |
intersect | = On Return: The intercept. If the lines are parallel, this contains this line's first point |
CL_Vec2<Type> CL_LineSegment2x< Type >::get_midpoint | ( | ) | const [inline] |
Get the midpoint of this line.
bool CL_LineSegment2x< Type >::intersects | ( | const CL_LineSegment2x< Type > & | second, | |
bool | collinear_intersect | |||
) | const |
Return true if two line segments intersect.
second | = Second line. | |
collinear_intersect | = true if a collision is reported when all points are on the same line. |
CL_Vec2<Type> CL_LineSegment2x< Type >::normal | ( | ) | const |
Return the normal vector of the line from point A to point B.
When using CL_Vec2i, the vector is an 8 bit fraction (multiplied by 256)
bool CL_LineSegment2x< Type >::operator!= | ( | const CL_LineSegment2x< Type > & | line | ) | const [inline] |
!= operator.
CL_LineSegment2x<Type>& CL_LineSegment2x< Type >::operator= | ( | const CL_LineSegment2x< Type > & | copy | ) | [inline] |
= operator.
bool CL_LineSegment2x< Type >::operator== | ( | const CL_LineSegment2x< Type > & | line | ) | const [inline] |
== operator.
Type CL_LineSegment2x< Type >::point_distance | ( | const CL_Vec2< Type > & | point | ) |
Return the distance from a point to a line.
point | = The point. |
Type CL_LineSegment2x< Type >::point_right_of_line | ( | const CL_Vec2< Type > & | point | ) | const [inline] |
Return [<0, 0, >0] if the Point P is right, on or left of the line trough A,B.
point | = The point |
CL_Vec2<Type> CL_LineSegment2x< Type >::p |
CL_Vec2<Type> CL_LineSegment2x< Type >::q |