Mango request: added an input node to use track's position in compositor
[blender.git] / intern / ghost / GHOST_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 /** \file ghost/intern/GHOST_Debug.h
29  *  \ingroup GHOST
30  * Macro's used in GHOST debug target.
31  */
32
33 #ifndef __GHOST_RECT_H__
34 #define __GHOST_RECT_H__
35
36 #include "GHOST_Types.h"
37
38
39 /**
40  * Implements rectangle functionality.
41  * The four extreme coordinates are stored as left, top, right and bottom.
42  * To be valid, a rectangle should have a left coordinate smaller than or equal to right.
43  * To be valid, a rectangle should have a top coordinate smaller than or equal to bottom.
44  * @author      Maarten Gribnau
45  * @date        May 10, 2001
46  */
47
48 class GHOST_Rect {
49 public:
50
51         /**
52          * Constructs a rectangle with the given values.
53          * @param       l       requested left coordinate of the rectangle
54          * @param       t       requested top coordinate of the rectangle
55          * @param       r       requested right coordinate of the rectangle
56          * @param       b       requested bottom coordinate of the rectangle
57          */
58         GHOST_Rect(GHOST_TInt32 l = 0, GHOST_TInt32 t = 0, GHOST_TInt32 r = 0, GHOST_TInt32 b = 0)
59                 : m_l(l), m_t(t), m_r(r), m_b(b)
60         {}
61
62         /**
63          * Copy constructor.
64          * @param       r       rectangle to copy
65          */
66         GHOST_Rect(const GHOST_Rect& r)
67                 : m_l(r.m_l), m_t(r.m_t), m_r(r.m_r), m_b(r.m_b)
68         {}
69         
70         /**
71          * Destructor.
72          */
73         virtual ~GHOST_Rect()
74         {};
75
76         /**
77          * Access to rectangle width.
78          * @return      width of the rectangle
79          */
80         virtual inline GHOST_TInt32 getWidth() const;
81
82         /**
83          * Access to rectangle height.
84          * @return      height of the rectangle
85          */
86         virtual inline GHOST_TInt32 getHeight() const;
87
88         /**
89          * Sets all members of the rectangle.
90          * @param       l       requested left coordinate of the rectangle
91          * @param       t       requested top coordinate of the rectangle
92          * @param       r       requested right coordinate of the rectangle
93          * @param       b       requested bottom coordinate of the rectangle
94          */
95         virtual inline void set(GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOST_TInt32 b);
96
97         /**
98          * Returns whether this rectangle is empty.
99          * Empty rectangles are rectangles that have width==0 and/or height==0.
100          * @return      boolean value (true==empty rectangle)
101          */
102         virtual inline bool isEmpty() const;
103
104         /**
105          * Returns whether this rectangle is valid.
106          * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are valid.
107          * @return      boolean value (true==valid rectangle)
108          */
109         virtual inline bool isValid() const;
110
111         /**
112          * Grows (or shrinks the rectangle).
113          * The method avoids negative insets making the rectangle invalid
114          * @param       i       The amount of offset given to each extreme (negative values shrink the rectangle).
115          */
116         virtual void inset(GHOST_TInt32 i);
117
118         /**
119          * Does a union of the rectangle given and this rectangle.
120          * The result is stored in this rectangle.
121          * @param       r       The rectangle that is input for the union operation.
122          */
123         virtual inline void unionRect(const GHOST_Rect& r);
124
125         /**
126          * Grows the rectangle to included a point.
127          * @param       x       The x-coordinate of the point.
128          * @param       y       The y-coordinate of the point.
129          */
130         virtual inline void unionPoint(GHOST_TInt32 x, GHOST_TInt32 y);
131
132         /**
133          * Grows the rectangle to included a point.
134          * @param       x       The x-coordinate of the point.
135          * @param       y       The y-coordinate of the point.
136          */
137         virtual inline void wrapPoint(GHOST_TInt32 &x, GHOST_TInt32 &y, GHOST_TInt32 ofs);
138
139         /**
140          * Returns whether the point is inside this rectangle.
141          * Point on the boundary is considered inside.
142          * @param x     x-coordinate of point to test.
143          * @param y y-coordinate of point to test.
144          * @return boolean value (true if point is inside).
145          */
146         virtual inline bool isInside(GHOST_TInt32 x, GHOST_TInt32 y) const;
147
148         /**
149          * Returns whether the rectangle is inside this rectangle.
150          * @param       r       rectangle to test.
151          * @return      visibility (not, partially or fully visible).
152          */
153         virtual GHOST_TVisibility getVisibility(GHOST_Rect& r) const;
154
155         /**
156          * Sets rectangle members.
157          * Sets rectangle members such that it is centered at the given location.
158          * @param       cx      requested center x-coordinate of the rectangle
159          * @param       cy      requested center y-coordinate of the rectangle
160          */
161         virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy);
162
163         /**
164          * Sets rectangle members.
165          * Sets rectangle members such that it is centered at the given location,
166          * with the width requested.
167          * @param       cx      requested center x-coordinate of the rectangle
168          * @param       cy      requested center y-coordinate of the rectangle
169          * @param       w       requested width of the rectangle
170          * @param       h       requested height of the rectangle
171          */
172         virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy, GHOST_TInt32 w, GHOST_TInt32 h);
173
174         /**
175          * Clips a rectangle.
176          * Updates the rectangle given such that it will fit within this one.
177          * This can result in an empty rectangle.
178          * @param       r       the rectangle to clip
179          * @return      whether clipping has occurred
180          */
181         virtual bool clip(GHOST_Rect& r) const;
182
183         /** Left coordinate of the rectangle */
184         GHOST_TInt32 m_l;
185         /** Top coordinate of the rectangle */
186         GHOST_TInt32 m_t;
187         /** Right coordinate of the rectangle */
188         GHOST_TInt32 m_r;
189         /** Bottom coordinate of the rectangle */
190         GHOST_TInt32 m_b;
191
192 #ifdef WITH_CXX_GUARDEDALLOC
193         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_Rect")
194 #endif
195 };
196
197
198 inline GHOST_TInt32 GHOST_Rect::getWidth() const
199 {
200         return m_r - m_l;
201 }
202
203 inline GHOST_TInt32 GHOST_Rect::getHeight() const
204 {
205         return m_b - m_t;
206 }
207
208 inline void GHOST_Rect::set(GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOST_TInt32 b)
209 {
210         m_l = l; m_t = t; m_r = r; m_b = b;
211 }
212
213 inline bool GHOST_Rect::isEmpty() const
214 {
215         return (getWidth() == 0) || (getHeight() == 0);
216 }
217
218 inline bool GHOST_Rect::isValid() const
219 {
220         return (m_l <= m_r) && (m_t <= m_b);
221 }
222
223 inline void GHOST_Rect::unionRect(const GHOST_Rect& r)
224 {
225         if (r.m_l < m_l) m_l = r.m_l;
226         if (r.m_r > m_r) m_r = r.m_r;
227         if (r.m_t < m_t) m_t = r.m_t;
228         if (r.m_b > m_b) m_b = r.m_b;
229 }
230
231 inline void GHOST_Rect::unionPoint(GHOST_TInt32 x, GHOST_TInt32 y)
232 {
233         if (x < m_l) m_l = x;
234         if (x > m_r) m_r = x;
235         if (y < m_t) m_t = y;
236         if (y > m_b) m_b = y;
237 }
238 #include <stdio.h>
239 inline void GHOST_Rect::wrapPoint(GHOST_TInt32 &x, GHOST_TInt32 &y, GHOST_TInt32 ofs)
240 {
241         GHOST_TInt32 w = getWidth();
242         GHOST_TInt32 h = getHeight();
243
244         /* highly unlikely but avoid eternal loop */
245         if (w - ofs * 2 <= 0 || h - ofs * 2 <= 0) {
246                 return;
247         }
248
249         while (x - ofs < m_l) x += w - (ofs * 2);
250         while (y - ofs < m_t) y += h - (ofs * 2);
251         while (x + ofs > m_r) x -= w - (ofs * 2);
252         while (y + ofs > m_b) y -= h - (ofs * 2);
253 }
254
255 inline bool GHOST_Rect::isInside(GHOST_TInt32 x, GHOST_TInt32 y) const
256 {
257         return (x >= m_l) && (x <= m_r) && (y >= m_t) && (y <= m_b);
258 }
259
260 #endif // __GHOST_RECT_H__
261