Source code for bruhanimate.bruheffect.base_effect

"""
Copyright 2023 Ethan Christensen

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

from abc import abstractmethod

from ..bruhutil.bruhffer import Buffer



[docs]
class BaseEffect:
    """
    Class for keeping track of an effect, and updataing it's buffer
    """


[docs]
    def __init__(self, buffer: Buffer, background: str):
        """
        Base class for all effects.

        Args:
            buffer (Buffer): Effect buffer to push updates to.
            background (str): character or string to use for the background.
        """
        self.buffer = buffer
        self.background = background
        self.background_length = len(background)



[docs]
    @abstractmethod
    def render_frame(self, frame_number):
        """
        To be defined by each effect.
        """