1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
# $Id$
# Documentation for KX_IpoActuator
from SCA_IActuator import *
class KX_IpoActuator(SCA_IActuator):
"""
IPO actuator activates an animation.
"""
def set(mode, startframe, endframe, force):
"""
Sets the properties of the actuator.
@param mode: "Play", "PingPong", "Flipper", "LoopStop", "LoopEnd" or "FromProp"
@type mode: string
@param startframe: first frame to use
@type startframe: integer
@param endframe: last frame to use
@type endframe: integer
@param force: special mode
@type force: integer (0=normal, 1=interpret location as force, 2=additive)
"""
def setProperty(property):
"""
Sets the name of the property to be used in FromProp mode.
@type property: string
"""
def setStart(startframe):
"""
Sets the frame from which the IPO starts playing.
@type startframe: integer
"""
def getStart():
"""
Returns the frame from which the IPO starts playing.
@rtype: integer
"""
def setEnd(endframe):
"""
Sets the frame at which the IPO stops playing.
@type endframe: integer
"""
def getEnd():
"""
Returns the frame at which the IPO stops playing.
@rtype: integer
"""
def setIpoAsForce(force):
"""
Set whether to interpret the ipo as a force rather than a displacement.
@type force: boolean
@param force: KX_TRUE or KX_FALSE
"""
def getIpoAsForce():
"""
Returns whether to interpret the ipo as a force rather than a displacement.
@rtype: boolean
"""
def setIpoAdd(add):
"""
Set whether to interpret the ipo as additive rather than absolute.
@type add: boolean
@param add: KX_TRUE or KX_FALSE
"""
def getIpoAdd():
"""
Returns whether to interpret the ipo as additive rather than absolute.
@rtype: boolean
"""
def setType(mode):
"""
Sets the operation mode of the actuator.
@param mode: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
@type mode: string
"""
def getType():
"""
Returns the operation mode of the actuator.
@rtype: integer
@return: KX_IPOACT_PLAY, KX_IPOACT_PINGPONG, KX_IPOACT_FLIPPER, KX_IPOACT_LOOPSTOP, KX_IPOACT_LOOPEND
"""
def setForceIpoActsLocal(local):
"""
Set whether to apply the force in the object's local
coordinates rather than the world global coordinates.
@param local: Apply the ipo-as-force in the object's local
coordinates? (KX_TRUE, KX_FALSE)
@type local: boolean
"""
def getForceIpoActsLocal():
"""
Return whether to apply the force in the object's local
coordinates rather than the world global coordinates.
"""
|
