Skip to content

Animation

Add

Bases: Animation

Represents an add animation.

Attributes:

Name Type Description
mode str

The mode of the animation.

Methods:

Name Description
__init__

Initializes the animation.

Parameters:

Name Type Description Default
phobject Phobject

The phobject to add.

 required
mode str

The mode of the animation.

 'smooth'
Source code in src/phanim/animate.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
class Add(Animation):
    """
    Represents an add animation.

    Attributes:
        mode (str): The mode of the animation.

    Methods:
        __init__(phobject, mode): Initializes the animation.

    Args:
        phobject (Phobject): The phobject to add.
        mode (str): The mode of the animation.
    """

    mode = "add"

    def __init__(self, phobject, mode="smooth"):
        super().__init__(phobject, 1, mode)

AnimateValue

Bases: Animation

Represents an animation of a value.

Attributes:

Name Type Description
function function

The function to animate.
target object

The target of the animation.
duration int

The duration of the animation.
currentFrame int

The current frame of the animation.
animationMode str

The mode of the animation.

Methods:

Name Description
__init__

Initializes the animation.
update

Updates the animation.
Source code in src/phanim/animate.py 
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
class AnimateValue(Animation):
    """
    Represents an animation of a value.

    Attributes:
        function (function): The function to animate.
        target (object): The target of the animation.
        duration (int): The duration of the animation.
        currentFrame (int): The current frame of the animation.
        animationMode (str): The mode of the animation.

    Methods:
        __init__(function, target, duration, mode): Initializes the animation.
        update(): Updates the animation.
    """
    mode = None

    def __init__(self, function, target, duration=60, mode="smooth"):
        self.duration = duration
        self.currentFrame = 0
        self.animationMode = mode
        self.function = function
        self.target = target

    def update(self):
        self.function(interp(self.target[0], self.target[1], self.t))

Animation

Represents an animation of a phobject.

Attributes:

Name Type Description
object Phobject

The phobject being animated.
position list

The position of the phobject.
duration int

The duration of the animation.
currentFrame int

The current frame of the animation.
oldPhobject Phobject

A copy of the original phobject.
animationMode str

The mode of the animation.

Methods:

Name Description
__init__

Initializes the animation.
updateAndPrint

Updates the animation and prints the current state.
Source code in src/phanim/animate.py 
 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
class Animation():

    """
    Represents an animation of a phobject.

    Attributes:
        object (Phobject): The phobject being animated.
        position (list): The position of the phobject.
        duration (int): The duration of the animation.
        currentFrame (int): The current frame of the animation.
        oldPhobject (Phobject): A copy of the original phobject.
        animationMode (str): The mode of the animation.

    Methods:
        __init__(phobject, duration, mode): Initializes the animation.
        updateAndPrint(): Updates the animation and prints the current state.
    """

    def __init__(self, phobject, duration=60, mode="smoothstep"):
        self.object = phobject
        self.position = phobject.position
        self.duration = duration
        self.currentFrame = 0
        self.oldPhobject = copy(phobject)
        self.animationMode = mode

        self.static = False
        if hasattr(phobject, "static"):
            if phobject.static:
                self.static = True

    def updateAndPrint(self):
        """
        Updates the animation and prints the current state.

        This method updates the animation based on the current frame and the animation mode.
        It then updates the object's attributes and prints the current state of the animation.

        Parameters:
            None

        Returns:
            None
        """

        t = self.currentFrame / self.duration
        if self.animationMode == "smoothstep":
            self.t = interp(t**2, np.sqrt(t), t)
        if self.animationMode == "smooth":
            a = interp(0, 1, t)
            b = interp(0, a, t)
            c = interp(a, 1, t)
            self.t = interp(b, c, t)
        if self.animationMode == "linear":
            self.t = t
        self.update()

        if hasattr(self, "object"):
            if hasattr(self.object, "groupObjects"):
                for obj in self.object.groupObjects:
                    self.groupObjects = self.object.groupObjects
            else:
                self.__setAttributes(self.object)

    def __setAttributes(self, obj):
        if hasattr(self.object, 'lines'):
            self.lines = self.object.lines
            self.lineWidth = self.object.lineWidth
        if hasattr(self.object, 'circles'):
            self.circles = self.object.circles
        if hasattr(self.object, "polygons"):
            self.polygons = self.object.polygons
            self.color = self.object.color
        if hasattr(self.object, "texts"):
            self.texts = self.object.texts

    def update(self):
        pass

