Updates to GamePython Reference.
[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 mass: The object's mass (provided the object has a physics controller). float. read only
11         @ivar parent: The object's parent object. (Read only)
12         @type parent: L{KX_GameObject}
13         @ivar visible: visibility flag. boolean.
14         @ivar position: The object's position. 
15         @type position: list [x, y, z]
16         @ivar orientation: The object's orientation. 3x3 Matrix.  
17                            You can also write a Quaternion or Euler vector.
18         @type orientation: 3x3 Matrix [[float]]
19         @ivar scaling: The object's scaling factor. list [sx, sy, sz]
20         @type scaling: list [sx, sy, sz]
21         """
22         
23         def setVisible(visible):
24                 """
25                 Sets the game object's visible flag.
26                 
27                 @type visible: boolean
28                 """
29         def setPosition(pos):
30                 """
31                 Sets the game object's position.
32                 
33                 @type pos: [x, y, z]
34                 @param pos: the new position, in world coordinates.
35                 """
36         def getPosition():
37                 """
38                 Gets the game object's position.
39                 
40                 @rtype: list [x, y, z]
41                 @return: the object's position in world coordinates.
42                 """
43         def setOrientation(orn):
44                 """
45                 Sets the game object's orientation.
46                 
47                 @type orn: 3x3 rotation matrix, or Quaternion.
48                 @param orn: a rotation matrix specifying the new rotation.
49                 """
50         def getOrientation():
51                 """
52                 Gets the game object's orientation.
53                 
54                 @rtype: 3x3 rotation matrix
55                 @return: The game object's rotation matrix
56                 """
57         def getLinearVelocity():
58                 """
59                 Gets the game object's linear velocity.
60                 
61                 This method returns the game object's velocity through it's centre of mass,
62                 ie no angular velocity component.
63                 
64                 cf getVelocity()
65                 
66                 @rtype: list [vx, vy, vz]
67                 @return: the object's linear velocity.
68                 """
69         def getVelocity(point):
70                 """
71                 Gets the game object's velocity at the specified point.
72                 
73                 Gets the game object's velocity at the specified point, including angular
74                 components.
75                 
76                 @type point: list [x, y, z]
77                 @param point: the point to return the velocity for, in local coordinates. (optional: default = [0, 0, 0])
78                 @rtype: list [vx, vy, vz]
79                 @return: the velocity at the specified point.
80                 """
81         def getMass():
82                 """
83                 Gets the game object's mass.
84                 
85                 @rtype: float
86                 @return: the object's mass.
87                 """
88         def getReactionForce():
89                 """
90                 Gets the game object's reaction force.
91                 
92                 The reaction force is the force applied to this object over the last simulation timestep.
93                 This also includes impulses, eg from collisions.
94                 
95                 @rtype: list [fx, fy, fz]
96                 @return: the reaction force of this object.
97                 """
98         def applyImpulse(point, impulse):
99                 """
100                 Applies an impulse to the game object.
101                 
102                 This will apply the specified impulse to the game object at the specified point.
103                 If point != getPosition(), applyImpulse will also change the object's angular momentum.
104                 Otherwise, only linear momentum will change.
105                 
106                 @type point: list [x, y, z]
107                 @param point: the point to apply the impulse to (in world coordinates)
108                 """
109         def suspendDynamics():
110                 """
111                 Suspends physics for this object.
112                 """
113         def restoreDynamics():
114                 """
115                 Resumes physics for this object.
116                 """
117         def enableRigidBody():
118                 """
119                 Enables rigid body physics for this object.
120                 
121                 Rigid body physics allows the object to roll on collisions.
122                 """
123         def disableRigidBody():
124                 """
125                 Disables rigid body physics for this object.
126                 """
127         def getParent():
128                 """
129                 Gets this object's parent.
130                 
131                 @rtype: L{KX_GameObject}
132                 @return: this object's parent object, or None if this object has no parent.
133                 """
134         def getMesh(mesh):
135                 """
136                 Gets the mesh object for this object.
137                 
138                 @type mesh: integer
139                 @param mesh: the mesh object to return (optional: default mesh = 0)
140                 @rtype: L{KX_MeshProxy}
141                 @return: the first mesh object associated with this game object, or None if this object has no meshs.
142                 """
143         def getPhysicsId():
144                 """
145                 Returns the user data object associated with this game object's physics controller.
146                 """