Mercurial > parpg-core
annotate src/parpg/bGrease/component/__init__.py @ 144:a6b25c2cedab
Move comment to correct place.
author | KarstenBock@gmx.net |
---|---|
date | Mon, 03 Oct 2011 13:05:23 +0200 |
parents | 0f659c7675f6 |
children |
rev | line source |
---|---|
92
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
1 ############################################################################# |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
2 # |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
3 # Copyright (c) 2010 by Casey Duncan and contributors |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
4 # All Rights Reserved. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
5 # |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
6 # This software is subject to the provisions of the MIT License |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
7 # A copy of the license should accompany this distribution. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
8 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
9 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
10 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
11 # |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
12 ############################################################################# |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
13 """Components store all entity data in a given |World|. You can |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
14 think of components as tables with entities as their primary keys. Like |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
15 database tables, components are defined with a "schema" that specifies |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
16 the data fields. Each field in a component has a name and a type. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
17 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
18 Component objects themselves have a dict-like interface with entities |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
19 as keys and data records as values. An application will typically |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
20 interact with components via entity attributes, entity extents or |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
21 by joining them. For more information see: |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
22 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
23 - :class:`~grease.entity.Entity` class. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
24 - :class:`~grease.world.EntityExtent` class. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
25 - :meth:`~grease.world.ComponentParts.join` method of ComponentParts. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
26 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
27 See also :ref:`defining custom components in the tutorial <custom-component-example>`. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
28 """ |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
29 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
30 __version__ = '$Id$' |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
31 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
32 __all__ = ('Component', 'ComponentError', 'Position', 'Transform', 'Movement', |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
33 'Shape', 'Renderable', 'Collision') |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
34 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
35 from parpg.bGrease.component.general import Component |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
36 from parpg.bGrease.geometry import Vec2d, Vec2dArray, Rect |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
37 from parpg.bGrease import color |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
38 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
39 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
40 class ComponentError(Exception): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
41 """General component error""" |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
42 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
43 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
44 class Position(Component): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
45 """Predefined component that stores position and orientation info for |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
46 entities. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
47 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
48 Fields: |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
49 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
50 - **position** (Vec2d) -- Position vector |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
51 - **angle** (float) -- Angle, in degrees |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
52 """ |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
53 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
54 def __init__(self): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
55 Component.__init__(self, position=Vec2d, angle=float) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
56 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
57 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
58 class Transform(Component): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
59 """Predefined component that stores offset, shear, |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
60 rotation and scale info for entity shapes. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
61 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
62 Fields: |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
63 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
64 - **offset** (Vec2d) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
65 - **shear** (Vec2d) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
66 - **rotation** (float) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
67 - **scale** (float, default 1.0) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
68 """ |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
69 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
70 def __init__(self): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
71 Component.__init__(self, offset=Vec2d, shear=Vec2d, rotation=float, scale=float) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
72 self.fields['scale'].default = lambda: 1.0 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
73 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
74 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
75 class Movement(Component): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
76 """Predefined component that stores velocity, |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
77 acceleration and rotation info for entities. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
78 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
79 Fields: |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
80 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
81 - **velocity** (Vec2d) -- Rate of change of entity position |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
82 - **accel** (Vec2d) -- Rate of change of entity velocity |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
83 - **rotation** (Vec2d) -- Rate of change of entity angle, in degrees/time |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
84 """ |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
85 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
86 def __init__(self): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
87 Component.__init__(self, velocity=Vec2d, accel=Vec2d, rotation=float) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
88 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
89 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
90 class Shape(Component): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
91 """Predefined component that stores shape vertices for entities |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
92 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
93 - **closed** (bool) -- If the shapes is closed implying an edge between |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
94 last and first vertices. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
95 - **verts** (Vec2dArray) -- Array of vertex points |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
96 """ |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
97 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
98 def __init__(self): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
99 Component.__init__(self, closed=int, verts=Vec2dArray) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
100 self.fields['closed'].default = lambda: 1 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
101 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
102 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
103 class Renderable(Component): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
104 """Predefined component that identifies entities to be |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
105 rendered and provides their depth and color. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
106 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
107 - **depth** (float) -- Drawing depth, can be used to determine z-order |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
108 while rendering. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
109 - **color** (color.RGBA) -- Color used for entity. The effect of this |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
110 field depends on the renderer. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
111 """ |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
112 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
113 def __init__(self): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
114 Component.__init__(self, depth=float, color=color.RGBA) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
115 self.fields['color'].default = lambda: color.RGBA(1,1,1,1) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
116 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
117 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
118 class Collision(Component): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
119 """Predefined component that stores collision masks to determine |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
120 which entities can collide. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
121 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
122 Fields: |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
123 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
124 - **aabb** (Rect) -- The axis-aligned bounding box for the entity. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
125 This is used for broad-phase collision detection. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
126 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
127 - **radius** (float) -- The collision radius of the entity, used for narrow-phase |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
128 collision detection. The exact meaning of this value depends on the collision |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
129 system in use. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
130 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
131 - **from_mask** (int) -- A bitmask that determines what entities this object |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
132 can collide with. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
133 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
134 - **into_mask** (int) -- A bitmask that determines what entities can collide |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
135 with this object. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
136 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
137 When considering an entity A for collision with entity B, A's ``from_mask`` is |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
138 bit ANDed with B's ``into_mask``. If the result is nonzero (meaning 1 or more |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
139 bits is set the same for each) then the collision test is made. Otherwise, |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
140 the pair cannot collide. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
141 |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
142 The default value for both of these masks is ``0xffffffff``, which means that |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
143 all entities will collide with each other by default. |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
144 """ |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
145 def __init__(self): |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
146 Component.__init__(self, aabb=Rect, radius=float, from_mask=int, into_mask=int) |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
147 self.fields['into_mask'].default = lambda: 0xffffffff |
0f659c7675f6
Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents:
66
diff
changeset
|
148 self.fields['from_mask'].default = lambda: 0xffffffff |