cz.cuni.jagrlib
Interface Template

All Known Implementing Classes:
AdditiveNoise, AlphaGenerator, AlphaMatrix, AlphaWorker, AmbientLightSource, AnimationWorker, AnisotropicMicrofacet, AntCity, AntCityWorker, ArithmeticCodec, AudioFilter, AudioFilterWorker, AudioReplay, AWTWindow, BezierCurve, BezierRegular, BezierWorker, BlinnMicrofacet, BlueScreen, BrepSolid, BrepToImage, BufferedBitStream, Colormap332, Colormaps, ColorReduce, ColorReduceRound, ColorReduceWorker, CompressedFormatBW, CompressedFormatGray, CompressedFormatOrder, CompressedFormatPal, CompressedFormatRGB, CompressedFormatTransform, CompressionWorker, Cone, CookTorranceModel, CornellBox, CSG2BrepImpl, Cube, Cylinder, DataMatrix, DCT, DeadZoneQuantizer, DefaultBlockQuantizer, DefaultBrepFileFormat, DefaultDiscreteTransform, DefaultFileFormat, DefaultFunctionR2ToR2, DefaultGeometrySearch, DefaultGraphicsViewer, DefaultImageFunction, DefaultImageSynthesizer, DefaultInputListener, DefaultIntFunction, DefaultLightSource, DefaultRasterFileFormat, DefaultRasterGraphics, DefaultRealFunction, DefaultRender3D, DefaultRenderer, DefaultSolid, DefaultValueTransferFunction, Deformations, DepthSort, DirectionalLightSource, DirectLightMapVisualizer, DrawAxes, DrawAxesGL, EffectBlur, EffectPixelize, Ellipse, EllipseWorker, FaceRenderFlat, FeatureDeformation, Features, FeatureWarpingWorker, Filter1DNotch, FinalGathering, FloodFillPoint, FloodFillWorker, FractalCircles, FractalCompressionQtree, FresnelConductor, FresnelDielectric, FunctionSamples, GIFFileFormat, GLBrepRender, GlobalIlluminationWorker, GLWindow, GLWorker, GraphR2ToR, GridRenderWorker, HDRFileFormat, HDRImage, HDRMap, HuffmanCodec, CheckerTexture, ImageCompare, ImageCompositionWorker, ImageCompressionWorker, ImageCompute, ImageConvert, ImageCrop, ImageFilterWorker, ImageKDTree, ImagePredictor, ImageTransition, ImageTransition.CutoffTransition, ImageTransition.LinearTransition, ImageTransition.RampField, ImageTransition.RandomField, ImageTransition.SigmaTransition, InteractiveProjection, IntervalArray, JavaBitStream, JavaText, JFIFFileFormat, JitteringSynthesizer, JPEGQuantizer, LambertianModel, LineAntialias, LineAntialiasSimple, LineAntiWorker, LinearQuantizer, LineBresenham, LineClipAntiWorker, LineClipping, LineClipWorker, LineWorker, LineWorkerStar, Lissajous, LZWCodec, MeshCompressionRLE, MonteCarloFF, MouseFrame, OBJFileFormat, OrderedDither, OrderSerpentine, OrderSFC, OrenNayarModel, OverwriteClassificator, PathTracing, PFMFileFormat, PhongModel, PhotonMap, PhotonTracing, Piece, Plane, PNGFileFormat, PolygonClip, PolygonClipWorker, PolygonFill, PolygonFillAnti, PolygonFillAntiWorker, PolygonFillWorker, PolylineAntialias, PolylineAntiWorker, ProjectionWorker, Radiosity, RadiosityEquations, RadiosityHierarch, RankFilter, RasterImage, RasterImagePreview, RayCasting, RayCastingNew, RayTracing, RayTracingNew, RegPiece, Render3DWorker, RenderPainter, RenderWireframe, Revolution, SampleColormap, SampleRasterSearch, SampleRenderWorker, Search2DWorker, SFCDither, SimpleGLGraphics, SimpleNoise, SimpleSLEDataStore, SimpleSynthesizer, SLEHierarchical, SLEProgressive, SLERelaxation, SolidColorBrush, SolidColorPen, SolidSpecimen, SpecularReflection, SpecularTransmission, Sphere, SpotTexture, StaticAreaLightSource, StaticCamera, StaticCSGScene, StaticPointLightSource, StaticSphericalLightSource, StaticSpotLightSource, StraightRoulette, SuperShootGather, Test3DScene, TestGamma, TestImageFunctions, TestImageLaser, TextureFunctions, TextWorker, TriangleWarpingWorker, TriMeshDeformation, TriMeshEditor, UniformGrid, VEFDS, WarpEngine, WarpingSpecimen, WarpingWorker, WAVFileFormatMapped, XTransitionList, ZigZagCodec, ZLIBCodec

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.

