~diresu/blender/blender-command-port

« back to all changes in this revision

Viewing changes to source/gameengine/PyDoc/KX_GameObject.py

  • Committer: Dietrich Bollmann
  • Date: 2009-04-26 06:25:14 UTC
  • mfrom: (184.1.520)
  • Revision ID: diresu@web.de-20090426062514-ly27wepl1t5d7p8s
Update to state of blender repository from 2009-04-26 revision 19927.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# $Id: KX_GameObject.py 19887 2009-04-23 00:49:38Z dfelinto $
 
1
# $Id: KX_GameObject.py 19924 2009-04-25 12:58:07Z campbellbarton $
2
2
# Documentation for game objects
3
3
 
4
4
# from SCA_IObject import *
49
49
        @type scaling: list [sx, sy, sz] On write: local scaling, on read: world scaling
50
50
        @ivar localOrientation: The object's local orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector.
51
51
        @type localOrientation: 3x3 Matrix [[float]]
52
 
        @ivar worldOrientation: The object's world orientation. Read-only.
 
52
        @ivar worldOrientation: The object's world orientation.
53
53
        @type worldOrientation: 3x3 Matrix [[float]]
54
54
        @ivar localScaling: The object's local scaling factor.
55
55
        @type localScaling: list [sx, sy, sz]
56
56
        @ivar worldScaling: The object's world scaling factor. Read-only
57
57
        @type worldScaling: list [sx, sy, sz]
58
 
        @ivar localPosition: The object's local position. 
 
58
        @ivar localPosition: The object's local position.
59
59
        @type localPosition: list [x, y, z]
60
60
        @ivar worldPosition: The object's world position. 
61
61
        @type worldPosition: list [x, y, z]
87
87
                Delete this object, can be used inpace of the EndObject Actuator.
88
88
                The actual removal of the object from the scene is delayed.
89
89
                """     
90
 
        def replaceMesh(mesh_name):
 
90
        def replaceMesh(mesh):
91
91
                """
92
92
                Replace the mesh of this object with a new mesh. This works the same was as the actuator.
93
 
                @type mesh_name: string
 
93
                @type mesh: L{KX_MeshProxy<KX_MeshProxy.KX_MeshProxy>} or mesh name
94
94
                """     
95
95
        def getVisible():
96
96
                """
110
110
                """
111
111
                Sets the game object's occlusion capability.
112
112
                
113
 
                @type visible: boolean
 
113
                @type occlusion: boolean
114
114
                @type recursive: boolean
115
115
                @param recursive: optional argument to set all childrens occlusion flag too.
116
116
                """
159
159
                @param orn: a rotation matrix specifying the new rotation.
160
160
                @note: When using this matrix with Blender.Mathutils.Matrix() types, it will need to be transposed.
161
161
                """
162
 
        def alignAxisToVect(vect, axis):
 
162
        def alignAxisToVect(vect, axis, factor):
163
163
                """
164
164
                Aligns any of the game object's axis along the given vector.
165
165
                
170
170
                                        - 0: X axis
171
171
                                        - 1: Y axis
172
172
                                        - 2: Z axis (default) 
 
173
                @type factor: float
 
174
                @param factor: Only rotate a feaction of the distance to the target vector (0.0 - 1.0)
173
175
                """
174
176
        def getAxisVect(vect):
175
177
                """
468
470
                @type objfrom: L{KX_GameObject} or 3-tuple or None
469
471
                @param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to to
470
472
                @type dist: float
471
 
                @param prop: property name that object must have; can be omitted => detect any object
 
473
                @param prop: property name that object must have; can be omitted or "" => detect any object
472
474
                @type prop: string
473
475
                @param face: normal option: 1=>return face normal; 0 or omitted => normal is oriented towards origin
474
476
                @type face: int