rita
Class RiTimer

java.lang.Object
  extended by rita.RiTimer
All Implemented Interfaces:
processing.core.PConstants, BehaviorListener, RiConstants

public class RiTimer
extends java.lang.Object
implements RiConstants, BehaviorListener

A basic timer implementation to which one can pass a PApplet, a RiTaEventListener, or any other object that implements the method: onRiTaEvent(RiTaEvent re)

Note: uses dynamic casting via the RiDynamicType object.

A typical use in Processing might be:

    void setup(RiTaEvent re)
    {
      new RiTimer(this, 1f);

        OR

      RiTimer.start(this, 1f);  
    }

    public void onRiTaEvent(RiTaEvent re)
    {
      // called every 1 second
    }
    
or, if (outside of Processing) onRiTaEvent(re) was in another class (e.g., MyApplet):
    public class MyApplet extends Applet 
    {
      RiTimer timer;
      public void init()
      {
        timer = new RiTimer(this, 1f);
      }

      public void onRiTaEvent(RiTaEvent re)
      {
        // called every 1 second
      }
    } 

Invisible:

Field Summary
static int TIMER_RESOLUTION
           
 
Fields inherited from interface rita.support.RiConstants
BEHAVIOR_COMPLETED, BOUNDING_BOX_ALPHA, BRILL_POS_TAGGER, EASE_IN, EASE_IN_CUBIC, EASE_IN_EXPO, EASE_IN_OUT, EASE_IN_OUT_CUBIC, EASE_IN_OUT_EXPO, EASE_IN_OUT_QUARTIC, EASE_IN_OUT_SINE, EASE_IN_QUARTIC, EASE_IN_SINE, EASE_OUT, EASE_OUT_CUBIC, EASE_OUT_EXPO, EASE_OUT_QUARTIC, EASE_OUT_SINE, ESS, FADE_COLOR, FADE_IN, FADE_OUT, FADE_TO_TEXT, FIRST_PERSON, FUTURE_TENSE, ID, LERP, LINEAR, MAXENT_POS_TAGGER, MINIM, MOVE, MUTABLE, PAST_TENSE, PHONEME_BOUNDARY, PHONEMES, PLING_STEMMER, PLURAL, PORTER_STEMMER, POS, PRESENT_TENSE, SCALE_TO, SECOND_PERSON, SENTENCE_BOUNDARY, SINGULAR, SONIA, SPEECH_COMPLETED, STRESSES, SYLLABLE_BOUNDARY, SYLLABLES, TEXT, TEXT_ENTERED, THIRD_PERSON, TIMER, TIMER_COMPLETED, TIMER_TICK, TOKENS, UNKNOWN, WORD_BOUNDARY
 
Fields inherited from interface processing.core.PConstants
A, AB, ADD, AG, ALPHA, ALPHA_MASK, ALT, AMBIENT, AR, ARC, ARGB, ARROW, B, BACKSPACE, BASELINE, BEEN_LIT, BEVEL, BLEND, BLUE_MASK, BLUR, BOTTOM, BOX, BURN, CENTER, CENTER_DIAMETER, CENTER_RADIUS, CHATTER, CLOSE, CMYK, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CUSTOM, DA, DARKEST, DB, DEG_TO_RAD, DELETE, DG, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ACCURATE_TEXTURES, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_OPENGL_2X_SMOOTH, DISABLE_OPENGL_ERROR_REPORT, DODGE, DOWN, DR, DXF, EB, EDGE, EG, ELLIPSE, ENABLE_ACCURATE_TEXTURES, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_2X_SMOOTH, ENABLE_OPENGL_4X_SMOOTH, ENABLE_OPENGL_ERROR_REPORT, ENTER, EPSILON, ER, ERODE, ERROR_BACKGROUND_IMAGE_FORMAT, ERROR_BACKGROUND_IMAGE_SIZE, ERROR_PUSHMATRIX_OVERFLOW, ERROR_PUSHMATRIX_UNDERFLOW, ERROR_TEXTFONT_NULL_PFONT, ESC, EXCLUSION, G, GIF, GRAY, GREEN_MASK, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LEFT, LIGHTEST, LINE, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MULTIPLY, NORMAL, NORMALIZED, NX, NY, NZ, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, platformNames, POINT, POINTS, POLYGON, POSTERIZE, PROBLEM, PROJECT, QUAD, QUAD_STRIP, QUADS, QUARTER_PI, R, RAD_TO_DEG, RADIUS, RECT, RED_MASK, REPLACE, RETURN, RGB, RIGHT, ROUND, SA, SB, SCREEN, SG, SHAPE, SHIFT, SHINE, SOFT_LIGHT, SPB, SPG, SPHERE, SPOT, SPR, SQUARE, SR, SUBTRACT, SW, TAB, TARGA, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, TX, TY, TZ, U, UP, V, VERTEX_FIELD_COUNT, VW, VX, VY, VZ, WAIT, WHITESPACE, WINDOWS, X, Y, Z
 
