use 'bool' for BLI_/BKE_ functions.
[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 #include "DNA_vec_types.h"
37 #include "BLI_utildefines.h"
38
39 struct rctf;
40 struct rcti;
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 bool BLI_rcti_is_empty(const struct rcti *rect);
47 bool BLI_rctf_is_empty(const struct rctf *rect);
48 void BLI_rctf_init(struct rctf *rect, float xmin, float xmax, float ymin, float ymax);
49 void BLI_rcti_init(struct rcti *rect, int xmin, int xmax, int ymin, int ymax);
50 void BLI_rcti_init_minmax(struct rcti *rect);
51 void BLI_rctf_init_minmax(struct rctf *rect);
52 void BLI_rcti_do_minmax_v(struct rcti *rect, const int xy[2]);
53 void BLI_rctf_do_minmax_v(struct rctf *rect, const float xy[2]);
54
55 void BLI_rctf_translate(struct rctf *rect, float x, float y);
56 void BLI_rcti_translate(struct rcti *rect, int x, int y);
57 void BLI_rcti_resize(struct rcti *rect, int x, int y);
58 void BLI_rctf_resize(struct rctf *rect, float x, float y);
59 void BLI_rcti_scale(rcti *rect, const float scale);
60 void BLI_rctf_scale(rctf *rect, const float scale);
61 void BLI_rctf_interp(struct rctf *rect, const struct rctf *rect_a, const struct rctf *rect_b, const float fac);
62 //void BLI_rcti_interp(struct rctf *rect, struct rctf *rect_a, struct rctf *rect_b, float fac);
63 bool BLI_rctf_clamp_pt_v(const struct rctf *rect, float xy[2]);
64 bool BLI_rcti_clamp_pt_v(const struct rcti *rect, int xy[2]);
65 bool BLI_rctf_compare(const struct rctf *rect_a, const struct rctf *rect_b, const float limit);
66 bool BLI_rcti_compare(const struct rcti *rect_a, const struct rcti *rect_b);
67 bool BLI_rctf_isect(const struct rctf *src1, const struct rctf *src2, struct rctf *dest);
68 bool BLI_rcti_isect(const struct rcti *src1, const struct rcti *src2, struct rcti *dest);
69 bool BLI_rcti_isect_pt(const struct rcti *rect, const int x, const int y);
70 bool BLI_rcti_isect_pt_v(const struct rcti *rect, const int xy[2]);
71 bool BLI_rctf_isect_pt(const struct rctf *rect, const float x, const float y);
72 bool BLI_rctf_isect_pt_v(const struct rctf *rect, const float xy[2]);
73 bool BLI_rcti_isect_segment(const struct rcti *rect, const int s1[2], const int s2[2]);
74 bool BLI_rctf_isect_segment(const struct rctf *rect, const float s1[2], const float s2[2]);
75 void BLI_rctf_union(struct rctf *rctf1, const struct rctf *rctf2);
76 void BLI_rcti_union(struct rcti *rcti1, const struct rcti *rcti2);
77 void BLI_rcti_rctf_copy(struct rcti *dst, const struct rctf *src);
78 void BLI_rctf_rcti_copy(struct rctf *dst, const struct rcti *src);
79
80 void print_rctf(const char *str, const struct rctf *rect);
81 void print_rcti(const char *str, const struct rcti *rect);
82
83 BLI_INLINE float BLI_rcti_cent_x_fl(const struct rcti *rct) { return (float)(rct->xmin + rct->xmax) / 2.0f; }
84 BLI_INLINE float BLI_rcti_cent_y_fl(const struct rcti *rct) { return (float)(rct->ymin + rct->ymax) / 2.0f; }
85 BLI_INLINE int   BLI_rcti_cent_x(const struct rcti *rct) { return (rct->xmin + rct->xmax) / 2; }
86 BLI_INLINE int   BLI_rcti_cent_y(const struct rcti *rct) { return (rct->ymin + rct->ymax) / 2; }
87 BLI_INLINE float BLI_rctf_cent_x(const struct rctf *rct) { return (rct->xmin + rct->xmax) / 2.0f; }
88 BLI_INLINE float BLI_rctf_cent_y(const struct rctf *rct) { return (rct->ymin + rct->ymax) / 2.0f; }
89
90 BLI_INLINE int   BLI_rcti_size_x(const struct rcti *rct) { return (rct->xmax - rct->xmin); }
91 BLI_INLINE int   BLI_rcti_size_y(const struct rcti *rct) { return (rct->ymax - rct->ymin); }
92 BLI_INLINE float BLI_rctf_size_x(const struct rctf *rct) { return (rct->xmax - rct->xmin); }
93 BLI_INLINE float BLI_rctf_size_y(const struct rctf *rct) { return (rct->ymax - rct->ymin); }
94
95 #ifdef __cplusplus
96 }
97 #endif
98
99 #endif  /* __BLI_RECT_H__ */