File: PsychRects.c

package info (click to toggle)
psychtoolbox-3 3.0.19.14.dfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 86,796 kB
  • sloc: ansic: 176,245; cpp: 20,103; objc: 5,393; sh: 2,753; python: 1,397; php: 384; makefile: 193; java: 113
file content (212 lines) | stat: -rw-r--r-- 6,926 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/*
 *    PsychRects.c
 *
 *    PLATFORMS:
 *
 *      All.
 *
 *    AUTHORS:
 *
 *      Allen Ingling           awi     Allen.Ingling@nyu.edu
 *      Mario Kleiner           mk      mario.kleiner.de@gmail.com
 *
 *    HISTORY:
 *
 *      02/11/03                awi     Wrote it.
 *      01/20/09                mk      Modify behaviour of PsychGetCenterFromRectAbs(): No longer floor() the size of the rectangle
 *                                      before calculation of center: This removes information about rects with fractional locations
 *                                      for no reason. Function is currently used by FillOval, FrameOval, Frame/Fill/xxxArc(), where
 *                                      it has harmful effect on accuracy and consistency.
 *
 *    DESCRIPTION:
 *
 *      Helper to deal with common operations on rectangles.
 */

#include "Screen.h"

/*
 *    PsychMakeRect()
 *
 *    Convenience function for assembling PsychRects.  The caller alloctes the rect.
 */
void PsychMakeRect(double *psychRect, double left, double top, double right, double bottom)
{
    psychRect[kPsychLeft]=left;
    psychRect[kPsychTop]=top;
    psychRect[kPsychRight]=right;
    psychRect[kPsychBottom]=bottom;
}

/*
 *    Check that the left side is on the left and the top is on the top and
 *    the volume is >= 1 pixel.
 */
psych_bool IsPsychRectEmpty(PsychRectType rect)
{
    return((rect[kPsychLeft] == rect[kPsychRight] || rect[kPsychTop]==rect[kPsychBottom]));
}

psych_bool ValidatePsychRect(double *rect)
{
    if(rect[kPsychLeft] > rect[kPsychRight] || rect[kPsychTop]>rect[kPsychBottom])
        return(FALSE);

    return(TRUE);
}

/*
 *    PsychGetWidthFromRect()
 */
double PsychGetWidthFromRect(const double *rect)
{
    return(rect[kPsychRight]-rect[kPsychLeft]);
}

/*
 *    PsychGetHeightFromRect()
 */
double PsychGetHeightFromRect(const double *rect)
{
    return(rect[kPsychBottom]-rect[kPsychTop]);
}

/*
 *    PsychCenterRect()
 *
 *    Centers one rect within the other.  The caller should allocate memory for the return value.
 */
void PsychCenterRect(const double *innerRect, const double *outerRect, double *newRect)
{
    double leftOffset, topOffset, rightOffset, bottomOffset;

    rightOffset = innerRect[kPsychRight] - innerRect[kPsychLeft];
    bottomOffset =  innerRect[kPsychBottom] - innerRect[kPsychTop];
    leftOffset = floor(((outerRect[kPsychRight] - outerRect[kPsychLeft] ) - rightOffset)/2);
    topOffset = floor(((outerRect[kPsychBottom] - outerRect[kPsychTop] ) - bottomOffset)/2);
    newRect[kPsychRight] = newRect[kPsychLeft] + rightOffset;
    newRect[kPsychBottom] = newRect[kPsychTop] + bottomOffset;
    newRect[kPsychLeft] = outerRect[kPsychLeft] + leftOffset;
    newRect[kPsychTop] = outerRect[kPsychTop] + topOffset;
}

void PsychCenterRectInRect(const double *innerRect, const double *outerRect, double *newRect)
{
    double innerWidth, innerHeight, outerWidth, outerHeight;

    innerWidth=PsychGetWidthFromRect(innerRect);
    innerHeight=PsychGetHeightFromRect(innerRect);
    outerWidth=PsychGetWidthFromRect(outerRect);
    outerHeight=PsychGetHeightFromRect(outerRect);
    newRect[kPsychLeft]=floor((outerWidth - innerWidth) / 2.0);
    newRect[kPsychTop]=floor((outerHeight - innerHeight) / 2.0);
    newRect[kPsychRight]=newRect[kPsychLeft]+innerWidth;
    newRect[kPsychBottom]=newRect[kPsychTop]+innerHeight;
}