Constructor Summary
RiTimer(java.lang.Object pApplet, double duration)
           
RiTimer(java.lang.Object pApplet, double duration, boolean repeating)
           
RiTimer(java.lang.Object pApplet, double duration, java.lang.String timerName)
           
RiTimer(java.lang.Object pApplet, float duration)
           
RiTimer(java.lang.Object pApplet, float duration, boolean repeating)
           
RiTimer(java.lang.Object pApplet, float startTimeOffset, float duration, java.lang.String name, boolean repeating)
           
RiTimer(java.lang.Object pApplet, float duration, java.lang.String timerName)
           
RiTimer(java.lang.Object pApplet, float duration, java.lang.String name, boolean repeating)
           
 
Method Summary
 void addListener(java.lang.Object o)
           
 void behaviorCompleted(RiTextBehavior behavior)
           
 void delete()
           
 RiTextBehavior getBehavior()
           
 boolean isPaused()
           
 void pause(float time)
           
 void removeListener(java.lang.Object o)
           
 void removeListeners()
           
 void setPaused(boolean b)
           
static RiTimer start(java.lang.Object parent, float duration)
          A convenience method that creates, starts, & returns a repeating timer which calls the method 'parent.onRiTaEvent(RiTaEvent e)' every duration seconds.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TIMER_RESOLUTION

public static final int TIMER_RESOLUTION
See Also:
Constant Field Values
Invisible:
Constructor Detail

RiTimer

public RiTimer(java.lang.Object pApplet,
               float duration)

RiTimer

public RiTimer(java.lang.Object pApplet,
               float duration,
               boolean repeating)

RiTimer

public RiTimer(java.lang.Object pApplet,
               float duration,
               java.lang.String timerName)

RiTimer

public RiTimer(java.lang.Object pApplet,
               double duration)

RiTimer

public RiTimer(java.lang.Object pApplet,
               double duration,
               boolean repeating)

RiTimer

public RiTimer(java.lang.Object pApplet,
               double duration,
               java.lang.String timerName)

RiTimer

public RiTimer(java.lang.Object pApplet,
               float duration,
               java.lang.String name,
               boolean repeating)

RiTimer

public RiTimer(java.lang.Object pApplet,
               float startTimeOffset,
               float duration,
               java.lang.String name,
               boolean repeating)
Method Detail

start

public static RiTimer start(java.lang.Object parent,
                            float duration)
A convenience method that creates, starts, & returns a repeating timer which calls the method 'parent.onRiTaEvent(RiTaEvent e)' every duration seconds.


delete

public void delete()

setPaused

public void setPaused(boolean b)

isPaused

public boolean isPaused()

pause

public void pause(float time)

removeListener

public void removeListener(java.lang.Object o)

removeListeners

public void removeListeners()

addListener

public void addListener(java.lang.Object o)

behaviorCompleted

public void behaviorCompleted(RiTextBehavior behavior)
Specified by:
behaviorCompleted in interface BehaviorListener

getBehavior

public RiTextBehavior getBehavior()