kinetic.util
Class CompositeEffect

java.lang.Object
  |
  +--kinetic.util.CompositeEffect
Direct Known Subclasses:
ConstructEffect, HopInEffect, SlideEffect, YellEffect

public abstract class CompositeEffect
extends java.lang.Object

Composite Effect encapsulates complex generalized aniatmion templates. It provides an interface for connecting to a segmenter which produces segmenet of words and manages the progression of time through an effect. This is a base class to be extended by specific effects. It alos makes efforts in being able to describe itself in enough detail to a UI


Field Summary
protected  java.util.ArrayList mParameterList
          list of parameters
protected  kinetic.util.Segmenter mSegmenter
          text segmenter
protected  java.util.ArrayList mTagList
          list of tags
protected  java.lang.String name
          effect name
 
Constructor Summary
CompositeEffect()
          Creates a new instance of CompositeEffect
CompositeEffect(kinetic.util.Segmenter segmenter)
          creates a new instance of CompositeEffect with a segmenter
 
Method Summary
protected  void addParameter(kinetic.util.EffectParameter p)
          register/add paramter for UI
protected  void addTag(java.lang.String tag)
          register/add tag for UI
 double build(kinetic.Sequence seq, java.awt.Graphics2D g2, java.awt.Rectangle bounds, double delay)
          helper build routine when no segmeneter is provided, word segmenter is defaulted
abstract  double build(kinetic.Sequence seq, kinetic.util.Segmenter seg, java.awt.Graphics2D g2, java.awt.Rectangle bounds, double delay)
          routine to be called when the animation is requested to be built
 java.lang.String getName()
          get name
protected  java.lang.Object getParameter(int index)
          get paramter by index
 java.util.ArrayList getParameterList()
          get paramter list
 java.util.ArrayList getTagList()
          get tag list
 void setParameters(java.lang.Object[] values)
          set parameters
 void setParamterCurrentObject(int index, java.lang.Object o)
          set the value object of an indexed parameter
 void setSegmenter(kinetic.util.Segmenter newSegmenter)
          set segmenter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected java.lang.String name
effect name


mSegmenter

protected kinetic.util.Segmenter mSegmenter
text segmenter


mParameterList

protected java.util.ArrayList mParameterList
list of parameters


mTagList

protected java.util.ArrayList mTagList
list of tags

Constructor Detail

CompositeEffect

public CompositeEffect()
Creates a new instance of CompositeEffect


CompositeEffect

public CompositeEffect(kinetic.util.Segmenter segmenter)
creates a new instance of CompositeEffect with a segmenter

Parameters:
segmenter - a text segmenter
Method Detail

build

public abstract double build(kinetic.Sequence seq,
                             kinetic.util.Segmenter seg,
                             java.awt.Graphics2D g2,
                             java.awt.Rectangle bounds,
                             double delay)
routine to be called when the animation is requested to be built

Parameters:
seq - sequence to have the anmiation added to
seg - segmenter that will feed the animation template
g2 - graphics handle
bounds - drawing window size
delay - time delay before animation should start - ms
Returns:
the length of the resulting animation sequence ms

build

public double build(kinetic.Sequence seq,
                    java.awt.Graphics2D g2,
                    java.awt.Rectangle bounds,
                    double delay)
helper build routine when no segmeneter is provided, word segmenter is defaulted

Parameters:
seq - sequence to have the anmiation added to
g2 - graphics handle
bounds - drawing window size
delay - time delay before animation should start - ms
Returns:
the length of the resulting animation sequence ms

setSegmenter

public void setSegmenter(kinetic.util.Segmenter newSegmenter)
set segmenter

Parameters:
newSegmenter - new segmenter

addParameter

protected void addParameter(kinetic.util.EffectParameter p)
register/add paramter for UI

Parameters:
p - instance of parameter

addTag

protected void addTag(java.lang.String tag)
register/add tag for UI

Parameters:
tag - name of a tag

getParameter

protected java.lang.Object getParameter(int index)
get paramter by index

Parameters:
index - parameter index
Returns:
indexed paramter

getParameterList

public java.util.ArrayList getParameterList()
get paramter list

Returns:
paramter list

getTagList

public java.util.ArrayList getTagList()
get tag list

Returns:
list of tags

setParameters

public void setParameters(java.lang.Object[] values)
set parameters

Parameters:
values - array of paramter type objects

setParamterCurrentObject

public void setParamterCurrentObject(int index,
                                     java.lang.Object o)
set the value object of an indexed parameter

Parameters:
index - parameter index
o - value object

getName

public java.lang.String getName()
get name

Returns:
name