/*
 *    PsychGetCenterFromRectAbs()
 *
 *    For consistency in how we treat sides of an even number of pixels we should always use
 *    PsychGetCenterFromRect() when finding the center of a rect.
 *
 *    We return the result in absolute coordinates i.e. we preserve offsets from the origin
 */
void PsychGetCenterFromRectAbsolute(const double *rect, double *rectCenterX, double *rectCenterY)
{
    double rectWidth, rectHeight;

    rectWidth=PsychGetWidthFromRect(rect);
    rectHeight=PsychGetHeightFromRect(rect);
    *rectCenterX=rect[kPsychLeft] + (rectWidth/2);
    *rectCenterY=rect[kPsychTop] + (rectHeight/2);
}

void PsychCopyRect(double *toRect, const double *fromRect)
{
    memcpy(toRect, fromRect, sizeof(PsychRectType));
}

/*
 *    PsychGetManhattanDistance()
 *
 *    Find the offset between two points.  The distance to travel from point 1 to point 2.
 *
 *    The caller allocated deltaX and deltaY.
 */
void PsychGetManhattanDistance(double x1, double y1, double x2, double y2, double *deltaX, double *deltaY)
{
    *deltaX=x2-x1;
    *deltaY=y2-y1;
}

/*
 *    PsychNormalizeRect()
 *
 *    Offsets rect to the origin, making left and top coordinates 0 and 0.
 */
void PsychNormalizeRect(double *rect, double *normRect)
{
    // x
    normRect[kPsychLeft]=(double) 0;
    normRect[kPsychRight]=fabs(rect[kPsychRight]-rect[kPsychLeft]);
    // y
    normRect[kPsychTop]=(double) 0;
    normRect[kPsychBottom]=fabs(rect[kPsychBottom]-rect[kPsychTop]);
}

/*
 *    PsychInverRectYInFrame()
 *
 *    Convert the rect for and coordinate frame with an inverted Y axis.
 *
 *    Calculate rectB given rectA within frameA.  If rectA lies within coordinate frame frameA where the origin is at bottom left corner of the display, then
 *    rectB will be on the same screen position within coordinate frame frameB where the origin lies at the top left.
 *
 */
void PsychInvertRectY(double *rectB, double *rectA, double *frameA)
{
    double  frameHeight, offset;

    PsychCopyRect(rectB, rectA);
    frameHeight=PsychGetHeightFromRect(frameA);
    offset=frameHeight-PsychGetHeightFromRect(rectA);
    rectB[kPsychBottom]=frameHeight - rectA[kPsychTop] - offset;
    rectB[kPsychTop]=frameHeight - rectA[kPsychBottom] - offset;
}

psych_bool PsychMatchRect(double *rectA, double *RectB)
{
    return (rectA[kPsychLeft] == RectB[kPsychLeft] &&
            rectA[kPsychTop] == RectB[kPsychTop] &&
            rectA[kPsychRight] == RectB[kPsychRight] &&
            rectA[kPsychBottom] == RectB[kPsychBottom]);
}

/*
 *    PsychFindEnclosingTextureRect
 *
 *    Except when using the GL_EXT_texture_rectangle, OpenGL textures must be have sides which are a power of two.
 *    Therefore, when we want to hold within a texture a graphic which does not meet that requirement,  we  find the
 *    smallest bounding rectangle with sides length 2^n still large enough to contain the graphic.
 *
 *    The caller allocates enclosingRect.
 */
void PsychFindEnclosingTextureRect(double *rectA, double *enclosingRect)
{
    double              rectSides[2];
    unsigned long       newSides[2];
    int                 s;

    rectSides[0]=PsychGetWidthFromRect(rectA);
    rectSides[1]=PsychGetHeightFromRect(rectA);

    for(s = 0; s < 2; s++) {
        for(newSides[s] = 1; newSides[s] < rectSides[s]; newSides[s] = newSides[s]<<1);
    }

    enclosingRect[kPsychLeft] = 0;
    enclosingRect[kPsychTop] = 0;
    enclosingRect[kPsychRight] = (double) newSides[0];
    enclosingRect[kPsychBottom] = (double) newSides[1];
}