Since:
0.23
See Also:
Template.java

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

JAGRLIB

static final java.lang.String JAGRLIB
Base JaGrLib package.

See Also:
Constant Field Values

JAGRLIB2

static final java.lang.String JAGRLIB2
Base JaGrLib package with trailing dot.

See Also:
Constant Field Values

IFACE

static final java.lang.String IFACE
Interface prefix = "cz.cuni.jagrlib.iface.".

See Also:
Constant Field Values

EMPTY

static final java.lang.String EMPTY
Generic string initializer.

See Also:
Constant Field Values

ALL_PLUGS

static final int ALL_PLUGS
Connect all plugs (for Piece.setTemplateDynamic(cz.cuni.jagrlib.Template, int)).

See Also:
Constant Field Values

PL_INPUT

static final java.lang.String PL_INPUT
Generic input Plug identifier.

See Also:
Constant Field Values

PL_OUTPUT

static final java.lang.String PL_OUTPUT
Generic output Plug identifier.

See Also:
Constant Field Values

PL_WINDOW

static final java.lang.String PL_WINDOW
Window Plug identifier.

See Also:
Constant Field Values

PL_BITMASK

static final java.lang.String PL_BITMASK
Bit-mask Plug identifier.

See Also:
Constant Field Values

PL_ALPHAMASK

static final java.lang.String PL_ALPHAMASK
Alpha-mask Plug identifier.

See Also:
Constant Field Values

PL_TRIGGER

static final java.lang.String PL_TRIGGER
Trigger Plug identifier.

See Also:
Constant Field Values

PL_PROPERTY

static final java.lang.String PL_PROPERTY
Property Plug identifier.

See Also:
Constant Field Values

PL_DIRECT

static final java.lang.String PL_DIRECT
Direct Plug identifier.

See Also:
Constant Field Values

PL_RASTER

static final java.lang.String PL_RASTER
Raster image Plug identifier.

See Also:
Constant Field Values

PL_IMAGE

static final java.lang.String PL_IMAGE
Raster image Plug identifier.

See Also:
Constant Field Values

PL_PALETTE

static final java.lang.String PL_PALETTE
Palette Plug identifier.

See Also:
Constant Field Values

PL_COLORMAP

static final java.lang.String PL_COLORMAP
Colormap Plug identifier.

See Also:
Constant Field Values

PL_COMPARE

static final java.lang.String PL_COMPARE
Compare Plug identifier.

See Also:
Constant Field Values

PL_EDITOR

static final java.lang.String PL_EDITOR
Editor Plug identifier.

See Also:
Constant Field Values

PL_ORDER

static final java.lang.String PL_ORDER
Order Plug identifier.

See Also:
Constant Field Values

PL_DATA

static final java.lang.String PL_DATA
Data Plug identifier.

See Also:
Constant Field Values

PL_FILTER

static final java.lang.String PL_FILTER
Filter Plug identifier.

See Also:
Constant Field Values

PL_INTERSECTION

static final java.lang.String PL_INTERSECTION
Intersectable Plug identifier.

See Also:
Constant Field Values

PL_STREAM

static final java.lang.String PL_STREAM
[Bit-]stream Plug identifier.

See Also:
Constant Field Values

PL_FUNCTION

static final java.lang.String PL_FUNCTION
Function Plug identifier.

See Also:
Constant Field Values

PL_LIGHTSOURCE

static final java.lang.String PL_LIGHTSOURCE
Light-source Plug identifier.

See Also:
Constant Field Values

PL_TRANSFORM

static final java.lang.String PL_TRANSFORM
Transform Plug identifier.

See Also:
Constant Field Values

PL_QUANTIZER

static final java.lang.String PL_QUANTIZER
Quantizer Plug identifier.

See Also:
Constant Field Values

PL_CODEC

static final java.lang.String PL_CODEC
Codec Plug identifier.