updateAndPrint()

Updates the animation and prints the current state.

This method updates the animation based on the current frame and the animation mode. It then updates the object's attributes and prints the current state of the animation.

Returns:

Type Description

None
Source code in src/phanim/animate.py 
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
def updateAndPrint(self):
    """
    Updates the animation and prints the current state.

    This method updates the animation based on the current frame and the animation mode.
    It then updates the object's attributes and prints the current state of the animation.

    Parameters:
        None

    Returns:
        None
    """

    t = self.currentFrame / self.duration
    if self.animationMode == "smoothstep":
        self.t = interp(t**2, np.sqrt(t), t)
    if self.animationMode == "smooth":
        a = interp(0, 1, t)
        b = interp(0, a, t)
        c = interp(a, 1, t)
        self.t = interp(b, c, t)
    if self.animationMode == "linear":
        self.t = t
    self.update()

    if hasattr(self, "object"):
        if hasattr(self.object, "groupObjects"):
            for obj in self.object.groupObjects:
                self.groupObjects = self.object.groupObjects
        else:
            self.__setAttributes(self.object)

Create

Bases: Animation

Represents a create animation.

Attributes:

Name Type Description
mode str

The mode of the create animation.

Methods:

Name Description
update

Updates the create animation.
Source code in src/phanim/animate.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class Create(Animation):
    """
    Represents a create animation.

    Attributes:
        mode (str): The mode of the create animation.

    Methods:
        update(): Updates the create animation.
    """
    mode = "add"

    def update(self):
        self.object.createFunction(self.t, self.oldPhobject)

Destroy

Bases: Animation

Represents a destroy animation.

Attributes:

Name Type Description
mode str

The mode of the destroy animation.

Methods:

Name Description
update

Updates the destroy animation.
Source code in src/phanim/animate.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
class Destroy(Animation):
    """
    Represents a destroy animation.

    Attributes:
        mode (str): The mode of the destroy animation.

    Methods:
        update(): Updates the destroy animation.
    """
    mode = "remove"

    def update(self):
        self.object.createFunction(1-self.t, self.oldPhobject)

Move

Bases: Animation

Represents a move animation.

Attributes:

Name Type Description
object Phobject

The phobject to move.

Methods:

Name Description
update

Updates the move animation.

Parameters:

Name Type Description Default
phobject Phobject

The phobject to move.

 required
Source code in src/phanim/animate.py 
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
class Move(Animation):
    """
    Represents a move animation.

    Attributes:
        object (Phobject): The phobject to move.

    Methods:
        update(): Updates the move animation.

    Args:
        phobject (Phobject): The phobject to move.
    """
    mode = None

    def __init__(self, phobject, target, duration=60, mode="smooth"):
        super().__init__(phobject, duration, mode)
        self.target = target

    def update(self):
        self.object.setPosition(
            interp(self.oldPhobject.position, self.target, self.t))

Remove

Bases: Animation

Represents a remove animation.

Attributes:

Name Type Description
mode str

The mode of the animation.

Methods:

Name Description
__init__

Initializes the animation.

Parameters:

Name Type Description Default
phobject Phobject

The phobject to remove.

 required
mode str

The mode of the animation.

 'smooth'
Source code in src/phanim/animate.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
class Remove(Animation):
    """
    Represents a remove animation.

    Attributes:
        mode (str): The mode of the animation.

    Methods:
        __init__(phobject, mode): Initializes the animation.

    Args:
        phobject (Phobject): The phobject to remove.
        mode (str): The mode of the animation.
    """
    mode = "remove"

    def __init__(self, phobject, mode="smooth"):
        super().__init__(phobject, 1, mode)

Shift

Bases: Move

Represents a shift animation.

Methods:

Name Description
update

Updates the shift animation.
Source code in src/phanim/animate.py 
238
239
240
241
242
243
244
245
246
247
248
class Shift(Move):
    """
    Represents a shift animation.

    Methods:
        update(): Updates the shift animation.
    """

    def update(self):
        self.object.setPosition(interp(
            self.oldPhobject.position, self.oldPhobject.position+self.target, self.t))

