|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Template
Template for Piece
class - abstract specimen for data-flow node.
Instances of Template
object are used as nodes in graph of execution
while instances of Channel
object are connecting them as graph edges.
Field Summary | |
---|---|
static int |
ALL_PLUGS
Connect all plugs (for Piece.setTemplateDynamic(cz.cuni.jagrlib.Template, int) ). |
static java.lang.String |
C_1D
category string: 1D |
static java.lang.String |
C_2D
category string: 2D |
static java.lang.String |
C_3D
category string: 3D |
static java.lang.String |
C_ALPHA
category string: alpha |
static java.lang.String |
C_BINARY
category string: binary |
static java.lang.String |
C_BREP
category string: brep |
static java.lang.String |
C_CAMERA
category string: camera |
static java.lang.String |
C_CIRCLE
category string: circle |
static java.lang.String |
C_CLIP
category string: clip |
static java.lang.String |
C_COMPRESSION
category string: compression |
static java.lang.String |
C_CURVE
category string: line |
static java.lang.String |
C_DATA
category string: data |
static java.lang.String |
C_DRAW
category string: draw |
static java.lang.String |
C_EDITOR
category string: editor |
static java.lang.String |
C_ELLIPSE
category string: ellipse |
static java.lang.String |
C_FILL
category string: fill |
static java.lang.String |
C_FILTER
category string: filter |
static java.lang.String |
C_FLOAT
category string: float |
static java.lang.String |
C_FUNCTION
category string: function |
static java.lang.String |
C_IMAGE
category string: image |
static java.lang.String |
C_INTEGER
category string: integer |
static java.lang.String |
C_IO
category string: io |
static java.lang.String |
C_LIGHT
category string: light |
static java.lang.String |
C_LINE
category string: line |
static java.lang.String |
C_METRIC
category string: metric |
static java.lang.String |
C_POLYGON
category string: polygon |
static java.lang.String |
C_PROJECTION
category string: projection |
static java.lang.String |
C_RADIOSITY
category string: radiosity |
static java.lang.String |
C_RASTER
category string: raster |
static java.lang.String |
C_RENDER
category string: render |
static java.lang.String |
C_SAMPLE
category string: sample |
static java.lang.String |
C_SCENE
category string: scene |
static java.lang.String |
C_SET
category string: set |
static java.lang.String |
C_SOLID
category string: solid |
static java.lang.String |
C_TEXT
category string: text |
static java.lang.String |
C_TRANSFORM
category string: transform |
static java.lang.String |
C_VECTOR
category string: vector |
static java.lang.String |
C_VIEWER
category string: viewer |
static java.lang.String |
C_WORKER
category string: worker |
static java.lang.String |
CAT_EMPTY
Undefined category name. |
static java.lang.String |
EMPTY
Generic string initializer. |
static java.lang.String |
IFACE
Interface prefix = "cz.cuni.jagrlib.iface.". |
static java.lang.String |
JAGRLIB
Base JaGrLib package. |
static java.lang.String |
JAGRLIB2
Base JaGrLib package with trailing dot. |
static int |
MANIPULATOR_COMBO
List-box manipulator (for integer values only). |
static int |
MANIPULATOR_CUSTOM
Custom manipulator specified by its class name. |
static int |
MANIPULATOR_DEFAULT
Default manipulator (single edit line, checkbox, ..). |
static int |
MANIPULATOR_MULTILINE
Multi-line text area (for strings only). |
static java.lang.String |
PL_ALPHAMASK
Alpha-mask Plug identifier. |
static java.lang.String |
PL_BITMASK
Bit-mask Plug identifier. |
static java.lang.String |
PL_CAUSTIC
Caustic map Plug identifier. |
static java.lang.String |
PL_CODEC
Codec Plug identifier. |
static java.lang.String |
PL_COLORMAP
Colormap Plug identifier. |
static java.lang.String |
PL_COMPARE
Compare Plug identifier. |
static java.lang.String |
PL_DATA
Data Plug identifier. |
static java.lang.String |
PL_DIRECT
Direct Plug identifier. |
static java.lang.String |
PL_EDITOR
Editor Plug identifier. |
static java.lang.String |
PL_FILTER
Filter Plug identifier. |
static java.lang.String |
PL_FUNCTION
Function Plug identifier. |
static java.lang.String |
PL_IMAGE
Raster image Plug identifier. |
static java.lang.String |
PL_IMPORT
Import Plug identifier. |
static java.lang.String |
PL_INPUT
Generic input Plug identifier. |
static java.lang.String |
PL_INTERSECTION
Intersectable Plug identifier. |
static java.lang.String |
PL_LIGHTSOURCE
Light-source Plug identifier. |
static java.lang.String |
PL_ORDER
Order Plug identifier. |
static java.lang.String |
PL_OUTPUT
Generic output Plug identifier. |
static java.lang.String |
PL_PALETTE
Palette Plug identifier. |
static java.lang.String |
PL_PHOTON
Photon map Plug identifier. |
static java.lang.String |
PL_PROPERTY
Property Plug identifier. |
static java.lang.String |
PL_QUANTIZER
Quantizer Plug identifier. |
static java.lang.String |
PL_RASTER
Raster image Plug identifier. |
static java.lang.String |
PL_RENDER
Render Plug identifier. |
static java.lang.String |
PL_SHADOW
Shadow map Plug identifier. |
static java.lang.String |
PL_STREAM
[Bit-]stream Plug identifier. |
static java.lang.String |
PL_TRANSFORM
Transform Plug identifier. |
static java.lang.String |
PL_TRIGGER
Trigger Plug identifier. |
static java.lang.String |
PL_VOLUME
Volume map Plug identifier. |
static java.lang.String |
PL_WINDOW
Window Plug identifier. |
static java.lang.String |
TYPE_BOOLEAN
|
static java.lang.String |
TYPE_DOUBLE
|
static java.lang.String |
TYPE_FLOAT
|
static java.lang.String |
TYPE_INTEGER
|
static java.lang.String |
TYPE_LONG
|
static java.lang.String |
TYPE_OBJECT
|
static java.lang.String |
TYPE_STRING
|
Method Summary | |
---|---|
void |
newInputPlug(java.lang.String key,
java.lang.String _inputInterface)
Connects a new input Plug . |
void |
newOptOutputPlug(java.lang.String key,
java.lang.String _outputInterface)
Connects a new optional output Plug . |
void |
newOutputPlug(java.lang.String key,
java.lang.String _outputInterface)
Connects a new output Plug . |
void |
newPlug(java.lang.String key,
boolean _mandatory,
boolean _multi,
boolean _cloneable,
java.lang.String _inputInterface,
java.lang.String _outputInterface)
Connects a new Plug . |
void |
propBegin(java.lang.String name,
java.lang.String type,
java.lang.String descr,
boolean visual)
Starts definition of single property. |
void |
propBounds(java.lang.Object min,
java.lang.Object max)
Minimum and maximum allowed values (for comparable types only, non-mandatory). |
void |
propDefault(java.lang.Object value)
Default value (non-mandatory). |
void |
propEnd()
Finishes definition of the property. |
void |
propEnum(java.lang.String label,
java.lang.Object value,
java.lang.String descr)
Adds next enum label (for list-box GUI). |
void |
propManipulator(int manipulatorType)
Sets visual manipulator for GUI editing of the property. |
void |
propManipulator(java.lang.String className)
Sets visual manipulator for GUI editing of the property. |
void |
setRegStrings(java.lang.String _name,
java.lang.String _template,
java.lang.String _category,
java.lang.String _description)
Sets registration strings for the module. |
Field Detail |
---|
static final java.lang.String JAGRLIB
static final java.lang.String JAGRLIB2
static final java.lang.String IFACE
static final java.lang.String EMPTY
static final int ALL_PLUGS
Piece.setTemplateDynamic(cz.cuni.jagrlib.Template, int)
).
static final java.lang.String PL_INPUT
Plug
identifier.
static final java.lang.String PL_OUTPUT
Plug
identifier.
static final java.lang.String PL_WINDOW
Plug
identifier.
static final java.lang.String PL_BITMASK
Plug
identifier.
static final java.lang.String PL_ALPHAMASK
Plug
identifier.
static final java.lang.String PL_TRIGGER
Plug
identifier.
static final java.lang.String PL_PROPERTY
Plug
identifier.
static final java.lang.String PL_DIRECT
Plug
identifier.
static final java.lang.String PL_RASTER
Plug
identifier.
static final java.lang.String PL_IMAGE
Plug
identifier.
static final java.lang.String PL_PALETTE
Plug
identifier.
static final java.lang.String PL_COLORMAP
Plug
identifier.
static final java.lang.String PL_COMPARE
Plug
identifier.
static final java.lang.String PL_EDITOR
Plug
identifier.
static final java.lang.String PL_ORDER
Plug
identifier.
static final java.lang.String PL_DATA
Plug
identifier.
static final java.lang.String PL_FILTER
Plug
identifier.
static final java.lang.String PL_INTERSECTION
Plug
identifier.
static final java.lang.String PL_STREAM
Plug
identifier.
static final java.lang.String PL_FUNCTION
Plug
identifier.
static final java.lang.String PL_LIGHTSOURCE
Plug
identifier.
static final java.lang.String PL_TRANSFORM
Plug
identifier.
static final java.lang.String PL_QUANTIZER
Plug
identifier.
static final java.lang.String PL_CODEC
Plug
identifier.
static final java.lang.String PL_IMPORT
Plug
identifier.
static final java.lang.String PL_RENDER
Plug
identifier.
static final java.lang.String PL_PHOTON
Plug
identifier.
static final java.lang.String PL_CAUSTIC
Plug
identifier.
static final java.lang.String PL_SHADOW
Plug
identifier.
static final java.lang.String PL_VOLUME
Plug
identifier.
static final java.lang.String CAT_EMPTY
static final java.lang.String C_WORKER
static final java.lang.String C_1D
static final java.lang.String C_2D
static final java.lang.String C_3D
static final java.lang.String C_IO
static final java.lang.String C_DRAW
static final java.lang.String C_CLIP
static final java.lang.String C_DATA
static final java.lang.String C_LINE
static final java.lang.String C_FILL
static final java.lang.String C_CIRCLE
static final java.lang.String C_ELLIPSE
static final java.lang.String C_CURVE
static final java.lang.String C_POLYGON
static final java.lang.String C_TEXT
static final java.lang.String C_IMAGE
static final java.lang.String C_FILTER
static final java.lang.String C_SAMPLE
static final java.lang.String C_INTEGER
static final java.lang.String C_FLOAT
static final java.lang.String C_RASTER
static final java.lang.String C_VECTOR
static final java.lang.String C_BREP
static final java.lang.String C_SET
static final java.lang.String C_FUNCTION
static final java.lang.String C_TRANSFORM
static final java.lang.String C_PROJECTION
static final java.lang.String C_METRIC
static final java.lang.String C_RENDER
static final java.lang.String C_RADIOSITY
static final java.lang.String C_ALPHA
static final java.lang.String C_SCENE
static final java.lang.String C_SOLID
static final java.lang.String C_CAMERA
static final java.lang.String C_LIGHT
static final java.lang.String C_VIEWER
static final java.lang.String C_BINARY
static final java.lang.String C_COMPRESSION
static final java.lang.String C_EDITOR
static final java.lang.String TYPE_INTEGER
static final java.lang.String TYPE_LONG
static final java.lang.String TYPE_STRING
static final java.lang.String TYPE_DOUBLE
static final java.lang.String TYPE_FLOAT
static final java.lang.String TYPE_BOOLEAN
static final java.lang.String TYPE_OBJECT
static final int MANIPULATOR_DEFAULT
static final int MANIPULATOR_CUSTOM
static final int MANIPULATOR_COMBO
static final int MANIPULATOR_MULTILINE
Method Detail |
---|
void newPlug(java.lang.String key, boolean _mandatory, boolean _multi, boolean _cloneable, java.lang.String _inputInterface, java.lang.String _outputInterface)
Plug
. General routine.
key
- New plug's key._mandatory
- Is that plug mandatory (has to be connected)?_multi
- Can that plug be used in multi-channels?_cloneable
- Is that plug "cloneable" (=generic)? If yes,
ordinal numbers (starting from 0) will be appended to its name._inputInterface
- Fully qualified identifier of input (implemented)
interface
._outputInterface
- Fully qualified identifier of output (required)
interface
.void newInputPlug(java.lang.String key, java.lang.String _inputInterface)
Plug
. Common-use routine: creates optional,
non-cloneable, multi plug.
key
- New plug's key._inputInterface
- Fully qualified identifier of input (implemented)
interface
.void newOutputPlug(java.lang.String key, java.lang.String _outputInterface)
Plug
. Common-use routine: creates mandatory,
non-cloneable, multi plug.
key
- New plug's key._outputInterface
- Fully qualified identifier of output (required)
interface
.void newOptOutputPlug(java.lang.String key, java.lang.String _outputInterface)
Plug
. Common-use routine: creates optional,
non-cloneable, multi plug.
key
- New plug's key._outputInterface
- Fully qualified identifier of output (required)
interface
.void setRegStrings(java.lang.String _name, java.lang.String _template, java.lang.String _category, java.lang.String _description)
void propBegin(java.lang.String name, java.lang.String type, java.lang.String descr, boolean visual)
name
- String identifier (unique inside one module class).type
- Value type - full Java class identifier.descr
- Brief textual description (for human eyes only).visual
- Should be this property represented visually in GUI?propEnd()
void propDefault(java.lang.Object value)
void propBounds(java.lang.Object min, java.lang.Object max)
void propManipulator(int manipulatorType)
void propManipulator(java.lang.String className)
className
- Class name (either fully-qualified or local in package cz.cuni.jagrlib.gui
).void propEnum(java.lang.String label, java.lang.Object value, java.lang.String descr)
label
- Textual label to appear in the listbox.value
- Associated property value (real-value).descr
- Optional item's description (for human eyes only).void propEnd()
propBegin(java.lang.String, java.lang.String, java.lang.String, boolean)
must
be properly closed by propEnd()
.
propBegin(java.lang.String, java.lang.String, java.lang.String, boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |