cz.cuni.jagrlib.worker
Class AnimationWorker

java.lang.Object
  extended by cz.cuni.jagrlib.DefaultProperty
      extended by cz.cuni.jagrlib.Piece
          extended by cz.cuni.jagrlib.worker.AnimationWorker
All Implemented Interfaces:
Breakable, Property, Worker, Template, java.lang.Runnable

public class AnimationWorker
extends Piece
implements Worker

Meta-worker for animation rendering. Can be connected to any meta-worker-enabled Worker (see Worker.REJECT) and direct it to create sequence of pictures.

Expressions are handled by the JEP class. Two special pre-defined variables are provided to control the animation:

Template properties (fileNameTemplate, variable1Template, ..) are in format acceptable by the String.format() method (ala sprintf() in C). If integer format-tag is used (h, d, o, x), expression value is rounded to the nearest integer.

Since:
0.25
See Also:
AnimationWorker.java

Field Summary
protected static java.lang.String CATEGORY
          Object category.
static java.lang.String FILE_NAME_PROPERTY
           
static java.lang.String FILE_NAME_TEMPLATE
           
protected  java.lang.String fileNameProperty
          File-name property name.
protected  java.lang.String fileNameTemplate
          File-name template.
protected  int frame
          Actual frame.
static java.lang.String FRAME_OFFSET
           
protected  int frameOffset
          Number of first generated frame.
protected  int frames
          Number of frames to be rendered.
static java.lang.String FRAMES
           
static RegPiece reg
          Static registration instance for this class.
protected static java.lang.String TEMPLATE_NAME
          Object template identifier.
static java.lang.String VAR_FRAME
          Frame variable identifier.
static java.lang.String VAR_T
          Time variable identifier.
static java.lang.String VARIABLE1_EXPRESSION
           
static java.lang.String VARIABLE1_PROPERTY
           
static java.lang.String VARIABLE1_TEMPLATE
           
protected  java.lang.String variable1Expression
          Variable1: expression string.
protected  java.lang.String variable1Property
          Variable1: property name.
protected  java.lang.String variable1Template
          Variable1: format template.
static java.lang.String VARIABLE2_EXPRESSION
           
static java.lang.String VARIABLE2_PROPERTY
           
static java.lang.String VARIABLE2_TEMPLATE
           
protected  java.lang.String variable2Expression
          Variable2: expression string.
protected  java.lang.String variable2Property
          Variable2: property name.
protected  java.lang.String variable2Template
          Variable2: format template.
static java.lang.String VARIABLE3_EXPRESSION
           
static java.lang.String VARIABLE3_PROPERTY
           
static java.lang.String VARIABLE3_TEMPLATE
           
protected  java.lang.String variable3Expression
          Variable3: expression string.
protected  java.lang.String variable3Property
          Variable3: property name.
protected  java.lang.String variable3Template
          Variable3: format template.
 
Fields inherited from class cz.cuni.jagrlib.Piece
channels, info, pl, plugs, TEMPLATE_TYPE, userBreak
 
Fields inherited from interface cz.cuni.jagrlib.iface.Worker
REJECT, REPEAT, SEED
 
Fields inherited from interface cz.cuni.jagrlib.iface.Property
LOGGING, STATISTICS, TEXT_DESCRIPTION
 
Fields inherited from interface cz.cuni.jagrlib.Template
ALL_PLUGS, C_1D, C_2D, C_3D, C_ALPHA, C_BINARY, C_BREP, C_CAMERA, C_CIRCLE, C_CLIP, C_COMPRESSION, C_CURVE, C_DATA, C_DRAW, C_EDITOR, C_ELLIPSE, C_FILL, C_FILTER, C_FLOAT, C_FUNCTION, C_IMAGE, C_INTEGER, C_IO, C_LIGHT, C_LINE, C_METRIC, C_POLYGON, C_PROJECTION, C_RADIOSITY, C_RASTER, C_RENDER, C_SAMPLE, C_SCENE, C_SET, C_SOLID, C_TEXT, C_TRANSFORM, C_VECTOR, C_VIEWER, C_WORKER, CAT_EMPTY, EMPTY, IFACE, JAGRLIB, JAGRLIB2, MANIPULATOR_COMBO, MANIPULATOR_CUSTOM, MANIPULATOR_DEFAULT, MANIPULATOR_MULTILINE, PL_ALPHAMASK, PL_BITMASK, PL_CAUSTIC, PL_CODEC, PL_COLORMAP, PL_COMPARE, PL_DATA, PL_DIRECT, PL_EDITOR, PL_FILTER, PL_FUNCTION, PL_IMAGE, PL_IMPORT, PL_INPUT, PL_INTERSECTION, PL_LIGHTSOURCE, PL_ORDER, PL_OUTPUT, PL_PALETTE, PL_PHOTON, PL_PROPERTY, PL_QUANTIZER, PL_RASTER, PL_RENDER, PL_SHADOW, PL_STREAM, PL_TRANSFORM, PL_TRIGGER, PL_VOLUME, PL_WINDOW, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INTEGER, TYPE_LONG, TYPE_OBJECT, TYPE_STRING
 