Sleep

Bases: Animation

Represents a sleep animation.

Attributes:

Name Type Description
duration int

The duration of the sleep animation.

Methods:

Name Description
__init__

Initializes the sleep animation.

Parameters:

Name Type Description Default
duration int

The duration of the sleep animation.

 required
Source code in src/phanim/animate.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
class Sleep(Animation):
    """
    Represents a sleep animation.

    Attributes:
        duration (int): The duration of the sleep animation.

    Methods:
        __init__(duration): Initializes the sleep animation.

    Args:
        duration (int): The duration of the sleep animation.
    """
    mode = None

    def __init__(self, duration):
        self.animationMode = "linear"
        self.object = None
        self.duration = duration
        self.currentFrame = 0

Transform

Bases: Animation

Represents a transformation animation.

Attributes:

Name Type Description
newPhobject Phobject

The new phobject to transform into.
duration int

The duration of the animation.
mode str

The mode of the animation.

Methods:

Name Description
__init__

Initializes the animation.
update

Updates the animation.

Parameters:

Name Type Description Default
phobject Phobject

The phobject to transform.

 required
newPhobject Phobject

The new phobject to transform into.

 required
duration int

The duration of the animation.

 60
mode str

The mode of the animation.

 'smooth'
Source code in src/phanim/animate.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class Transform(Animation):
    """
    Represents a transformation animation.

    Attributes:
        newPhobject (Phobject): The new phobject to transform into.
        duration (int): The duration of the animation.
        mode (str): The mode of the animation.

    Methods:
        __init__(phobject, newPhobject, duration, mode): Initializes the animation.
        update(): Updates the animation.

    Args:
        phobject (Phobject): The phobject to transform.
        newPhobject (Phobject): The new phobject to transform into.
        duration (int): The duration of the animation.
        mode (str): The mode of the animation.
    """
    mode = None

    def __init__(self, phobject, newPhobject, duration=60, mode="smooth"):
        super().__init__(phobject, duration, mode)
        self.newPhobject = newPhobject

    def update(self):
        self.object.transformFunction(
            self.t, self.oldPhobject, self.newPhobject)
        self.object.position = interp(
            self.oldPhobject.position, self.newPhobject.position, self.t)

laggedStart

Represents a lagged start animation.

Attributes:

Name Type Description
animations list

The list of animations.
playingAnimations list

The list of playing animations.
currentFrame int

The current frame of the animation.
lagRatio float

The lag ratio of the animation.

Methods:

Name Description
__init__

Initializes the animation.
updateAndPrint

Updates the animation and prints the current state.
__setDuration

Sets the duration of the animation.
Source code in src/phanim/animate.py 
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
class laggedStart():
    """
    Represents a lagged start animation.

    Attributes:
        animations (list): The list of animations.
        playingAnimations (list): The list of playing animations.
        currentFrame (int): The current frame of the animation.
        lagRatio (float): The lag ratio of the animation.

    Methods:
        __init__(*args, lagRatio): Initializes the animation.
        updateAndPrint(): Updates the animation and prints the current state.
        __setDuration(): Sets the duration of the animation.
    """
    mode = "wrapper"

    def __init__(self, *args, lagRatio=0.1):
        self.animations = args
        self.playingAnimations = [self.animations[0]]
        self.currentFrame = 0
        self.lagRatio = lagRatio
        self.__setDuration()

    def updateAndPrint(self):
        if self.playingAnimations[-1].currentFrame/self.playingAnimations[-1].duration > self.lagRatio:
            if len(self.playingAnimations) < len(self.animations):
                self.playingAnimations.append(
                    self.animations[len(self.playingAnimations)])

        for animation in self.playingAnimations:
            animation.updateAndPrint()
            if animation.currentFrame < animation.duration:
                animation.currentFrame += 1

    def __setDuration(self):
        self.duration = 0
        for animation in self.animations:
            self.duration += animation.duration*self.lagRatio
        self.duration += self.animations[-1].duration*(1-self.lagRatio)
        self.duration = int(self.duration)+len(self.animations)