minor refactor for rect functions. more consistent naming.
[blender.git] / source / blender / blenlib / BLI_rect.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  *
27  */
28
29 #ifndef __BLI_RECT_H__
30 #define __BLI_RECT_H__
31
32 /** \file BLI_rect.h
33  *  \ingroup bli
34  */
35
36 struct rctf;
37 struct rcti;
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 int  BLI_rcti_is_empty(const struct rcti *rect);
44 int  BLI_rctf_is_empty(const struct rctf *rect);
45 void BLI_rctf_init(struct rctf *rect, float xmin, float xmax, float ymin, float ymax);
46 void BLI_rcti_init(struct rcti *rect, int xmin, int xmax, int ymin, int ymax);
47 void BLI_rcti_init_minmax(struct rcti *rect);
48 void BLI_rctf_init_minmax(struct rctf *rect);
49 void BLI_rcti_do_minmax_v(struct rcti *rect, const int xy[2]);
50 void BLI_rctf_do_minmax_v(struct rctf *rect, const float xy[2]);
51
52 void BLI_rctf_translate(struct rctf *rect, float x, float y);
53 void BLI_rcti_translate(struct rcti *rect, int x, int y);
54 void BLI_rcti_resize(struct rcti *rect, int x, int y);
55 void BLI_rctf_resize(struct rctf *rect, float x, float y);
56 int  BLI_in_rcti(const struct rcti *rect, const int x, const int y);
57 int  BLI_in_rcti_v(const struct rcti *rect, const int xy[2]);
58 int  BLI_in_rctf(const struct rctf *rect, const float x, const float y);
59 int  BLI_in_rctf_v(const struct rctf *rect, const float xy[2]);
60 int  BLI_rcti_isect_segment(const struct rcti *rect, const int s1[2], const int s2[2]);
61 #if 0 /* NOT NEEDED YET */
62 int  BLI_rctf_isect_segment(struct rcti *rect, int s1[2], int s2[2]);
63 #endif
64 int  BLI_rctf_isect(const struct rctf *src1, const struct rctf *src2, struct rctf *dest);
65 int  BLI_rcti_isect(const struct rcti *src1, const struct rcti *src2, struct rcti *dest);
66 void BLI_rctf_union(struct rctf *rctf1, const struct rctf *rctf2);
67 void BLI_rcti_union(struct rcti *rcti1, const struct rcti *rcti2);
68 void BLI_rcti_rctf_copy(struct rcti *tar, const struct rctf *src);
69
70 void print_rctf(const char *str, const struct rctf *rect);
71 void print_rcti(const char *str, const struct rcti *rect);
72
73 #ifdef __cplusplus
74 }
75 #endif
76
77 #endif