Class AbstractFilteredComposer

  • All Implemented Interfaces:
    FrameComposer
    Direct Known Subclasses:
    TimeShiftedComposer

    public abstract class AbstractFilteredComposer
    extends java.lang.Object
    implements FrameComposer
    This is an abstract base class for composition filters: compositions which modify the behaviour of other compositions.
    Since:
    3.0
    Author:
    Chris Jennings
    • Constructor Detail

      • AbstractFilteredComposer

        public AbstractFilteredComposer​(FrameComposer composer)
        Creates a filter for an existing composition.
        Parameters:
        composer - the composition to filter
        Throws:
        java.lang.NullPointerException - if the composer is null
      • AbstractFilteredComposer

        public AbstractFilteredComposer​(Animation animation)
        Creates a filter for an animation. This will create a filter for the composition set on the animation and then replace the animation's composition with this filter.
        Parameters:
        animation - the animation whose composer should be filtered
        Throws:
        java.lang.NullPointerException - if the animation is null
    • Method Detail

      • getComposer

        public FrameComposer getComposer()
        Returns the filtered composer.
        Returns:
        the composer being immediately filtered by this composer
      • setComposer

        public void setComposer​(FrameComposer composer)
        Sets the composer to be filtered.
        Parameters:
        composer - the composer to which filtering will be applied
        Throws:
        java.lang.NullPointerException - if the composer is null