1 package SDL::Game::Rect;
16 my $self = \SDL::NewRect($x, $y, $w, $h);
19 Carp::croak SDL::GetError();
25 #############################
27 #############################
29 my ($self, $val) = (@_);
31 $self->top($val - $self->height); # y = val - height
33 return $self->top + $self->height; # y + height
37 my ($self, $val) = (@_);
39 $self->left($val - $self->width); # x = val - width
41 return $self->left + $self->width; # x + width
45 my ($self, $val) = (@_);
47 $self->left($val - ($self->width >> 1)); # x = val - (width/2)
49 return $self->left + ($self->width >> 1); # x + (width/2)
53 my ($self, $val) = (@_);
55 $self->top($val - ($self->height >> 1)); # y = val - (height/2)
57 return $self->top + ($self->height >> 1); # y + (height/2)
61 my ($self, $w, $h) = (@_);
63 return ($self->width, $self->height) # (width, height)
64 unless (defined $w or defined $h);
67 $self->width($w); # width
70 $self->height($h); # height
75 my ($self, $y, $x) = (@_);
77 return ($self->top, $self->left) # (top, left)
78 unless (defined $y or defined $x);
81 $self->left($x); # left
90 my ($self, $centery, $x) = (@_);
92 return ($self->top + ($self->height >> 1), $self->left) # (centery, left)
93 unless (defined $centery or defined $x);
96 $self->left($x); # left
98 if (defined $centery) {
99 $self->top($centery - ($self->height >> 1)); # y = centery - (height/2)
105 my ($self, $bottom, $x) = (@_);
107 return ($self->top + $self->height, $self->left) # (bottom, left)
108 unless (defined $bottom or defined $x);
111 $self->left($x); # left
113 if (defined $bottom) {
114 $self->top($bottom - $self->height); # y = bottom - height
120 my ($self, $centerx, $centery) = (@_);
122 return ($self->left + ($self->width >> 1), $self->top + ($self->height >> 1))
123 unless (defined $centerx or defined $centery);
125 if (defined $centerx) {
126 $self->left($centerx - ($self->width >> 1)); # x = centerx - (width/2)
128 if (defined $centery) {
129 $self->top($centery - ($self->height >> 1)); # y = centery - (height/2)
135 my ($self, $y, $right) = (@_);
137 return ($self->top, $self->left + $self->width) # (top, right)
138 unless (defined $y or defined $right);
140 if (defined $right) {
141 $self->left($right - $self->width); # x = right - width
144 $self->top($y); # top
150 my ($self, $centery, $right) = (@_);
152 return ($self->top + ($self->height >> 1), $self->left + $self->width) # (centery, right)
153 unless (defined $centery or defined $right);
155 if (defined $right) {
156 $self->left($right - $self->width); # x = right - width
158 if (defined $centery) {
159 $self->top($centery - ($self->height >> 1)); # y = centery - (height/2)
165 my ($self, $bottom, $right) = (@_);
167 return ($self->top + $self->height, $self->left + $self->width) # (bottom, right)
168 unless (defined $bottom or defined $right);
170 if (defined $right) {
171 $self->left($right - $self->width); # x = right - width
173 if (defined $bottom) {
174 $self->top($bottom - $self->height); # y = bottom - height
180 my ($self, $centerx, $y) = (@_);
182 return ($self->left + ($self->width >> 1), $self->top) # (centerx, top)
183 unless (defined $centerx or defined $y);
186 $self->top($y); # top
188 if (defined $centerx) {
189 $self->left($centerx - ($self->width >> 1)); # x = centerx - (width/2)
195 my ($self, $centerx, $bottom) = (@_);
197 return ($self->left + ($self->width >> 1), $self->top + $self->height) # (centerx, bottom)
198 unless (defined $centerx or defined $bottom);
200 if (defined $bottom) {
201 $self->top($bottom - $self->height); # y = bottom - height
203 if (defined $centerx) {
204 $self->left($centerx - ($self->width >> 1)); # x = centerx - (width/2)
215 SDL::Game::Rect - SDL::Game object for storing and manipulating rectangular coordinates
222 C<< SDL::Game::Rect >> object are used to store and manipulate rectangular areas. Rect objects are created from a combination of left (or x), top (or y), width (or w) and height (or h) values, just like raw C<< SDL::Rect objects >>.
224 All C<< SDL::Game::Rect >> methods that change either position or size of a Rect return B<a new copy> of the Rect with the affected changes. The original Rect is B<not> modified. If you wish to modify the current Rect object, you can use the equivalent "in-place" methods that do not return but instead affects the original Rect. These "in-place" methods are denoted with the "ip" suffix. Note that changing a Rect's attribute is I<always> an in-place operation.
229 All Rect attributes are acessors, meaning you can get them by name, and set them by passing a value:
234 The Rect object has several attributes which can be used to resize, move and align the Rect.
239 =item * width, w - gets/sets object's width
241 =item * height, h - gets/sets object's height
243 =item * left, x - moves the object left position to match the given coordinate
245 =item * top, y - moves the object top position to match the given coordinate
247 =item * bottom - moves the object bottom position to match the given coordinate
249 =item * right - moves the object right position to match the given coordinate
251 =item * centerx - moves the object's horizontal center to match the given coordinate
253 =item * centery - moves the object's vertical center to match the given coordinate
257 Some of the attributes above can be fetched or set in pairs:
259 $rect->topleft(10, 15); # top is now 10, left is now 15
261 my ($width, $height) = $rect->size;
266 =item * size - gets/sets object's size (width, height)
268 =item * topleft - gets/sets object's top and left positions
270 =item * midleft - gets/sets object's vertical center and left positions
272 =item * bottomleft - gets/sets object's bottom and left positions
274 =item * center - gets/sets object's center (horizontal(x), vertical(y))
276 =item * topright - gets/sets object's top and right positions
278 =item * midright - gets/sets object's vertical center and right positions
280 =item * bottomright - gets/sets object's bottom and right positions
282 =item * midtop - gets/sets object's horizontal center and top positions
284 =item * midbottom - gets/sets object's horizontal center and bottom positions
291 Methods denoted as receiving Rect objects can receive either C<<SDL::Game::Rect>> or raw C<<SDL::Rect>> objects.
293 =head3 new ($left, $top, $width, $height)
295 Returns a new Rect object with the given coordinates. If any value is omitted (by passing undef), 0 is used instead.
301 Returns a new Rect object having the same position and size as the original
305 Returns a new Rect that is moved by the given offset. The x and y arguments can be any integer value, positive or negative.
309 Same as C<<move>> above, but moves the current Rect in place and returns nothing.
313 Grows or shrinks the rectangle. Returns a new Rect with the size changed by the given offset. The rectangle remains centered around its current center. Negative values will return a shrinked rectangle instead.
315 =head3 inflate_ip(x, y)
317 Same as C<<inflate>> above, but grows/shrinks the current Rect in place and returns nothing.
321 Returns a new Rect moved to be completely inside the Rect object passed as an argument. If the current Rect is too large to fit inside the passed Rect, it is centered inside it, but its size is not changed.
323 =head3 clamp_ip($rect)
325 Same as C<<clamp>> above, but moves the current Rect in place and returns nothing.
329 Returns a new Rect with the intersection between the two Rect objects, that is, returns a new Rect cropped to be completely inside the Rect object passed as an argument. If the two rectangles do not overlap to begin with, a Rect with 0 size is returned.
331 =head3 clip_ip($rect)
333 Same as C<<clip>> above, but crops the current Rect in place and returns nothing. As the original method, the Rect becomes zero-sized if the two rectangles do not overlap to begin with.
337 Returns a new rectangle that completely covers the area of the current Rect and the one passed as an argument. There may be area inside the new Rect that is not covered by the originals.
339 =head3 union_ip($rect)
341 Same as C<<union>> above, but resizes the current Rect in place and returns nothing.
343 =head3 unionall( [$rect1, $rect2, ...] )
345 Returns the union of one rectangle with a sequence of many rectangles, passed as an ARRAY REF.
347 =head3 unionall_ip( [$rect1, $rect2, ...] )
349 Same as C<<unionall>> above, but resizes the current Rect in place and returns nothing.
353 Returns a new Rect moved and resized to fit the Rect object passed as an argument. The aspect ratio of the original Rect is preserved, so the new rectangle may be smaller than the target in either width or height.
357 Same as C<<fit>> above, but moves/resizes the current Rect in place and returns nothing.
361 Corrects negative sizes, flipping width/height of the Rect if they have a negative size. No repositioning is made so the rectangle will remain in the same place, but the negative sides will be swapped. This method returns nothing.
363 =head3 contains($rect)
365 Returns true (non-zero) when the argument is completely inside the Rect. Otherwise returns undef.
367 =head3 collidepoint(x, y)
369 Returns true (non-zero) if the given point is inside the Rect, otherwise returns undef. A point along the right or bottom edge is not considered to be inside the rectangle.
371 =head3 colliderect($rect)
373 Returns true (non-zero) if any portion of either rectangles overlap (except for the top+bottom or left+right edges).
375 =head3 collidelist( [$rect1, $rect2, ...] )
377 Test whether the rectangle collides with any in a sequence of rectangles, passed as an ARRAY REF. The index of the first collision found is returned. Returns undef if no collisions are found.
379 =head3 collidelistall( [$rect1, $rect2, ...] )
381 Returns an ARRAY REF of all the indices that contain rectangles that collide with the Rect. If no intersecting rectangles are found, an empty list ref is returned.
383 =head3 collidehash( {key1 => $rect1, key2 => $rect2, ...} )
385 Receives a HASH REF and returns the a (key, value) list with the key and value of the first hash item that collides with the Rect. If no collisions are found, returns (undef, undef).
387 =head3 collidehashall( {key1 => $rect1, key2 => $rect2, ...} )
389 Returns a HASH REF of all the key and value pairs that intersect with the Rect. If no collisions are found an empty hash ref is returned.
394 Breno G. de Oliveira, C<< <garu at cpan.org> >>
398 Please report any bugs or feature requests to the bug tracker. I will be notified, and then you'll automatically be notified of progress on your bug as we make changes.
403 You can find documentation for this module with the perldoc command.
405 perldoc SDL::Game::Rect
408 =head1 ACKNOWLEDGEMENTS
410 Many thanks to all SDL_Perl contributors, and to the authors of pygame.rect, in which this particular module is heavily based.
412 =head1 COPYRIGHT & LICENSE
414 Copyright 2009 Breno G. de Oliveira, all rights reserved.
416 This program is free software; you can redistribute it and/or modify it
417 under the same terms as Perl itself.
422 perl, L<SDL>, L<SDL::Rect>, L<SDL::Game>