Constructor Summary
AnimationWorker()
           
 
Method Summary
 java.lang.Object get(java.lang.String key)
          Gets the given property.
 void run()
          Executive routine of the working thread.
 void set(java.lang.String key, java.lang.Object value)
          Sets the given property.
static int setTemplate(Template t, int ord)
          General-purpose registration routine.
 
Methods inherited from class cz.cuni.jagrlib.Piece
className, connect, findPlug, findPlug, getInfo, getInterface, getInterface, getPlug, getReg, init, isCompatible, isCompatible, isConnected, logError, logWarning, myInterface, newInputPlug, newOptOutputPlug, newOutputPlug, newPlug, noTemplates, propBegin, propBounds, propDefault, propEnd, propEnum, propManipulator, propManipulator, setProgressListener, setRegStrings, setTemplateDynamic, stop
 
Methods inherited from class cz.cuni.jagrlib.DefaultProperty
booleanProperty, booleanProperty, colorDoubleProperty, colorProperty, commit, doubleProperty, doubleProperty, doubleProperty, enumProperty, floatProperty, floatProperty, floatProperty, intProperty, intProperty, intProperty, longProperty, longProperty, longProperty, set, stringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface cz.cuni.jagrlib.iface.Property
commit
 
Methods inherited from interface cz.cuni.jagrlib.Breakable
setProgressListener, stop
 

Field Detail

VAR_T

public static final java.lang.String VAR_T
Time variable identifier.

See Also:
Constant Field Values

VAR_FRAME

public static final java.lang.String VAR_FRAME
Frame variable identifier.

See Also:
Constant Field Values

frames

protected int frames
Number of frames to be rendered.


frame

protected int frame
Actual frame.


fileNameProperty

protected java.lang.String fileNameProperty
File-name property name.


fileNameTemplate

protected java.lang.String fileNameTemplate
File-name template.


frameOffset

protected int frameOffset
Number of first generated frame.


variable1Property

protected java.lang.String variable1Property
Variable1: property name.


variable1Expression

protected java.lang.String variable1Expression
Variable1: expression string.


variable1Template

protected java.lang.String variable1Template
Variable1: format template.


variable2Property

protected java.lang.String variable2Property
Variable2: property name.


variable2Expression

protected java.lang.String variable2Expression
Variable2: expression string.


variable2Template

protected java.lang.String variable2Template
Variable2: format template.


variable3Property

protected java.lang.String variable3Property
Variable3: property name.


variable3Expression

protected java.lang.String variable3Expression
Variable3: expression string.


variable3Template

protected java.lang.String variable3Template
Variable3: format template.


FRAMES

public static final java.lang.String FRAMES
See Also:
Constant Field Values

FILE_NAME_PROPERTY

public static final java.lang.String FILE_NAME_PROPERTY
See Also:
Constant Field Values

FILE_NAME_TEMPLATE

public static final java.lang.String FILE_NAME_TEMPLATE
See Also:
Constant Field Values

FRAME_OFFSET

public static final java.lang.String FRAME_OFFSET
See Also:
Constant Field Values

VARIABLE1_PROPERTY

public static final java.lang.String VARIABLE1_PROPERTY
See Also:
Constant Field Values

VARIABLE1_TEMPLATE

public static final java.lang.String VARIABLE1_TEMPLATE
See Also:
Constant Field Values

VARIABLE1_EXPRESSION

public static final java.lang.String VARIABLE1_EXPRESSION
See Also:
Constant Field Values

VARIABLE2_PROPERTY

public static final java.lang.String VARIABLE2_PROPERTY
See Also:
Constant Field Values

VARIABLE2_TEMPLATE

public static final java.lang.String VARIABLE2_TEMPLATE
See Also:
Constant Field Values

VARIABLE2_EXPRESSION

public static final java.lang.String VARIABLE2_EXPRESSION
See Also:
Constant Field Values

VARIABLE3_PROPERTY

public static final java.lang.String VARIABLE3_PROPERTY
See Also:
Constant Field Values

VARIABLE3_TEMPLATE

public static final java.lang.String VARIABLE3_TEMPLATE
See Also:
Constant Field Values

VARIABLE3_EXPRESSION

public static final java.lang.String VARIABLE3_EXPRESSION
See Also:
Constant Field Values

TEMPLATE_NAME

protected static final java.lang.String TEMPLATE_NAME
Object template identifier.

See Also:
Constant Field Values

CATEGORY

protected static final java.lang.String CATEGORY
Object category.

See Also:
Constant Field Values

reg

public static final RegPiece reg
Static registration instance for this class. Automatically initialized in class-loading time.

Constructor Detail

AnimationWorker

public AnimationWorker()
Method Detail

run

public void run()
Executive routine of the working thread.

Specified by:
run in interface java.lang.Runnable

set

public void set(java.lang.String key,
                java.lang.Object value)
Sets the given property.

Specified by:
set in interface Property
Overrides:
set in class DefaultProperty
Parameters:
key - Key string.
value - The new value.
See Also:
Property.commit()

get

public java.lang.Object get(java.lang.String key)
Gets the given property.

Specified by:
get in interface Property
Overrides:
get in class DefaultProperty
Parameters:
key - Key string.
Returns:
The actual value or null.

setTemplate

public static int setTemplate(Template t,
                              int ord)
General-purpose registration routine. Sets all plugs, strings, etc. to the given Template.