See Also:
Constant Field Values

PL_IMPORT

static final java.lang.String PL_IMPORT
Import Plug identifier.

See Also:
Constant Field Values

PL_RENDER

static final java.lang.String PL_RENDER
Render Plug identifier.

See Also:
Constant Field Values

PL_PHOTON

static final java.lang.String PL_PHOTON
Photon map Plug identifier.

See Also:
Constant Field Values

PL_CAUSTIC

static final java.lang.String PL_CAUSTIC
Caustic map Plug identifier.

See Also:
Constant Field Values

PL_SHADOW

static final java.lang.String PL_SHADOW
Shadow map Plug identifier.

See Also:
Constant Field Values

PL_VOLUME

static final java.lang.String PL_VOLUME
Volume map Plug identifier.

See Also:
Constant Field Values

CAT_EMPTY

static final java.lang.String CAT_EMPTY
Undefined category name.

See Also:
Constant Field Values

C_WORKER

static final java.lang.String C_WORKER
category string: worker

See Also:
Constant Field Values

C_1D

static final java.lang.String C_1D
category string: 1D

See Also:
Constant Field Values

C_2D

static final java.lang.String C_2D
category string: 2D

See Also:
Constant Field Values

C_3D

static final java.lang.String C_3D
category string: 3D

See Also:
Constant Field Values

C_IO

static final java.lang.String C_IO
category string: io

See Also:
Constant Field Values

C_DRAW

static final java.lang.String C_DRAW
category string: draw

See Also:
Constant Field Values

C_CLIP

static final java.lang.String C_CLIP
category string: clip

See Also:
Constant Field Values

C_DATA

static final java.lang.String C_DATA
category string: data

See Also:
Constant Field Values

C_LINE

static final java.lang.String C_LINE
category string: line

See Also:
Constant Field Values

C_FILL

static final java.lang.String C_FILL
category string: fill

See Also:
Constant Field Values

C_CIRCLE

static final java.lang.String C_CIRCLE
category string: circle

See Also:
Constant Field Values

C_ELLIPSE

static final java.lang.String C_ELLIPSE
category string: ellipse

See Also:
Constant Field Values

C_CURVE

static final java.lang.String C_CURVE
category string: line

See Also:
Constant Field Values

C_POLYGON

static final java.lang.String C_POLYGON
category string: polygon

See Also:
Constant Field Values

C_TEXT

static final java.lang.String C_TEXT
category string: text

See Also:
Constant Field Values

C_IMAGE

static final java.lang.String C_IMAGE
category string: image

See Also:
Constant Field Values

C_FILTER

static final java.lang.String C_FILTER
category string: filter

See Also:
Constant Field Values

C_SAMPLE

static final java.lang.String C_SAMPLE
category string: sample

See Also:
Constant Field Values

C_INTEGER

static final java.lang.String C_INTEGER
category string: integer

See Also:
Constant Field Values

C_FLOAT

static final java.lang.String C_FLOAT
category string: float

See Also:
Constant Field Values

C_RASTER

static final java.lang.String C_RASTER
category string: raster

See Also:
Constant Field Values

C_VECTOR

static final java.lang.String C_VECTOR
category string: vector

See Also:
Constant Field Values

C_BREP

static final java.lang.String C_BREP
category string: brep

See Also:
Constant Field Values

C_SET

static final java.lang.String C_SET
category string: set

See Also:
Constant Field Values

C_FUNCTION

static final java.lang.String C_FUNCTION
category string: function

See Also:
Constant Field Values

C_TRANSFORM

static final java.lang.String C_TRANSFORM
category string: transform

See Also:
Constant Field Values

C_PROJECTION

static final java.lang.String C_PROJECTION
category string: projection

See Also:
Constant Field Values

C_METRIC

static final java.lang.String C_METRIC
category string: metric

See Also:
Constant Field Values

C_RENDER

static final java.lang.String C_RENDER
category string: render

See Also:
Constant Field Values

C_RADIOSITY

static final java.lang.String C_RADIOSITY
category string: radiosity

See Also:
Constant Field Values

C_ALPHA

static final java.lang.String C_ALPHA
category string: alpha

See Also:
Constant Field Values

C_SCENE

static final java.lang.String C_SCENE
category string: scene

See Also:
Constant Field Values

C_SOLID

static final java.lang.String C_SOLID
category string: solid

See Also:
Constant Field Values

C_CAMERA

static final java.lang.String C_CAMERA
category string: camera

See Also:
Constant Field Values

C_LIGHT

static final java.lang.String C_LIGHT
category string: light

See Also:
Constant Field Values

C_VIEWER

static final java.lang.String C_VIEWER
category string: viewer

See Also:
Constant Field Values

C_BINARY

static final java.lang.String C_BINARY
category string: binary

See Also:
Constant Field Values

C_COMPRESSION

static final java.lang.String C_COMPRESSION
category string: compression

See Also:
Constant Field Values

C_EDITOR

static final java.lang.String C_EDITOR
category string: editor

See Also:
Constant Field Values

TYPE_INTEGER

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

TYPE_LONG

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

TYPE_STRING

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

TYPE_DOUBLE

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

TYPE_FLOAT

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

TYPE_BOOLEAN

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

TYPE_OBJECT

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

MANIPULATOR_DEFAULT

static final int MANIPULATOR_DEFAULT
Default manipulator (single edit line, checkbox, ..).

See Also:
Constant Field Values

MANIPULATOR_CUSTOM

static final int MANIPULATOR_CUSTOM
Custom manipulator specified by its class name.

See Also:
Constant Field Values

MANIPULATOR_COMBO

static final int MANIPULATOR_COMBO
List-box manipulator (for integer values only).

See Also:
Constant Field Values

MANIPULATOR_MULTILINE

static final int MANIPULATOR_MULTILINE
Multi-line text area (for strings only).

See Also:
Constant Field Values
Method Detail

newPlug

void newPlug(java.lang.String key,
             boolean _mandatory,
             boolean _multi,
             boolean _cloneable,
             java.lang.String _inputInterface,
             java.lang.String _outputInterface)
Connects a new Plug. General routine.

Parameters:
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.

newInputPlug

void newInputPlug(java.lang.String key,
                  java.lang.String _inputInterface)
Connects a new input Plug. Common-use routine: creates optional, non-cloneable, multi plug.

Parameters:
key - New plug's key.
_inputInterface - Fully qualified identifier of input (implemented) interface.

newOutputPlug

void newOutputPlug(java.lang.String key,
                   java.lang.String _outputInterface)
Connects a new output Plug. Common-use routine: creates mandatory, non-cloneable, multi plug.

Parameters:
key - New plug's key.
_outputInterface - Fully qualified identifier of output (required) interface.

newOptOutputPlug

void newOptOutputPlug(java.lang.String key,
                      java.lang.String _outputInterface)
Connects a new optional output Plug. Common-use routine: creates optional, non-cloneable, multi plug.

Parameters:
key - New plug's key.
_outputInterface - Fully qualified identifier of output (required) interface.

setRegStrings

void setRegStrings(java.lang.String _name,
                   java.lang.String _template,
                   java.lang.String _category,
                   java.lang.String _description)
Sets registration strings for the module.


propBegin

void propBegin(java.lang.String name,
               java.lang.String type,
               java.lang.String descr,
               boolean visual)
Starts definition of single property.

Parameters:
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?
See Also:
propEnd()

propDefault

void propDefault(java.lang.Object value)
Default value (non-mandatory).


propBounds

void propBounds(java.lang.Object min,
                java.lang.Object max)
Minimum and maximum allowed values (for comparable types only, non-mandatory).


propManipulator

void propManipulator(int manipulatorType)
Sets visual manipulator for GUI editing of the property. For predefined manipulators.


propManipulator

void propManipulator(java.lang.String className)
Sets visual manipulator for GUI editing of the property. For user-defined manipulators.

Parameters:
className - Class name (either fully-qualified or local in package cz.cuni.jagrlib.gui).

propEnum

void propEnum(java.lang.String label,
              java.lang.Object value,
              java.lang.String descr)
Adds next enum label (for list-box GUI).

Parameters:
label - Textual label to appear in the listbox.
value - Associated property value (real-value).
descr - Optional item's description (for human eyes only).

propEnd

void propEnd()
Finishes definition of the property. Every property-definition segment started by propBegin(java.lang.String, java.lang.String, java.lang.String, boolean) must be properly closed by propEnd().

See Also:
propBegin(java.lang.String, java.lang.String, java.lang.String, boolean)