Class TimeContainer

java.lang.Object
org.apache.batik.anim.timing.TimedElement
org.apache.batik.anim.timing.TimeContainer
All Implemented Interfaces:
SMILConstants
Direct Known Subclasses:
TimedDocumentRoot

public abstract class TimeContainer extends TimedElement
An abstract base class for time container elements.
Version:
$Id: TimeContainer.java 1804130 2017-08-04 14:41:11Z ssteiner $
  • Field Details

    • children

      protected List children
      The child TimedElements of this time container.
  • Constructor Details

    • TimeContainer

      public TimeContainer()
  • Method Details

    • addChild

      public void addChild(TimedElement e)
      Adds a TimedElement to this container.
    • setRoot

      protected void setRoot(TimedElement e, TimedDocumentRoot root)
      Recursively sets the TimedDocumentRoot of the given TimedElement and any of its descendants.
    • removeChild

      public void removeChild(TimedElement e)
      Removes a TimedElement from this container.
    • getChildren

      public TimedElement[] getChildren()
      Returns an array of the children of this container.
    • sampleAt

      protected float sampleAt(float parentSimpleTime, boolean hyperlinking)
      Calculates the local simple time. Currently the hyperlinking parameter is ignored, so DOM timing events are fired during hyperlinking seeks. If we were following SMIL 2.1 rather than SMIL Animation, then these events would have to be surpressed.
      Overrides:
      sampleAt in class TimedElement
      Returns:
      the number of seconds until this element becomes active again if it currently is not, Float.POSITIVE_INFINITY if this element will become active at some undetermined point in the future (because of unresolved begin times, for example) or will never become active again, or 0f if the element is currently active.
    • sampleChildren

      protected float sampleChildren(float parentSimpleTime, boolean hyperlinking)
      Samples all the child timed elements.
    • reset

      protected void reset(boolean clearCurrentBegin)
      Resets this element.
      Overrides:
      reset in class TimedElement
    • isConstantAnimation

      protected boolean isConstantAnimation()
      Returns whether this timed element is for a constant animation (i.e., a 'set' animation.
      Specified by:
      isConstantAnimation in class TimedElement
    • getDefaultBegin

      public abstract float getDefaultBegin(TimedElement child)
      Returns the default begin time for the given child timed element.