[Jc@sdZddlZddlmZddlmZyddlmZWnnXdefdYZdefd YZ d efd YZ d e fd YZ e Z e Z de fdYZdefdYZde fdYZdefdYZde fdYZdZdfdYZdZdefdYZdZedZed Zed!ZdS("s pygame module with basic game object classes This module contains several simple classes to be used within games. There is the main Sprite class and several Group classes that contain Sprites. The use of these classes is entirely optional when using Pygame. The classes are fairly lightweight and only provide a starting place for the code that is common to most games. The Sprite class is intended to be used as a base class for the different types of objects in the game. There is also a base Group class that simply stores sprites. A game could create new types of Group classes that operate on specially customized Sprite instances they contain. The basic Sprite class can draw the Sprites it contains to a Surface. The Group.draw() method requires that each Sprite have a Surface.image attribute and a Surface.rect. The Group.clear() method requires these same attributes, and can be used to erase all the Sprites with background. There are also more advanced Groups: pygame.sprite.RenderUpdates() and pygame.sprite.OrderedUpdates(). Lastly, this module contains several collision functions. These help find sprites inside multiple groups that have intersecting bounding rectangles. To find the collisions, the Sprites are required to have a Surface.rect attribute assigned. The groups are designed for high efficiency in removing and adding Sprites to them. They also allow cheap testing to see if a Sprite already exists in a Group. A given Sprite can exist in any number of groups. A game could use some groups to control object rendering, and a completely separate set of groups to control interaction or player movement. Instead of adding type attributes or bools to a derived Sprite class, consider keeping the Sprites inside organized Groups. This will allow for easier lookup later in the game. Sprites and Groups manage their relationships with the add() and remove() methods. These methods can accept a single or multiple targets for membership. The default initializers for these classes also takes a single or list of targets for initial membership. It is safe to repeatedly add and remove the same Sprite from a Group. While it is possible to design sprite and group classes that don't derive from the Sprite and AbstractGroup classes below, it is strongly recommended that you extend those when you add a Sprite or Group class. Sprites are not thread safe. So lock them yourself if using threads. iN(tRect(t get_ticks(t from_surfacetSpritecBsheZdZdZdZdZdZdZdZdZ dZ d Z d Z RS( ssimple base class for visible game objects pygame.sprite.Sprite(*groups): return Sprite The base class for visible game objects. Derived classes will want to override the Sprite.update() and assign a Sprite.image and Sprite.rect attributes. The initializer can accept any number of Group instances to be added to. When subclassing the Sprite, be sure to call the base initializer before adding the Sprite to Groups. cGs#i|_|r|j|ndS(N(t _Sprite__gtadd(tselftgroups((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt__init__ps cGsi|jj}xV|D]N}t|drT||sa|j||j|qaq|j|qWdS(sadd the sprite to groups Sprite.add(*groups): return None Any number of Group instances can be passed as arguments. The Sprite will be added to the Groups it is not already a member of. t _spritegroupN(Rt __contains__thasattrt add_internalR(RRthastgroup((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRts    cGsi|jj}xV|D]N}t|drT||ra|j||j|qaq|j|qWdS(sremove the sprite from groups Sprite.remove(*groups): return None Any number of Group instances can be passed as arguments. The Sprite will be removed from the Groups it is currently a member of. R N(RR R tremove_internaltremove(RRR R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs    cCsd|j|(t __class__t__name__RR(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt__repr__s( Rt __module__t__doc__RRRR RRRRRR(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRcs        t DirtySpritecBsQeZdZdZdZdZedddddZd ZRS( sa more featureful subclass of Sprite with more attributes pygame.sprite.DirtySprite(*groups): return DirtySprite Extra DirtySprite attributes with their default values: dirty = 1 if set to 1, it is repainted and then set to 0 again if set to 2 then it is always dirty ( repainted each frame, flag is not reset) 0 means that it is not dirty and therefor not repainted again blendmode = 0 its the special_flags argument of blit, blendmodes source_rect = None source rect to use, remember that it is relative to topleft (0,0) of self.image visible = 1 normally 1, if set to 0 it will not be repainted (you must set it dirty too to be erased from screen) layer = 0 (READONLY value, it is read when adding it to the LayeredUpdates, for details see doc of LayeredUpdates) cGsAd|_d|_d|_d|_d|_tj||dS(Nii(tdirtyt blendmodet_visiblet_layertNonet source_rectRR(RR((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs      cCs(||_|jdkr$d|_ndS(s9set the visible value (0 or 1) and makes the sprite dirtyiiN(R!R(Rtval((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt _set_visibles cCs|jS(s(returns the visible value of that sprite(R!(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt _get_visiblescCs |jS(N(R'(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pytscCs |j|S(N(R&(Rtvalue((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR(stdocsGyou can make this sprite disappear without removing it from the group, s(values 0 for invisible and 1 for visiblecCs d|jjt|jfS(Ns<%s DirtySprite(in %d groups)>(RRRR(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs( RRRRR&R'tpropertytvisibleR(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs     t AbstractGroupcBseZdZeZdZdZdZdZdZ dZ dZ dZ d Z d Zd Zd Zd ZdZdZdZdZdZRS(sQA base for containers for sprites. It does everything needed to behave as a normal group. You can easily inherit a new group class from this, or the other groups below, if you want to add more features. Any AbstractGroup-derived sprite groups act like sequences, and support iteration, len, and so on.cCsi|_g|_dS(N(t spritedictt lostsprites(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR s cCst|jjS(s3sprites() get a list of sprites in the group Returns an object that can be looped over with a 'for' loop. (For now it is always a list, but newer version of Python could return different iterators.) You can also iterate directly over the sprite group.(tlistR.R(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pytspritesscCsd|j|(RRR(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs(RRRR>R RR1R RR5R6R8R RRR RRERRIRJRKR(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR-s(             tGroupcBseZdZdZRS(scontainer class for many Sprites pygame.sprite.Group(*sprites): return Group A simple container for Sprite objects. This class can be inherited to create containers with more specific behaviors. The constructor takes any number of Sprite arguments to add to the Group. The group supports the following standard Python operations: in test if a Sprite is contained len the number of Sprites contained bool test if any Sprites are contained iter iterate through all the Sprites The Sprites in the Group are not ordered, so drawing and iterating the Sprites is in no particular order. cGstj||j|dS(N(R-RR(RR1((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs (RRRR(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRLst RenderUpdatescBseZdZdZRS(sGroup class that tracks dirty updates pygame.sprite.RenderUpdates(*sprites): return RenderUpdates This class is derived from pygame.sprite.Group(). It has an extended draw() method that tracks the changed areas of the screen. c Cs|j}|j}|j}g|_|j}x|jD]}||}||j|j}|dkrx||n9|j|r||j|n|||||||(RRCRHt _orig_clipRt_surfRet _old_rectt_updatet_update_appendt_rett _surf_blitt_rectRt start_timeR<t _union_rectt_union_rect_collidelistt_union_rect_union_ipRiRbt _spr_rectt_spr_rect_clipRkRtend_time((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyREs                                  ,    cCs ||_dS(sNused to set background Group.clear(surface, bgd): return None N(R(RRCRH((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRscCs |jj|j|jdS(srepaints the given area LayeredDirty.repaint_rect(screen_rect): return None screen_rect is in screencoordinates. N(R/R3RR(Rt screen_rect((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt repaint_rectscCs=|dkr'tjjj|_n ||_t|_dS(s clip the area where to draw. Just pass None (default) to reset the clip LayeredDirty.set_clip(screen_rect=None): return None N(R#tpygametdisplayt get_surfacetget_rectRR=R(RR((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs  cCs|jS(s}clip the area where to draw. Just pass None (default) to reset the clip LayeredDirty.get_clip(): return Rect (R(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRscCs2tj||||jdkr.d|_ndS(schanges the layer of the sprite change_layer(sprite, new_layer): return None sprite must have been added to the renderer. It is not checked. iiN(RTRsR(RR2Rr((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRsscCs ||_dS(ssets the treshold in milliseconds set_timing_treshold(time_ms): return None Default is 1000./80 where 80 is the fps I want to switch to full screen mode. N(R(Rttime_ms((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pytset_timing_treshold)sN( RRRRR#R RERRRRRsR(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyREs   w    t GroupSinglecBseZdZd dZdZdZdZdZdZ dZ e e e d dZ d Z d Zd ZRS( sA group container that holds a single most recent item. This class works just like a regular group, but it only keeps a single sprite in the group. Whatever sprite has been added to the group last, will be the only sprite in the group. You can access its one sprite as the .sprite attribute. Assigning to this attribute will properly remove the old sprite and then add the new one.cCs6tj|d|_|dk r2|j|ndS(N(R-RR#t_GroupSingle__spriteR(RR2((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRBs   cCs t|jS(N(RR(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR6GscCs!|jdk r|jgSgSdS(N(RR#(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR1Js cCs/|jdk r"|jj|n||_dS(N(RR#R(RR2((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR NscCs |jdk S(N(RR#(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRJSscCs|jS(N(R(R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt _get_spriteUscCs|j||j||S(N(R (RR2((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt _set_spriteXs  s"The sprite contained in this groupcCs||jkrd|_ndS(N(RR#(RR2((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR`scCs |j|kS(N(R(RR2((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR5cscCs |j|kS(N(R(RR2((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR gsN(RRRR#RR6R1R RJRRR+R2RR5R (((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR7s            cCs|jj|jS(scollision detection between two sprites, using rects. pygame.sprite.collide_rect(left, right): return bool Tests for collision between two sprites. Uses the pygame rect colliderect function to calculate the collision. Intended to be passed as a collided callback function to the *collide functions. Sprites must have a "rect" attributes. New in pygame 1.8.0 (RBRN(tlefttright((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt collide_rectos tcollide_rect_ratiocBs eZdZdZdZRS(sA callable class that checks for collisions between two sprites, using a scaled version of the sprites rects. Is created with a ratio, the instance is then intended to be passed as a collided callback function to the *collide functions. New in pygame 1.8.1 cCs ||_dS(sCreates a new collide_rect_ratio callable. ratio is expected to be a floating point value used to scale the underlying sprite rect before checking for collisions. N(tratio(RR((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRscCs|j}|j}|j}|j}|j||||||}|j}|j}|j}|j||||||}|j|S(slpygame.sprite.collide_rect_ratio(ratio)(left, right): bool collision detection between two sprites, using scaled rects. Tests for collision between two sprites. Uses the pygame rect colliderect function to calculate the collision, after scaling the rects by the stored ratio. Sprites must have a "rect" attributes. (RRBtwidththeighttinflateRN(RRRRtleftrectRRt rightrect((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRFs    "   "(RRRRRF(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR}s  c Cs|jj|jj}|jj|jj}|d|d}y|jd}Wn6tk r|j}|jd|jdd}nXy|jd}Wn6tk r|j}|jd|jdd}nX|||kS(swcollision detection between two sprites, using circles. pygame.sprite.collide_circle(left, right): return bool Tests for collision between two sprites, by testing to see if two circles centered on the sprites overlap. If the sprites have a "radius" attribute, that is used to create the circle, otherwise a circle is created that is big enough to completely enclose the sprites rect as given by the "rect" attribute. Intended to be passed as a collided callback function to the *collide functions. Sprites must have a "rect" and an optional "radius" attribute. New in pygame 1.8.0 ii(RBtcenterxtcenterytradiusR;RR( RRt xdistancet ydistancetdistancesquaredtleftradiussquaredRtrightradiussquaredR((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pytcollide_circles      tcollide_circle_ratiocBs eZdZdZdZRS(sA callable class that checks for collisions between two sprites, using a scaled version of the sprites radius. Is created with a ratio, the instance is then intended to be passed as a collided callback function to the *collide functions. New in pygame 1.8.1 cCs||_|dd|_dS(sCreates a new collide_circle_ratio callable. ratio is expected to be a floating point value used to scale the underlying sprite radius before checking for collisions. ig@N(Rt halfratio(RR((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs c Cs?|j}|jj|jj}|jj|jj}|d|d}t|dr|j|d}t|dr|j|d}q1|j} |j} | jd| jd| }nv|j} |j} | jd| jd| }t|dr |j|d}n%|j} | jd| jd| }|||kS(spygame.sprite.collide_circle_radio(ratio)(left, right): return bool collision detection between two sprites, using scaled circles. Tests for collision between two sprites, by testing to see if two circles centered on the sprites overlap, after scaling the circles radius by the stored ratio. If the sprites have a "radius" attribute, that is used to create the circle, otherwise a circle is created that is big enough to completely enclose the sprites rect as given by the "rect" attribute. Intended to be passed as a collided callback function to the *collide functions. Sprites must have a "rect" and an optional "radius" attribute. iR( RRBRRR RRRR( RRRRRRRRRRRR((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRFs&      (RRRRRF(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyRs  cCs|jd|jd}|jd|jd}y |j}Wn tk r_t|j}nXy |j}Wn tk rt|j}nX|j|||fS(scollision detection between two sprites, using masks. pygame.sprite.collide_mask(SpriteLeft, SpriteRight): bool Tests for collision between two sprites, by testing if thier bitmasks overlap. If the sprites have a "mask" attribute, that is used as the mask, otherwise a mask is created from the sprite image. Intended to be passed as a collided callback function to the *collide functions. Sprites must have a "rect" and an optional "mask" attribute. New in pygame 1.8.0 ii(RBtmaskR;RRAtoverlap(RRtxoffsettyoffsettleftmaskt rightmask((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt collide_mask s    cCsg}|dkr|jj}|rgxp|jD]/}||jr1|j|j|q1q1Wqx|D]%}||jrn|j|qnqnWny|rxp|jD]/}|||r|j|j|qqWn0x-|D]%}|||r|j|qqW|S(s)find Sprites in a Group that intersect another Sprite pygame.sprite.spritecollide(sprite, group, dokill, collided = None): return Sprite_list Return a list containing all Sprites in a Group that intersect with another Sprite. Intersection is determined by comparing the Sprite.rect attribute of each Sprite. The dokill argument is a bool. If set to True, all Sprites that collide will be removed from the Group. The collided argument is a callback function used to calculate if two sprites are colliding. it should take two sprites as values, and return a bool value indicating if they are colliding. If collided is not passed, all sprites must have a "rect" value, which is a rectangle of the sprite area, which will be used to calculate the collision. N(R#RBRNR1RR3(R2Rtdokilltcollidedtcrashedt spritecollideR?((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyR%s(      c Csi}t}|r^x|jD]8}|||||}|r|||<|jqqWn9x6|D].}|||||}|re||| dict collision detection between group and group given two groups, this will find the intersections between all sprites in each group. it returns a dictionary of all sprites in the first group that collide. the value for each item in the dictionary is a list of the sprites in the second group it collides with. the two dokill arguments control if the sprites from either group will be automatically removed from all groups. collided is a callback function used to calculate if two sprites are colliding. it should take two sprites as values, and return a bool value indicating if they are colliding. if collided is not passed, all sprites must have a "rect" value, which is a rectangle of the sprite area, which will be used to calculate the collision.(RR1R( tgroupatgroupbtdokillatdokillbRRtSCR?R((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pyt groupcollideOs  cCsg|dkr?|jj}xH|D]}||jr|SqWn$x!|D]}|||rF|SqFWdS(spygame.sprite.spritecollideany(sprite, group) -> sprite finds any sprites that collide given a sprite and a group of sprites, this will return return any single sprite that collides with with the given sprite. If there are no collisions this returns None. if you don't need all the features of the spritecollide function, this function will be a bit quicker. collided is a callback function used to calculate if two sprites are colliding. it should take two sprites as values, and return a bool value indicating if they are colliding. if collided is not passed, all sprites must have a "rect" value, which is a rectangle of the sprite area, which will be used to calculate the collision.N(R#RBRN(R2RRRR?((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pytspritecollideanyqs     (RRRt pygame.timeRt pygame.maskRtobjectRRR-RLt RenderPlaint RenderClearRMRRRTRRRRRRRR#RRR(((s:c:\mingw\msys\1.0\newbuild\install\python\pygame\sprite.pytBs6 c9,8 - A  * "