pygame: docs/ref/Rect.html annotate

annotate docs/ref/Rect.html @ 457:c7745825439b

trunc fix

author	pygame
date	Mon, 12 May 2003 14:54:13 +0000
parents	f4e6726b7d1d
children	4c398dd9d49b

rev	line source
16 790be231ba1a documentation boost pygame parents: diff changeset	1 <html>
790be231ba1a documentation boost pygame parents: diff changeset	2 <title>Rect</title>
235 74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	3 <body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	4
16 790be231ba1a documentation boost pygame parents: diff changeset	5
235 74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	6 <table cellspacing=3 width=100%><tr><td bgcolor=#00000>
74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	7 <table width=100%><tr><td bgcolor=c2fc20 align=center>
74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	8 <a href=http://www.pygame.org>
250 d001d5979095 ready for 1.2 release pygame parents: 249 diff changeset	9 <img src=../pygame_tiny.gif border=0 width=200 height=60></a><br>
235 74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	10 <b>pygame   documentation</b>
74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	11 </td><td bgcolor=6aee28 align=center valign=top width=100%>
16 790be231ba1a documentation boost pygame parents: diff changeset	12
790be231ba1a documentation boost pygame parents: diff changeset	13 \|\|
178 efa429ee9486 updated url pygame parents: 151 diff changeset	14 <a href=http://www.pygame.org>Home</a>  \|\|
16 790be231ba1a documentation boost pygame parents: diff changeset	15 <a href=../index.html>Help Contents</a>  \|\|
790be231ba1a documentation boost pygame parents: diff changeset	16 <br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	17
384 f4e6726b7d1d docs updates pygame parents: 375 diff changeset	18 \|\| <a href=pygame.html>pygame</a> \|\|
265 478a437afa69 documentation updates pygame parents: 264 diff changeset	19 <a href=pygame_cdrom.html>cdrom</a> \|\|
478a437afa69 documentation updates pygame parents: 264 diff changeset	20 <a href=pygame_constants.html>constants</a> \|\|
478a437afa69 documentation updates pygame parents: 264 diff changeset	21 <a href=pygame_display.html>display</a> \|\|
384 f4e6726b7d1d docs updates pygame parents: 375 diff changeset	22 <a href=pygame_draw.html>draw</a> \|\|
f4e6726b7d1d docs updates pygame parents: 375 diff changeset	23 <a href=pygame_event.html>event</a> \|\|<br>
f4e6726b7d1d docs updates pygame parents: 375 diff changeset	24 \|\| <a href=pygame_font.html>font</a> \|\|
265 478a437afa69 documentation updates pygame parents: 264 diff changeset	25 <a href=pygame_image.html>image</a> \|\|
478a437afa69 documentation updates pygame parents: 264 diff changeset	26 <a href=pygame_joystick.html>joystick</a> \|\|
478a437afa69 documentation updates pygame parents: 264 diff changeset	27 <a href=pygame_key.html>key</a> \|\|
384 f4e6726b7d1d docs updates pygame parents: 375 diff changeset	28 <a href=pygame_mixer.html>mixer</a> \|\|
f4e6726b7d1d docs updates pygame parents: 375 diff changeset	29 <a href=pygame_mixer_music.html>mixer_music</a> \|\|<br>
f4e6726b7d1d docs updates pygame parents: 375 diff changeset	30 \|\| <a href=pygame_mouse.html>mouse</a> \|\|
265 478a437afa69 documentation updates pygame parents: 264 diff changeset	31 <a href=pygame_movie.html>movie</a> \|\|
370 14d423681804 new gl attributes pygame parents: 364 diff changeset	32 <a href=pygame_sndarray.html>sndarray</a> \|\|
265 478a437afa69 documentation updates pygame parents: 264 diff changeset	33 <a href=pygame_surfarray.html>surfarray</a> \|\|
384 f4e6726b7d1d docs updates pygame parents: 375 diff changeset	34 <a href=pygame_time.html>time</a> \|\|
f4e6726b7d1d docs updates pygame parents: 375 diff changeset	35 <a href=pygame_transform.html>transform</a> \|\|<br>
265 478a437afa69 documentation updates pygame parents: 264 diff changeset	36  <br>\|\| <a href=CD.html>CD</a> \|\|
16 790be231ba1a documentation boost pygame parents: diff changeset	37 <a href=Channel.html>Channel</a> \|\|
277 4116bd435131 big updates for pygame.time pygame parents: 274 diff changeset	38 <a href=Clock.html>Clock</a> \|\|
16 790be231ba1a documentation boost pygame parents: diff changeset	39 <a href=Font.html>Font</a> \|\|
790be231ba1a documentation boost pygame parents: diff changeset	40 <a href=Joystick.html>Joystick</a> \|\|
277 4116bd435131 big updates for pygame.time pygame parents: 274 diff changeset	41 <a href=Movie.html>Movie</a> \|\|<br>
4116bd435131 big updates for pygame.time pygame parents: 274 diff changeset	42 \|\| <a href=Rect.html>Rect</a> \|\|
4116bd435131 big updates for pygame.time pygame parents: 274 diff changeset	43 <a href=Sound.html>Sound</a> \|\|
265 478a437afa69 documentation updates pygame parents: 264 diff changeset	44 <a href=Surface.html>Surface</a> \|\|<br>
299 954940c4bbaa userrect removal pygame parents: 277 diff changeset	45  <br>\|\| <a href=pygame_cursors.html>cursors</a> \|\|
375 841ce59c200a music.play start time works pygame parents: 372 diff changeset	46 <a href=pygame_sprite.html>sprite</a> \|\|<br>
16 790be231ba1a documentation boost pygame parents: diff changeset	47
790be231ba1a documentation boost pygame parents: diff changeset	48
235 74eafc13dbab new doc color scheme and logos pygame parents: 204 diff changeset	49 </td></tr></table></td></tr></table>
16 790be231ba1a documentation boost pygame parents: diff changeset	50 <br>
790be231ba1a documentation boost pygame parents: diff changeset	51 <h2 align=center>Rect</h2>
790be231ba1a documentation boost pygame parents: diff changeset	52 The rectangle object is a useful object
20 bc9568c8ed62 no message pygame parents: 16 diff changeset	53 representing a rectangle area. Rectangles are
151 638c600d92c7 documentation enhancements pygame parents: 148 diff changeset	54 created from the <a href=pygame.html#Rect>pygame.Rect()</a> function. This routine
20 bc9568c8ed62 no message pygame parents: 16 diff changeset	55 is also in the locals module, so importing the locals
151 638c600d92c7 documentation enhancements pygame parents: 148 diff changeset	56 into your namespace allows you to just use <a href=pygame.html#Rect>Rect()</a>.
638c600d92c7 documentation enhancements pygame parents: 148 diff changeset	57 <br> <br>
20 bc9568c8ed62 no message pygame parents: 16 diff changeset	58 Rect contains helpful methods, as well as a list of
bc9568c8ed62 no message pygame parents: 16 diff changeset	59 modifiable members:
16 790be231ba1a documentation boost pygame parents: diff changeset	60 top, bottom, left, right, topleft, topright,
790be231ba1a documentation boost pygame parents: diff changeset	61 bottomleft, bottomright, size, width, height,
182 8d83fca24ce3 rect updates pygame parents: 178 diff changeset	62 center, centerx, centery, midleft, midright, midtop,
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	63 midbottom. When changing thesemembers, the rectangle
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	64 will be moved to the given assignment. (except when
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	65 changing the size, width, or height member, which will
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	66 resize the rectangle from the topleft corner)
151 638c600d92c7 documentation enhancements pygame parents: 148 diff changeset	67 <br> <br>
16 790be231ba1a documentation boost pygame parents: diff changeset	68 The rectstyle arguments used frequently with the
29 ae12316035a9 default font added, all color args changed to RGBA pygame parents: 22 diff changeset	69 Rect object (and elsewhere in pygame) is one of
16 790be231ba1a documentation boost pygame parents: diff changeset	70 the following things. First, an actual Rect
790be231ba1a documentation boost pygame parents: diff changeset	71 object. Second, a sequence of [xpos, ypos, width,
790be231ba1a documentation boost pygame parents: diff changeset	72 height]. Lastly, a pair of sequences, representing
790be231ba1a documentation boost pygame parents: diff changeset	73 the position and size [[xpos, ypos], [width,
790be231ba1a documentation boost pygame parents: diff changeset	74 height]]. Also, if a method takes a rectstyle
790be231ba1a documentation boost pygame parents: diff changeset	75 argument as its only argument, you can simply pass
790be231ba1a documentation boost pygame parents: diff changeset	76 four arguments representing xpos, ypos, width,
364 bf3a151c0349 tuned sprites a little pygame parents: 363 diff changeset	77 height. A rectstyle argument can also be _any_ python
bf3a151c0349 tuned sprites a little pygame parents: 363 diff changeset	78 object with an attribute named 'rect'.
16 790be231ba1a documentation boost pygame parents: diff changeset	79
790be231ba1a documentation boost pygame parents: diff changeset	80 <hr>
790be231ba1a documentation boost pygame parents: diff changeset	81
790be231ba1a documentation boost pygame parents: diff changeset	82 <table>
790be231ba1a documentation boost pygame parents: diff changeset	83 <tr><td><a href=#clamp>clamp</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	84 move rectangle inside another</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	85
790be231ba1a documentation boost pygame parents: diff changeset	86
255 25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	87 <tr><td><a href=#clamp_ip>clamp_ip</a></td><td> -
274 464acd6ad506 added sprite.Group.update() pygame parents: 272 diff changeset	88 moves the rectangle inside another</td></tr>
255 25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	89
25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	90
16 790be231ba1a documentation boost pygame parents: diff changeset	91 <tr><td><a href=#clip>clip</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	92 rectangle cropped inside another</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	93
790be231ba1a documentation boost pygame parents: diff changeset	94
362 82f1312835c9 rect enhancements pygame parents: 359 diff changeset	95 <tr><td><a href=#collidedict>collidedict</a></td><td> -
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	96 find overlapping rectangle in a dictionary</td></tr>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	97
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	98
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	99 <tr><td><a href=#collidedictall>collidedictall</a></td><td> -
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	100 find all overlapping rectangles</td></tr>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	101
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	102
42 a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	103 <tr><td><a href=#collidelist>collidelist</a></td><td> -
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	104 find overlapping rectangle</td></tr>
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	105
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	106
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	107 <tr><td><a href=#collidelistall>collidelistall</a></td><td> -
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	108 find all overlapping rectangles</td></tr>
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	109
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	110
16 790be231ba1a documentation boost pygame parents: diff changeset	111 <tr><td><a href=#collidepoint>collidepoint</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	112 point inside rectangle</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	113
790be231ba1a documentation boost pygame parents: diff changeset	114
790be231ba1a documentation boost pygame parents: diff changeset	115 <tr><td><a href=#colliderect>colliderect</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	116 check overlapping rectangles</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	117
790be231ba1a documentation boost pygame parents: diff changeset	118
790be231ba1a documentation boost pygame parents: diff changeset	119 <tr><td><a href=#contains>contains</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	120 check if rectangle fully inside another</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	121
790be231ba1a documentation boost pygame parents: diff changeset	122
790be231ba1a documentation boost pygame parents: diff changeset	123 <tr><td><a href=#inflate>inflate</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	124 new rectangle with size changed</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	125
790be231ba1a documentation boost pygame parents: diff changeset	126
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	127 <tr><td><a href=#inflate_ip>inflate_ip</a></td><td> -
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	128 changes the Rect size</td></tr>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	129
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	130
16 790be231ba1a documentation boost pygame parents: diff changeset	131 <tr><td><a href=#move>move</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	132 new rectangle with position changed</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	133
790be231ba1a documentation boost pygame parents: diff changeset	134
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	135 <tr><td><a href=#move_ip>move_ip</a></td><td> -
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	136 move the Rect by the given offset</td></tr>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	137
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	138
16 790be231ba1a documentation boost pygame parents: diff changeset	139 <tr><td><a href=#normalize>normalize</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	140 corrects negative sizes</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	141
790be231ba1a documentation boost pygame parents: diff changeset	142
790be231ba1a documentation boost pygame parents: diff changeset	143 <tr><td><a href=#union>union</a></td><td> -
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	144 makes new rectangle covering both inputs</td></tr>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	145
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	146
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	147 <tr><td><a href=#union_ip>union_ip</a></td><td> -
16 790be231ba1a documentation boost pygame parents: diff changeset	148 rectangle covering both input</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	149
790be231ba1a documentation boost pygame parents: diff changeset	150
182 8d83fca24ce3 rect updates pygame parents: 178 diff changeset	151 <tr><td><a href=#unionall>unionall</a></td><td> -
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	152 rectangle covering all inputs</td></tr>
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	153
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	154
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	155 <tr><td><a href=#unionall_ip>unionall_ip</a></td><td> -
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	156 rectangle covering all inputs</td></tr>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	157
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	158
16 790be231ba1a documentation boost pygame parents: diff changeset	159 </table>
790be231ba1a documentation boost pygame parents: diff changeset	160
790be231ba1a documentation boost pygame parents: diff changeset	161 <hr>
790be231ba1a documentation boost pygame parents: diff changeset	162
790be231ba1a documentation boost pygame parents: diff changeset	163 <a name=clamp><font size=+2><b>clamp
790be231ba1a documentation boost pygame parents: diff changeset	164 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	165 Rect.clamp(rectstyle) -> Rect
790be231ba1a documentation boost pygame parents: diff changeset	166 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	167 Returns a new rectangle that is moved to be
310 62aa64a407ab unit test and rect fixes pygame parents: 299 diff changeset	168 completely inside the argument rectangle. If the base
62aa64a407ab unit test and rect fixes pygame parents: 299 diff changeset	169 rectangle is too large for the argument rectangle in
16 790be231ba1a documentation boost pygame parents: diff changeset	170 an axis, it will be centered on that axis.
790be231ba1a documentation boost pygame parents: diff changeset	171 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	172
255 25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	173 <a name=clamp_ip><font size=+2><b>clamp_ip
25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	174 </b></font><br><font size=+1><tt>
25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	175 Rect.clamp_ip(rectstyle) -> None
25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	176 </tt></font><ul>
25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	177 Moves the Rect to be
310 62aa64a407ab unit test and rect fixes pygame parents: 299 diff changeset	178 completely inside the argument rectangle. If the given
62aa64a407ab unit test and rect fixes pygame parents: 299 diff changeset	179 rectangle is too large for the argument rectangle in
255 25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	180 an axis, it will be centered on that axis.
25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	181 </ul><br> <br>
25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	182
16 790be231ba1a documentation boost pygame parents: diff changeset	183 <a name=clip><font size=+2><b>clip
790be231ba1a documentation boost pygame parents: diff changeset	184 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	185 Rect.clip(rectstyle) -> Rect
790be231ba1a documentation boost pygame parents: diff changeset	186 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	187 Returns a new rectangle that is the given
790be231ba1a documentation boost pygame parents: diff changeset	188 rectangle cropped to the inside of the base
790be231ba1a documentation boost pygame parents: diff changeset	189 rectangle. If the two rectangles do not overlap to
790be231ba1a documentation boost pygame parents: diff changeset	190 begin with, you will get a rectangle with 0 size.
790be231ba1a documentation boost pygame parents: diff changeset	191 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	192
362 82f1312835c9 rect enhancements pygame parents: 359 diff changeset	193 <a name=collidedict><font size=+2><b>collidedict
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	194 </b></font><br><font size=+1><tt>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	195 Rect.collidedict(dict if rectstyle keys) -> key/value pair
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	196 </tt></font><ul>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	197 Returns the key/value pair of the first rectangle key
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	198 in the dict that overlaps the base rectangle. Once an
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	199 overlap is found, this will stop checking the
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	200 remaining list. If no overlap is found, it will
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	201 return None.
363 a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	202 <br> <br>
a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	203 Remember python dictionary keys must be immutable,
a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	204 Rects are not immutable, so they cannot directly be,
a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	205 dictionary keys. You can convert the Rect to a tuple
384 f4e6726b7d1d docs updates pygame parents: 375 diff changeset	206 with the tuple() builtin command.
362 82f1312835c9 rect enhancements pygame parents: 359 diff changeset	207 </ul><br> <br>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	208
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	209 <a name=collidedictall><font size=+2><b>collidedictall
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	210 </b></font><br><font size=+1><tt>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	211 Rect.collidedictall(rectstyle list) -> key/val list
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	212 </tt></font><ul>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	213 Returns a list of the indexes that contain
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	214 rectangles overlapping the base rectangle. If no
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	215 overlap is found, it will return an empty
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	216 sequence.
363 a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	217 <br> <br>
a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	218 Remember python dictionary keys must be immutable,
a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	219 Rects are not immutable, so they cannot directly be,
a5aeb6f96394 tuned sprites a little pygame parents: 362 diff changeset	220 dictionary keys. You can convert the Rect to a tuple
384 f4e6726b7d1d docs updates pygame parents: 375 diff changeset	221 with the tuple() builtin command.
362 82f1312835c9 rect enhancements pygame parents: 359 diff changeset	222 </ul><br> <br>
82f1312835c9 rect enhancements pygame parents: 359 diff changeset	223
42 a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	224 <a name=collidelist><font size=+2><b>collidelist
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	225 </b></font><br><font size=+1><tt>
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	226 Rect.collidelist(rectstyle list) -> int index
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	227 </tt></font><ul>
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	228 Returns the index of the first rectangle in the
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	229 list to overlap the base rectangle. Once an
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	230 overlap is found, this will stop checking the
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	231 remaining list. If no overlap is found, it will
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	232 return -1.
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	233 </ul><br> <br>
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	234
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	235 <a name=collidelistall><font size=+2><b>collidelistall
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	236 </b></font><br><font size=+1><tt>
362 82f1312835c9 rect enhancements pygame parents: 359 diff changeset	237 Rect.collidelistall(rectstyle list) -> index list
42 a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	238 </tt></font><ul>
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	239 Returns a list of the indexes that contain
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	240 rectangles overlapping the base rectangle. If no
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	241 overlap is found, it will return an empty
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	242 sequence.
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	243 </ul><br> <br>
a072db70e063 0.4 release candidate pygame parents: 29 diff changeset	244
16 790be231ba1a documentation boost pygame parents: diff changeset	245 <a name=collidepoint><font size=+2><b>collidepoint
790be231ba1a documentation boost pygame parents: diff changeset	246 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	247 Rect.collidepoint(x, y) -> bool
790be231ba1a documentation boost pygame parents: diff changeset	248 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	249 Returns true if the given point position is inside
790be231ba1a documentation boost pygame parents: diff changeset	250 the rectangle. If a point is on the border, it is
790be231ba1a documentation boost pygame parents: diff changeset	251 counted as inside.
790be231ba1a documentation boost pygame parents: diff changeset	252 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	253
790be231ba1a documentation boost pygame parents: diff changeset	254 <a name=colliderect><font size=+2><b>colliderect
790be231ba1a documentation boost pygame parents: diff changeset	255 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	256 Rect.colliderect(rectstyle) -> bool
790be231ba1a documentation boost pygame parents: diff changeset	257 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	258 Returns true if any area of the two rectangles
66 b73167268414 new version module pygame parents: 42 diff changeset	259 overlaps.
16 790be231ba1a documentation boost pygame parents: diff changeset	260 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	261
790be231ba1a documentation boost pygame parents: diff changeset	262 <a name=contains><font size=+2><b>contains
790be231ba1a documentation boost pygame parents: diff changeset	263 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	264 Rect.contains(rectstyle) -> bool
790be231ba1a documentation boost pygame parents: diff changeset	265 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	266 Returns true when the given rectangle is entirely
790be231ba1a documentation boost pygame parents: diff changeset	267 inside the base rectangle.
790be231ba1a documentation boost pygame parents: diff changeset	268 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	269
790be231ba1a documentation boost pygame parents: diff changeset	270 <a name=inflate><font size=+2><b>inflate
790be231ba1a documentation boost pygame parents: diff changeset	271 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	272 Rect.inflate(x, y) -> Rect
790be231ba1a documentation boost pygame parents: diff changeset	273 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	274 Returns a new rectangle which has the sizes
790be231ba1a documentation boost pygame parents: diff changeset	275 changed by the given amounts. The rectangle
790be231ba1a documentation boost pygame parents: diff changeset	276 shrinks and expands around the rectangle's center.
790be231ba1a documentation boost pygame parents: diff changeset	277 Negative values will shrink the rectangle.
790be231ba1a documentation boost pygame parents: diff changeset	278 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	279
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	280 <a name=inflate_ip><font size=+2><b>inflate_ip
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	281 </b></font><br><font size=+1><tt>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	282 Rect.inflate_ip(x, y) -> None
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	283 </tt></font><ul>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	284 Changes the Rect by the given amounts. The rectangle
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	285 shrinks and expands around the rectangle's center.
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	286 Negative values will shrink the rectangle.
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	287 </ul><br> <br>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	288
16 790be231ba1a documentation boost pygame parents: diff changeset	289 <a name=move><font size=+2><b>move
790be231ba1a documentation boost pygame parents: diff changeset	290 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	291 Rect.move(x, y) -> Rect
790be231ba1a documentation boost pygame parents: diff changeset	292 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	293 Returns a new rectangle which is the base
790be231ba1a documentation boost pygame parents: diff changeset	294 rectangle moved by the given amount.
790be231ba1a documentation boost pygame parents: diff changeset	295 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	296
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	297 <a name=move_ip><font size=+2><b>move_ip
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	298 </b></font><br><font size=+1><tt>
249 c4e03b79abf9 rect docs fixed pygame parents: 238 diff changeset	299 Rect.move_ip(x, y) -> None
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	300 </tt></font><ul>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	301 Moves the rectangle which by the given amount.
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	302 </ul><br> <br>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	303
16 790be231ba1a documentation boost pygame parents: diff changeset	304 <a name=normalize><font size=+2><b>normalize
790be231ba1a documentation boost pygame parents: diff changeset	305 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	306 Rect.normalize() -> None
790be231ba1a documentation boost pygame parents: diff changeset	307 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	308 If the rectangle has a a negative size in width or
790be231ba1a documentation boost pygame parents: diff changeset	309 height, this will flip that axis so the sizes are
790be231ba1a documentation boost pygame parents: diff changeset	310 positive, and the rectangle remains in the same
790be231ba1a documentation boost pygame parents: diff changeset	311 place.
790be231ba1a documentation boost pygame parents: diff changeset	312 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	313
790be231ba1a documentation boost pygame parents: diff changeset	314 <a name=union><font size=+2><b>union
790be231ba1a documentation boost pygame parents: diff changeset	315 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	316 Rect.union(rectstyle) -> Rect
790be231ba1a documentation boost pygame parents: diff changeset	317 </tt></font><ul>
351 24f9f356f2c6 docs cleaned pygame parents: 310 diff changeset	318 Returns a new Rect to completely cover the
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	319 given input. There may be area inside the new
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	320 Rect that is not covered by either input.
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	321 </ul><br> <br>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	322
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	323 <a name=union_ip><font size=+2><b>union_ip
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	324 </b></font><br><font size=+1><tt>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	325 Rect.union_ip(rectstyle) -> None
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	326 </tt></font><ul>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	327 Resizes the Rect to completely cover the
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	328 given input. There may be area inside the new
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	329 dimensions that is not covered by either input.
16 790be231ba1a documentation boost pygame parents: diff changeset	330 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	331
182 8d83fca24ce3 rect updates pygame parents: 178 diff changeset	332 <a name=unionall><font size=+2><b>unionall
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	333 </b></font><br><font size=+1><tt>
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	334 Rect.unionall(sequence_of_rectstyles) -> Rect
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	335 </tt></font><ul>
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	336 Returns a new rectangle that completely covers all the
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	337 given inputs. There may be area inside the new
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	338 rectangle that is not covered by the inputs.
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	339 </ul><br> <br>
8d83fca24ce3 rect updates pygame parents: 178 diff changeset	340
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	341 <a name=unionall_ip><font size=+2><b>unionall_ip
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	342 </b></font><br><font size=+1><tt>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	343 Rect.unionall_ip(sequence_of_rectstyles) -> None
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	344 </tt></font><ul>
351 24f9f356f2c6 docs cleaned pygame parents: 310 diff changeset	345 Resizes the rectangle to completely cover all the
204 4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	346 given inputs. There may be area inside the new
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	347 rectangle that is not covered by the inputs.
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	348 </ul><br> <br>
4cfdaabc3d10 the 1.1 release candidate pygame parents: 198 diff changeset	349
16 790be231ba1a documentation boost pygame parents: diff changeset	350
790be231ba1a documentation boost pygame parents: diff changeset	351 <hr>
790be231ba1a documentation boost pygame parents: diff changeset	352 </body></html>

Mercurial > pygame

annotate docs/ref/Rect.html @ 457:c7745825439b