svn merge -r 15392:15551 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / gameengine / PyDoc / KX_GameObject.py
1 # $Id$
2 # Documentation for game objects
3
4 class KX_GameObject:
5         """
6         All game objects are derived from this class.
7         
8         Properties assigned to game objects are accessible as attributes of this class.
9         
10         @ivar name: The object's name.
11         @type name: string.
12         @ivar mass: The object's mass (provided the object has a physics controller). Read only.
13         @type mass: float
14         @ivar parent: The object's parent object. (Read only)
15         @type parent: L{KX_GameObject}
16         @ivar visible: visibility flag.
17         @type visible: boolean
18         @ivar position: The object's position. 
19         @type position: list [x, y, z]
20         @ivar orientation: The object's orientation. 3x3 Matrix.  
21                            You can also write a Quaternion or Euler vector.
22         @type orientation: 3x3 Matrix [[float]]
23         @ivar scaling: The object's scaling factor. list [sx, sy, sz]
24         @type scaling: list [sx, sy, sz]
25         @ivar timeOffset: adjust the slowparent delay at runtime.
26         @type timeOffset: float
27         """
28         def endObject(visible):
29                 """
30                 Delete this object, can be used inpace of the EndObject Actuator.
31                 The actual removal of the object from the scene is delayed.
32                 """     
33         def getVisible(visible):
34                 """
35                 Gets the game object's visible flag.
36                 
37                 @type visible: boolean
38                 """     
39         def setVisible(visible):
40                 """
41                 Sets the game object's visible flag.
42                 
43                 @type visible: boolean
44                 """
45         def getState():
46                 """
47                 Gets the game object's state bitmask.
48                 
49                 @rtype: int
50                 @return: the objects state.
51                 """     
52         def setState():
53                 """
54                 Sets the game object's visible flag.
55                 The bitmasks for states from 1 to 30 can be set with (1<<0, 1<<1, 1<<2 ... 1<<29)
56                 
57                 @type visible: boolean
58                 """
59         def setPosition(pos):
60                 """
61                 Sets the game object's position.
62                 
63                 @type pos: [x, y, z]
64                 @param pos: the new position, in world coordinates.
65                 """
66         def getPosition():
67                 """
68                 Gets the game object's position.
69                 
70                 @rtype: list [x, y, z]
71                 @return: the object's position in world coordinates.
72                 """
73         def setOrientation(orn):
74                 """
75                 Sets the game object's orientation.
76                 
77                 @type orn: 3x3 rotation matrix, or Quaternion.
78                 @param orn: a rotation matrix specifying the new rotation.
79                 @note: When using this matrix with Blender.Mathutils.Matrix() types, it will need to be transposed.
80                 """
81         def alignAxisToVect(vect, axis):
82                 """
83                 Aligns any of the game object's axis along the given vector.
84                 
85                 @type vect: 3d vector.
86                 @param vect: a vector to align the axis.
87                 @type axis: integer.
88                 @param axis:The axis you want to align
89                                         - 0: X axis
90                                         - 1: Y axis
91                                         - 2: Z axis (default) 
92                 """
93         def getAxisVect(vect):
94                 """
95                 Returns the axis vector rotates by the objects worldspace orientation.
96                 This is the equivalent if multiplying the vector by the orientation matrix.
97                 
98                 @type vect: 3d vector.
99                 @param vect: a vector to align the axis.
100                 @rtype: 3d vector.
101                 @return: The vector in relation to the objects rotation.
102
103                 """
104         def getOrientation():
105                 """
106                 Gets the game object's orientation.
107                 
108                 @rtype: 3x3 rotation matrix
109                 @return: The game object's rotation matrix
110                 @note: When using this matrix with Blender.Mathutils.Matrix() types, it will need to be transposed.
111                 """
112         def getLinearVelocity(local = 0):
113                 """
114                 Gets the game object's linear velocity.
115                 
116                 This method returns the game object's velocity through it's centre of mass,
117                 ie no angular velocity component.
118                 
119                 @type local: boolean
120                 @param local: - False: you get the "global" velocity ie: relative to world orientation (default).
121                               - True: you get the "local" velocity ie: relative to object orientation.
122                 @rtype: list [vx, vy, vz]
123                 @return: the object's linear velocity.
124                 """
125         def setLinearVelocity(velocity, local = 0):
126                 """
127                 Sets the game object's linear velocity.
128                 
129                 This method sets game object's velocity through it's centre of mass,
130                 ie no angular velocity component.
131                 
132                 @type velocity: 3d vector.
133                 @param velocity: linear velocity vector.
134                 @type local: boolean
135                 @param local: - False: you get the "global" velocity ie: relative to world orientation (default).
136                               - True: you get the "local" velocity ie: relative to object orientation.
137                 """
138         def getVelocity(point):
139                 """
140                 Gets the game object's velocity at the specified point.
141                 
142                 Gets the game object's velocity at the specified point, including angular
143                 components.
144                 
145                 @type point: list [x, y, z]
146                 @param point: the point to return the velocity for, in local coordinates. (optional: default = [0, 0, 0])
147                 @rtype: list [vx, vy, vz]
148                 @return: the velocity at the specified point.
149                 """
150         def getMass():
151                 """
152                 Gets the game object's mass.
153                 
154                 @rtype: float
155                 @return: the object's mass.
156                 """
157         def getReactionForce():
158                 """
159                 Gets the game object's reaction force.
160                 
161                 The reaction force is the force applied to this object over the last simulation timestep.
162                 This also includes impulses, eg from collisions.
163                 
164                 @rtype: list [fx, fy, fz]
165                 @return: the reaction force of this object.
166                 """
167         def applyImpulse(point, impulse):
168                 """
169                 Applies an impulse to the game object.
170                 
171                 This will apply the specified impulse to the game object at the specified point.
172                 If point != getPosition(), applyImpulse will also change the object's angular momentum.
173                 Otherwise, only linear momentum will change.
174                 
175                 @type point: list [x, y, z]
176                 @param point: the point to apply the impulse to (in world coordinates)
177                 """
178         def suspendDynamics():
179                 """
180                 Suspends physics for this object.
181                 """
182         def restoreDynamics():
183                 """
184                 Resumes physics for this object.
185                 @Note: The objects linear velocity will be applied from when the dynamics were suspended.
186                 """
187         def enableRigidBody():
188                 """
189                 Enables rigid body physics for this object.
190                 
191                 Rigid body physics allows the object to roll on collisions.
192                 @Note: This is not working with bullet physics yet.
193                 """
194         def disableRigidBody():
195                 """
196                 Disables rigid body physics for this object.
197                 @Note: This is not working with bullet physics yet. The angular is removed but rigid body physics can still rotate it later.
198                 """
199         def getParent():
200                 """
201                 Gets this object's parent.
202                 
203                 @rtype: L{KX_GameObject}
204                 @return: this object's parent object, or None if this object has no parent.
205                 """
206         def setParent(parent):
207                 """
208                 Sets this object's parent.
209                 
210                 @type parent: L{KX_GameObject}
211                 @param parent: new parent object.
212                 """
213         def removeParent():
214                 """
215                 Removes this objects parent.
216                 """
217         def getMesh(mesh):
218                 """
219                 Gets the mesh object for this object.
220                 
221                 @type mesh: integer
222                 @param mesh: the mesh object to return (optional: default mesh = 0)
223                 @rtype: L{KX_MeshProxy}
224                 @return: the first mesh object associated with this game object, or None if this object has no meshs.
225                 """
226         def getPhysicsId():
227                 """
228                 Returns the user data object associated with this game object's physics controller.
229                 """
230         def getPropertyNames():
231                 """
232                 Gets a list of all property names.
233                 @rtype: list
234                 @return: All property names for this object.
235                 """
236         def getDistanceTo(other):
237                 """
238                 Returns the distance to another object or point.
239                 
240                 @param other: a point or another L{KX_GameObject} to measure the distance to.
241                 @type other: L{KX_GameObject} or list [x, y, z]
242                 @rtype: float
243                 """
244         def rayCastTo(other,dist,prop):
245                 """
246                 Look towards another point/object and find first object hit within dist that matches prop.
247
248                 The ray is always casted from the center of the object, ignoring the object itself.
249                 The ray is casted towards the center of another object or an explicit [x,y,z] point.
250                 Use rayCast() if you need to retrieve the hit point 
251
252                 @param other: [x,y,z] or object towards which the ray is casted
253                 @type other: L{KX_GameObject} or 3-tuple
254                 @param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to other
255                 @type dist: float
256                 @param prop: property name that object must have; can be omitted => detect any object
257                 @type prop: string
258                 @rtype: L{KX_GameObject}
259                 @return: the first object hit or None if no object or object does not match prop
260                 """
261         def rayCast(to,from,dist,prop):
262                 """
263                 Look from a point/object to another point/object and find first object hit within dist that matches prop.
264                 Returns a 3-tuple with object reference, hit point and hit normal or (None,None,None) if no hit.
265                 Ex:
266                         # shoot along the axis gun-gunAim (gunAim should be collision-free)
267                         ob,point,normal = gun.rayCast(gunAim,None,50)
268                         if ob:
269                                 # hit something
270
271                 Notes:                          
272                 The ray ignores the object on which the method is called.
273                 If is casted from/to object center or explicit [x,y,z] points.
274                 The ray does not have X-Ray capability: the first object hit (other than self object) stops the ray
275                 If a property was specified and the first object hit does not have that property, there is no hit
276                 The     ray ignores collision-free objects and faces that dont have the collision flag enabled, you can however use ghost objects.
277
278                 @param to: [x,y,z] or object to which the ray is casted
279                 @type to: L{KX_GameObject} or 3-tuple
280                 @param from: [x,y,z] or object from which the ray is casted; None or omitted => use self object center
281                 @type from: L{KX_GameObject} or 3-tuple or None
282                 @param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to to
283                 @type dist: float
284                 @param prop: property name that object must have; can be omitted => detect any object
285                 @type prop: string
286                 @rtype: 3-tuple (L{KX_GameObject}, 3-tuple (x,y,z), 3-tuple (nx,ny,nz))
287                 @return: (object,hitpoint,hitnormal) or (None,None,None)
288                 """
289
290