rita
Class RiTaEvent

java.lang.Object
  java.util.EventObject
      rita.RiTaEvent

All Implemented Interfaces:

java.io.Serializable, processing.core.PConstants, RiConstants

public class RiTaEvent
extends java.util.EventObject
implements RiConstants

Simple class for event-based callbacks (generally dynamically dispatched to PApplet subclasses).

A typical usage is to switch on the type of a RiTaEvent within a callback:

    public void onRiTaEvent(RiTaEvent re)
    {
      switch (re.getType()) {
        case RiTa.TIMER_TICK:
           ...
        case RiTa.TEXT_ENTERED:
           ...
        case RiTa.SPEECH_COMPLETED:
           ...
        case RiTa.BEHAVIOR_COMPLETED:
           ...
      }
    }

See Also:

Serialized Form

Field Summary

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

RiTaEvent(java.lang.Object source, int type)

RiTaEvent(java.lang.Object source, int type, java.lang.Object data)

Method Summary

java.lang.Object	getData() Returns auxillary data that varies based on the different event types. For example, if type == SPEECH_COMPLETED, then data will contain a String with the last spoken text.
java.lang.String	getDescription() Deprecated.
int	getId()
java.lang.String	getName() Return the user-specified name for this event, or for the associated TextBehavior.
java.lang.String	getTag() Deprecated.
int	getType() Returns one of the event types specified in the RiConstants interface, e.g., BEHAVIOR_COMPLETED, or SPEECH_COMPLETED.
java.lang.String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RiTaEvent

public RiTaEvent(java.lang.Object source,
                 int type)

RiTaEvent

public RiTaEvent(java.lang.Object source,
                 int type,
                 java.lang.Object data)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject

getDescription

public java.lang.String getDescription()

Deprecated.

See Also:

getData()

Invisible:

getType

public int getType()

Returns one of the event types specified in the RiConstants interface, e.g., BEHAVIOR_COMPLETED, or SPEECH_COMPLETED.

To test, use the following syntax:

    if (re.getType() == RiTa.BEHAVIOR_COMPLETED)
      // do something
 

See Also:

RiTextBehavior, RiSpeech

getData

public java.lang.Object getData()

Returns auxillary data that varies based on the different event types.
For example,

• if type == SPEECH_COMPLETED, then data will contain a String with the last spoken text.
• if type == TEXT_ENTERED, then data will contain a String with the entered text.
• if type == BEHAVIOR_COMPLETED, or type == TIMER_COMPLETED, then data will contain the RiTextBehavior object that has just completed.

See Also:

RiTextBehavior, RiSpeech

getName

public java.lang.String getName()

Return the user-specified name for this event, or for the associated TextBehavior. For example, if a name has been assigned to a RiTa timer which generated this event, it will be accessible here.

getTag

public java.lang.String getTag()

Deprecated.

See Also:

getName()

Invisible:

getId

public int getId()