cz.cuni.jagrlib.piece
Class SolidColorPen

java.lang.Object
  extended by cz.cuni.jagrlib.DefaultProperty
      extended by cz.cuni.jagrlib.Piece
          extended by cz.cuni.jagrlib.piece.SolidColorPen
All Implemented Interfaces:
Breakable, Pen, Property, SolidPen, Template

public class SolidColorPen
extends Piece
implements SolidPen

Solid-color pen.

Since:
0.03
See Also:
SolidColorPen.java

Field Summary
protected static java.lang.String CATEGORY
          Object category.
static RegPiece reg
          Static registration instance for this class.
protected static java.lang.String TEMPLATE_NAME
          Object template identifier.
protected  double width
          Current pen width.
 
Fields inherited from class cz.cuni.jagrlib.Piece
channels, info, pl, plugs, TEMPLATE_TYPE, userBreak
 
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
SolidColorPen()
           
 
Method Summary
 void init()
          Stroke (re-)initialization.
 int setAlphaOperation(int _op)
          Sets the alpha-channel operation (used in stroke() method).
 void setColor(double _color)
          Sets the current drawing color (for RasterGraphics.MODE_GRAY).
 void setColor(double[] _color)
          Sets the current drawing color (for RasterGraphics.MODE_RGB, RasterGraphics.MODE_RGBA or RasterGraphics.MODE_BAND).
 void setColor(int _color)
          Sets the current drawing color (for RasterGraphics.MODE_GRAY or RasterGraphics.MODE_COLORMAP).
 void setColor(int[] _color)
          Sets the current drawing color (for RasterGraphics.MODE_RGB, RasterGraphics.MODE_RGBA or RasterGraphics.MODE_BAND).
 int setOperation(int _op)
          Sets the binary set operation (used in stroke() method).
static int setTemplate(Template t, int ord)
          General-purpose registration routine.
 ValueTransferFunction setTransferFunction(ValueTransferFunction _transfer)
          Sets the value-transfer function (used in stroke() method).
 double setWidth(double _width)
          Sets the Pen's width.
 int setWidth(int _width)
          Sets the Pen's width.
 void stroke()
          Render the stroke.
 
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, get, intProperty, intProperty, intProperty, longProperty, longProperty, longProperty, set, 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, get, set
 

Field Detail

width

protected double width
Current pen width.


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

SolidColorPen

public SolidColorPen()
Method Detail

init

public void init()
Stroke (re-)initialization.

Specified by:
init in interface Pen

setOperation

public int setOperation(int _op)
Sets the binary set operation (used in stroke() method).

Specified by:
setOperation in interface Pen
Parameters:
_op - Binary set operation (BinaryOperation.BIN_OP_* constant).
Returns:
The old binary set operation.
See Also:
RasterGraphics, Binary operations

setAlphaOperation

public int setAlphaOperation(int _op)
Sets the alpha-channel operation (used in stroke() method).

Specified by:
setAlphaOperation in interface Pen
Parameters:
_op - Alpha-channel operation (AlphaOperation.ALPHA_* constant).
Returns:
The old alpha-channel operation.
See Also:
Alpha-channel operations

setTransferFunction

public ValueTransferFunction setTransferFunction(ValueTransferFunction _transfer)
Sets the value-transfer function (used in stroke() method).

Specified by:
setTransferFunction in interface Pen
Parameters:
_transfer - New value-transfer function or null.
Returns:
The old Value-transfer function or null.
See Also:
RasterGraphics, Value-transfor function prototype

stroke

public void stroke()
Render the stroke. Destroys the current stroke.

Specified by:
stroke in interface Pen

setWidth

public int setWidth(int _width)
Sets the Pen's width.

Specified by:
setWidth in interface SolidPen
Parameters:
_width - The new pen's width.
Returns:
The old pen's width.

setWidth

public double setWidth(double _width)
Sets the Pen's width.

Specified by:
setWidth in interface SolidPen
Parameters:
_width - The new pen's width.
Returns:
The old pen's width.

setColor

public void setColor(int _color)
Sets the current drawing color (for RasterGraphics.MODE_GRAY or RasterGraphics.MODE_COLORMAP).

Specified by:
setColor in interface SolidPen
Parameters:
_color - Current drawing color.
See Also:
RasterGraphics

setColor

public void setColor(double _color)
Sets the current drawing color (for RasterGraphics.MODE_GRAY).

Specified by:
setColor in interface SolidPen
Parameters:
_color - Current drawing color (0.0 to 1.0).
See Also:
RasterGraphics

setColor

public void setColor(int[] _color)
Sets the current drawing color (for RasterGraphics.MODE_RGB, RasterGraphics.MODE_RGBA or RasterGraphics.MODE_BAND).

Specified by:
setColor in interface SolidPen
Parameters:
_color - Current drawing color.
See Also:
RasterGraphics

setColor

public void setColor(double[] _color)
Sets the current drawing color (for RasterGraphics.MODE_RGB, RasterGraphics.MODE_RGBA or RasterGraphics.MODE_BAND).

Specified by:
setColor in interface SolidPen
Parameters:
_color - Current drawing color (channel values between 0.0 and 1.0).
See Also:
RasterGraphics

setTemplate

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