line_math.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Harry Storbacka
27 ** Magnus Norddahl
28 ** (if your name is missing here, please add it)
29 */
30
31
32 #pragma once
33
34 #include "point.h"
35
36 namespace clan
37 {
40
44 class LineMath
45 {
46 public:
47 // Operations:
48
56 static float point_right_of_line( float x, float y, float *line );
57
68 static float point_right_of_line( float x, float y, float line_x1, float line_y1, float line_x2, float line_y2 );
69
77 static float point_right_of_line( const Pointf &A, const Pointf &B, const Pointf &P );
78
86 static Pointf midpoint( const Pointf &A, const Pointf &B );
87
93 static Pointf closest_point( const Pointf &P, const Pointf &A, const Pointf &B );
94
100 static float closest_point_relative( const Pointf &P, const Pointf &A, const Pointf &B );
101 };
102
103 }
104
clan::LineMath::midpoint
static Pointf midpoint(const Pointf &A, const Pointf &B)
Return the midpoint of the line from point A to point B.
clan
Definition: clanapp.h:35
clan::LineMath::closest_point
static Pointf closest_point(const Pointf &P, const Pointf &A, const Pointf &B)
Return the Point on the line from A to B closest to point P.
clan::Key::x
clan::LineMath::closest_point_relative
static float closest_point_relative(const Pointf &P, const Pointf &A, const Pointf &B)
Return the relative position (0-1) of the point R on the line from A to B closest to point P...
clan::LineMath::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.
clan::Key::y
clan::Pointf
2D (x,y) point structure - Float
Definition: point.h:72
clan::LineMath
Math operations on 2D lines.
Definition: line_math.h:44