PyDMXControl.effects.defaults._Effect

Complexity

Total Complexity

9

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	Effect.__init__()	0	13	1
A	Effect.callback()	0	2	1
A	Effect.__callback()	0	3	2
A	Effect.stop()	0	3	1
A	Effect.start()	0	3	1
A	Effect.pause()	0	3	1
A	Effect.group_apply()	0	10	2

"""
 *  PyDMXControl: A Python 3 module to control DMX using OpenDMX or uDMX.
 *                Featuring fixture profiles, built-in effects and a web control panel.
 *  <https://github.com/MattIPv4/PyDMXControl/>
 *  Copyright (C) 2021 Matt Cowley (MattIPv4) (me@mattcowley.co.uk)
"""

from typing import List


class Effect:

    def __init__(self, fixture: 'Fixture', speed: float, *, delay: float = 0, offset: float = 0):
        # The fixture effect is applied to
        self.fixture = fixture

        # Speed for effect to complete
        self.speed = speed

        # Delay & offset to allow effect stacking across fixtures
        self.delay = delay / 100
        self.offset = offset / 100

        # Animating flag for ticket
        self.__animating = False

    def __callback(self):
        if self.__animating:
            self.callback()

    def callback(self):
        pass

    def pause(self) -> bool:
        self.__animating = not self.__animating
        return self.__animating

    def stop(self):
        self.__animating = False
        self.fixture.controller.ticker.remove_callback(self.__callback)

    def start(self):
        self.__animating = True
        self.fixture.controller.ticker.add_callback(self.__callback, 0)

    @classmethod
    def group_apply(cls, fixtures: List['Fixture'], speed: float, *args, **kwargs):
        # Position
        index = 0
        total = len(fixtures) - 1

        # Iterate over each
        for fixture in fixtures:
            fixture.add_effect(cls, speed, delay=total * 100, offset=index * 100, *args, **kwargs)
            index += 1